Merge pull request #19596 from lidizheng/compression-doc

Add documentation for compression enums
5 years ago · 6114760312
parent 4a2f2dd1f1 11e60b8f30
commit 6114760312
1 changed files with 6 additions and 0 deletions
--- a/src/python/grpcio/grpc/init.py
+++ b/src/python/grpcio/grpc/init.py
@ -1856,10 +1856,16 @@ def _create_servicer_context(rpc_event, state, request_deserializer):
    context._finalize_state()  # pylint: disable=protected-access


+@enum.unique
 class Compression(enum.IntEnum):
    """Indicates the compression method to be used for an RPC.

       This enumeration is part of an EXPERIMENTAL API.
+
+       Attributes:
+        NoCompression: Do not use compression algorithm.
+        Deflate: Use "Deflate" compression algorithm.
+        Gzip: Use "Gzip" compression algorithm.
    """
    NoCompression = _compression.NoCompression
    Deflate = _compression.Deflate