Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document wait_for_ready mechanism in Python's glossary

Browse Source
pull/22738/head
Lidi Zheng 5 years ago
parent edbc21e890
commit c1df38f2b9
4 changed files with 30 additions and 16 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      doc/python/sphinx/glossary.rst
  2. 20
      src/python/grpcio/grpc/__init__.py
  3. 8
      src/python/grpcio/grpc/experimental/aio/_base_channel.py
  4. 4
      src/python/grpcio/grpc/experimental/aio/_interceptor.py

14
doc/python/sphinx/glossary.rst
Unescape View File

@ -27,3 +27,17 @@ Glossary
the returned object doesn't have restrictions (i.e. ``None`` allowed). The the returned object doesn't have restrictions (i.e. ``None`` allowed). The
deserializer is invoked with inbound message bytes on both the server side deserializer is invoked with inbound message bytes on both the server side
and the client-side. and the client-side.
wait_for_ready
If an RPC is issued but the channel is in TRANSIENT_FAILURE or SHUTDOWN
states, the RPC is unable to be transmitted promptly. By default, gRPC
implementations SHOULD fail such RPCs immediately. This is known as "fail
fast," but the usage of the term is historical. RPCs SHOULD NOT fail as a
result of the channel being in other states (CONNECTING, READY, or IDLE).
gRPC implementations MAY provide a per-RPC option to not fail RPCs as a
result of the channel being in TRANSIENT_FAILURE state. Instead, the
implementation queues the RPCs until the channel is READY. This is known as
"wait for ready." The RPCs SHOULD still fail before READY if there are
unrelated reasons, such as the channel is SHUTDOWN or the RPC's deadline is
reached.

20
src/python/grpcio/grpc/__init__.py
Unescape View File

@ -414,8 +414,8 @@ class ClientCallDetails(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to metadata: Optional :term:`metadata` to be transmitted to
the service-side of the RPC. the service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: This is an EXPERIMENTAL argument. An optional flag t wait_for_ready: This is an EXPERIMENTAL argument. An optional
enable wait for ready mechanism. flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
""" """
@ -690,7 +690,7 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -723,7 +723,7 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -756,7 +756,7 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -792,7 +792,7 @@ class UnaryStreamMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -828,7 +828,7 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -862,7 +862,7 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -895,7 +895,7 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -931,7 +931,7 @@ class StreamStreamMultiCallable(six.with_metaclass(abc.ABCMeta)):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.

8
src/python/grpcio/grpc/experimental/aio/_base_channel.py
Unescape View File

@ -49,7 +49,7 @@ class UnaryUnaryMultiCallable(abc.ABC):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -87,7 +87,7 @@ class UnaryStreamMultiCallable(abc.ABC):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -125,7 +125,7 @@ class StreamUnaryMultiCallable(abc.ABC):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.
@ -163,7 +163,7 @@ class StreamStreamMultiCallable(abc.ABC):
credentials: An optional CallCredentials for the RPC. Only valid for credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel. secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable wait for ready mechanism flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g. compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option. grpc.compression.Gzip. This is an EXPERIMENTAL option.

4
src/python/grpcio/grpc/experimental/aio/_interceptor.py
Unescape View File

@ -73,8 +73,8 @@ class ClientCallDetails(
metadata: Optional metadata to be transmitted to the service-side of metadata: Optional metadata to be transmitted to the service-side of
the RPC. the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: This is an EXPERIMENTAL argument. An optional flag to wait_for_ready: This is an EXPERIMENTAL argument. An optional
enable wait for ready mechanism. flag to enable :term:`wait_for_ready` mechanism.
""" """
method: str method: str

Write Preview
Loading…
Cancel
Save