aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/python/grpcio_status
diff options
context:
space:
mode:
authorGravatar Lidi Zheng <lidiz@google.com>2018-12-14 10:10:57 -0800
committerGravatar Lidi Zheng <lidiz@google.com>2018-12-14 10:28:48 -0800
commit40b8ca97a1d89153711e0d965cd25de1099862f1 (patch)
treef3ee2bfc32069bc91e6e0fb636277bf7854b8f72 /src/python/grpcio_status
parentb9cb2459ea4b2956547abf5fb516b553d85f1ae2 (diff)
Update docstring to make it more clear
* Mark API as experimental * Rephrase the raise condition * Add more detail to the returned object
Diffstat (limited to 'src/python/grpcio_status')
-rw-r--r--src/python/grpcio_status/grpc_status/rpc_status.py10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/python/grpcio_status/grpc_status/rpc_status.py b/src/python/grpcio_status/grpc_status/rpc_status.py
index 36c8eba37d..e23a20968e 100644
--- a/src/python/grpcio_status/grpc_status/rpc_status.py
+++ b/src/python/grpcio_status/grpc_status/rpc_status.py
@@ -45,6 +45,8 @@ def _code_to_grpc_status_code(code):
def from_call(call):
"""Returns a google.rpc.status.Status message corresponding to a given grpc.Call.
+ This is an EXPERIMENTAL API.
+
Args:
call: A grpc.Call instance.
@@ -52,8 +54,8 @@ def from_call(call):
A google.rpc.status.Status message representing the status of the RPC.
Raises:
- ValueError: If the status code, status message is inconsistent with the rich status
- inside of the google.rpc.status.Status.
+ ValueError: If the gRPC call's code or details are inconsistent with the
+ status code and message inside of the google.rpc.status.Status.
"""
for key, value in call.trailing_metadata():
if key == _GRPC_DETAILS_METADATA_KEY:
@@ -74,12 +76,14 @@ def from_call(call):
def to_status(status):
"""Convert a google.rpc.status.Status message to grpc.Status.
+ This is an EXPERIMENTAL API.
+
Args:
status: a google.rpc.status.Status message representing the non-OK status
to terminate the RPC with and communicate it to the client.
Returns:
- A grpc.Status instance.
+ A grpc.Status instance representing the input google.rpc.status.Status message.
"""
return _Status(
code=_code_to_grpc_status_code(status.code),