Python channel option documentation. (or at least example)

[ove...@gmail.com]

Hi,

I use gRPC actively, especially gRPC python.

I use several options to create channel.

such as like 

 grpc.insecure_channel(target="localhost:9999", 

                       options=[("grpc.lb_policy_name", "round_robin"),

                                .....])

But it is very hard to find which option is available and which value can be assigned on it.

I read several documents, which is even not sure up-to-date or correct one to use it.

such like

• https://github.com/grpc/grpc/tree/master/src/core/ext/filters/client_channel/lb_policy
• https://github.com/grpc/grpc/blob/master/doc/load-balancing.md
• https://github.com/grpc/grpc/blob/master/doc/service_config.md
• https://grpc.io/grpc/core/group__grpc__arg__keys.html#ga72c2b475e218ecfd36bb7d3551d0295b

Is anyone know kind of clear and one shot document for usage of channel option?

If it does not exist, anybody know any plan for documentation or enhance proposal?

I could involve in the documentation if some correct sources.

Thanks.

[Srini Polavarapu]

Hi,

Thanks for bringing this up. This is definitely an area where we need improvement. Our first order of priority is to update the reference guide with latest release and clean up beta APIs. We need to fix some broken scripts on our end. This is the tracking issue.

For channel args, the link you mentioned is good to know about various args. Python passes these args to the Core transparently. It'll be useful to add links to such docs in Python documentation. Feel free to submit PRs. Once the documentation is fixed, we can continue to improve the description of various APIs.

We would also like to add more examples, especially for common channel and call options like LB, timeout, keepalive etc. Feel free to submit PRs for these too.

[Youngchan Kim]

Just for information.

Here is a common channel and call options example of Python gRPC client.

https://github.com/grpc/grpc/blob/master/examples/python/helloworld/greeter_client_with_options.py

Thank you for reviewing this Srini.