浏览代码

Add documentation for compression enums

Lidi Zheng 6 年之前
父节点
当前提交
11e60b8f30
共有 1 个文件被更改,包括 6 次插入0 次删除
  1. 6 0
      src/python/grpcio/grpc/__init__.py

+ 6 - 0
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
     context._finalize_state()  # pylint: disable=protected-access
 
 
 
 
+@enum.unique
 class Compression(enum.IntEnum):
 class Compression(enum.IntEnum):
     """Indicates the compression method to be used for an RPC.
     """Indicates the compression method to be used for an RPC.
 
 
        This enumeration is part of an EXPERIMENTAL API.
        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
     NoCompression = _compression.NoCompression
     Deflate = _compression.Deflate
     Deflate = _compression.Deflate