Python 2.7 has reached end of support
and will be deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their deprecation date
. We recommend that
you migrate to the latest supported version of Python
.
Descriptor Module Functions (Experimental)
Stay organized with collections
Save and categorize content based on your preferences.
The protorpc.remote
package provides the following functions:
- is_error_status
( status
)
-
Determines whether the RPC status is an error.
Arguments
- status
- Initialized RpcStatus message to check for errors.
- check_rpc_status
( status
)
-
Converts an error status to a raised exception.
Arguments
- status
- Initialized RpcStatus message to check for errors.
Raises an RpcError
if the state of status
is an error.
- method
( request_type
= message_types.VoidMessage
, response_type
= message_types.VoidMessage
)
-
Decorates a method for making the method remote.
Arguments
- request_type
= message_types.VoidMessage
- Message type of the expected request.
- response_type
= message_types.VoidMessage
- Message type of the expected response.
Returns a decorated remote method. The remote method will include a remote
attribute with the following properties:
- method
- The original, undecorated method
- request_type
- Message type of the expected request.
- response_type
- Message type of the expected response.
Raises an TypeError
if the request_type
or response_type
parameters are not proper subclasses of messages.Message.
- get_remote_method
( method
)
-
For remote methods, returns a remote method information object, else None.
Arguments
- method
- The method to get.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003e\u003ccode\u003eis_error_status(status)\u003c/code\u003e checks if an \u003ccode\u003eRpcStatus\u003c/code\u003e message indicates an error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003echeck_rpc_status(status)\u003c/code\u003e raises an \u003ccode\u003eRpcError\u003c/code\u003e exception if the provided \u003ccode\u003eRpcStatus\u003c/code\u003e message indicates an error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003emethod()\u003c/code\u003e decorates a method to make it remote, defining its request and response message types.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eget_remote_method(method)\u003c/code\u003e retrieves remote method information for a given method or returns \u003ccode\u003eNone\u003c/code\u003e if it's not a remote method.\u003c/p\u003e\n"]]],[],null,["# Descriptor Module Functions (Experimental)\n\nThe `protorpc.remote` package provides the following functions:\n\nis_error_status(status)\n\n: Determines whether the RPC status is an error.\n\n **Arguments**\n\n status\n : Initialized RpcStatus message to check for errors.\n\ncheck_rpc_status(status)\n\n: Converts an error status to a raised exception.\n\n **Arguments**\n\n status\n : Initialized RpcStatus message to check for errors.\n\n Raises an [RpcError](/appengine/docs/legacy/standard/python/tools/protorpc/remote/exceptions#RpcError) if the state of `status` is an error.\n\nmethod(request_type=message_types.VoidMessage, response_type=message_types.VoidMessage)\n\n: Decorates a method for making the method remote.\n\n **Arguments**\n\n request_type=message_types.VoidMessage\n : Message type of the expected request.\n\n response_type=message_types.VoidMessage\n : Message type of the expected response.\n\n Returns a decorated remote method. The remote method will include a `remote` attribute with the following properties:\n\n method\n : The original, undecorated method\n\n request_type\n : Message type of the expected request.\n\n response_type\n : Message type of the expected response.\n\n Raises an [TypeError](http://docs.python.org/library/exceptions.html#exceptions.TypeError) if the `request_type` or `response_type` parameters are not proper subclasses of messages.Message.\n\nget_remote_method(method)\n\n: For remote methods, returns a remote method information object, else None.\n\n **Arguments**\n\n method\n : The method to get."]]
