diff options
Diffstat (limited to 'src/python/grpcio/grpc/beta/implementations.py')
| -rw-r--r-- | src/python/grpcio/grpc/beta/implementations.py | 173 |
1 files changed, 89 insertions, 84 deletions
diff --git a/src/python/grpcio/grpc/beta/implementations.py b/src/python/grpcio/grpc/beta/implementations.py index ab25fd5eec..7093852278 100644 --- a/src/python/grpcio/grpc/beta/implementations.py +++ b/src/python/grpcio/grpc/beta/implementations.py @@ -26,7 +26,6 @@ # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - """Entry points into the Beta API of gRPC Python.""" # threading is referenced from specification in this module. @@ -43,7 +42,6 @@ from grpc.beta import interfaces from grpc.framework.common import cardinality # pylint: disable=unused-import from grpc.framework.interfaces.face import face # pylint: disable=unused-import - ChannelCredentials = grpc.ChannelCredentials ssl_channel_credentials = grpc.ssl_channel_credentials CallCredentials = grpc.CallCredentials @@ -51,7 +49,7 @@ metadata_call_credentials = grpc.metadata_call_credentials def google_call_credentials(credentials): - """Construct CallCredentials from GoogleCredentials. + """Construct CallCredentials from GoogleCredentials. Args: credentials: A GoogleCredentials object from the oauth2client library. @@ -59,7 +57,8 @@ def google_call_credentials(credentials): Returns: A CallCredentials object for use in a GRPCCallOptions object. """ - return metadata_call_credentials(_auth.GoogleCallCredentials(credentials)) + return metadata_call_credentials(_auth.GoogleCallCredentials(credentials)) + access_token_call_credentials = grpc.access_token_call_credentials composite_call_credentials = grpc.composite_call_credentials @@ -67,18 +66,18 @@ composite_channel_credentials = grpc.composite_channel_credentials class Channel(object): - """A channel to a remote host through which RPCs may be conducted. + """A channel to a remote host through which RPCs may be conducted. Only the "subscribe" and "unsubscribe" methods are supported for application use. This class' instance constructor and all other attributes are unsupported. """ - def __init__(self, channel): - self._channel = channel + def __init__(self, channel): + self._channel = channel - def subscribe(self, callback, try_to_connect=None): - """Subscribes to this Channel's connectivity. + def subscribe(self, callback, try_to_connect=None): + """Subscribes to this Channel's connectivity. Args: callback: A callable to be invoked and passed an @@ -90,20 +89,20 @@ class Channel(object): attempt to connect if it is not already connected and ready to conduct RPCs. """ - self._channel.subscribe(callback, try_to_connect=try_to_connect) + self._channel.subscribe(callback, try_to_connect=try_to_connect) - def unsubscribe(self, callback): - """Unsubscribes a callback from this Channel's connectivity. + def unsubscribe(self, callback): + """Unsubscribes a callback from this Channel's connectivity. Args: callback: A callable previously registered with this Channel from having been passed to its "subscribe" method. """ - self._channel.unsubscribe(callback) + self._channel.unsubscribe(callback) def insecure_channel(host, port): - """Creates an insecure Channel to a remote host. + """Creates an insecure Channel to a remote host. Args: host: The name of the remote host to which to connect. @@ -113,13 +112,13 @@ def insecure_channel(host, port): Returns: A Channel to the remote host through which RPCs may be conducted. """ - channel = grpc.insecure_channel( - host if port is None else '%s:%d' % (host, port)) - return Channel(channel) + channel = grpc.insecure_channel(host + if port is None else '%s:%d' % (host, port)) + return Channel(channel) def secure_channel(host, port, channel_credentials): - """Creates a secure Channel to a remote host. + """Creates a secure Channel to a remote host. Args: host: The name of the remote host to which to connect. @@ -130,37 +129,39 @@ def secure_channel(host, port, channel_credentials): Returns: A secure Channel to the remote host through which RPCs may be conducted. """ - channel = grpc.secure_channel( - host if port is None else '%s:%d' % (host, port), channel_credentials) - return Channel(channel) + channel = grpc.secure_channel(host if port is None else + '%s:%d' % (host, port), channel_credentials) + return Channel(channel) class StubOptions(object): - """A value encapsulating the various options for creation of a Stub. + """A value encapsulating the various options for creation of a Stub. This class and its instances have no supported interface - it exists to define the type of its instances and its instances exist to be passed to other functions. """ - def __init__( - self, host, request_serializers, response_deserializers, - metadata_transformer, thread_pool, thread_pool_size): - self.host = host - self.request_serializers = request_serializers - self.response_deserializers = response_deserializers - self.metadata_transformer = metadata_transformer - self.thread_pool = thread_pool - self.thread_pool_size = thread_pool_size + def __init__(self, host, request_serializers, response_deserializers, + metadata_transformer, thread_pool, thread_pool_size): + self.host = host + self.request_serializers = request_serializers + self.response_deserializers = response_deserializers + self.metadata_transformer = metadata_transformer + self.thread_pool = thread_pool + self.thread_pool_size = thread_pool_size -_EMPTY_STUB_OPTIONS = StubOptions( - None, None, None, None, None, None) +_EMPTY_STUB_OPTIONS = StubOptions(None, None, None, None, None, None) -def stub_options( - host=None, request_serializers=None, response_deserializers=None, - metadata_transformer=None, thread_pool=None, thread_pool_size=None): - """Creates a StubOptions value to be passed at stub creation. + +def stub_options(host=None, + request_serializers=None, + response_deserializers=None, + metadata_transformer=None, + thread_pool=None, + thread_pool_size=None): + """Creates a StubOptions value to be passed at stub creation. All parameters are optional and should always be passed by keyword. @@ -180,13 +181,12 @@ def stub_options( Returns: A StubOptions value created from the passed parameters. """ - return StubOptions( - host, request_serializers, response_deserializers, - metadata_transformer, thread_pool, thread_pool_size) + return StubOptions(host, request_serializers, response_deserializers, + metadata_transformer, thread_pool, thread_pool_size) def generic_stub(channel, options=None): - """Creates a face.GenericStub on which RPCs can be made. + """Creates a face.GenericStub on which RPCs can be made. Args: channel: A Channel for use by the created stub. @@ -195,16 +195,17 @@ def generic_stub(channel, options=None): Returns: A face.GenericStub on which RPCs can be made. """ - effective_options = _EMPTY_STUB_OPTIONS if options is None else options - return _client_adaptations.generic_stub( - channel._channel, # pylint: disable=protected-access - effective_options.host, effective_options.metadata_transformer, - effective_options.request_serializers, - effective_options.response_deserializers) + effective_options = _EMPTY_STUB_OPTIONS if options is None else options + return _client_adaptations.generic_stub( + channel._channel, # pylint: disable=protected-access + effective_options.host, + effective_options.metadata_transformer, + effective_options.request_serializers, + effective_options.response_deserializers) def dynamic_stub(channel, service, cardinalities, options=None): - """Creates a face.DynamicStub with which RPCs can be invoked. + """Creates a face.DynamicStub with which RPCs can be invoked. Args: channel: A Channel for the returned face.DynamicStub to use. @@ -217,13 +218,15 @@ def dynamic_stub(channel, service, cardinalities, options=None): Returns: A face.DynamicStub with which RPCs can be invoked. """ - effective_options = StubOptions() if options is None else options - return _client_adaptations.dynamic_stub( - channel._channel, # pylint: disable=protected-access - service, cardinalities, effective_options.host, - effective_options.metadata_transformer, - effective_options.request_serializers, - effective_options.response_deserializers) + effective_options = StubOptions() if options is None else options + return _client_adaptations.dynamic_stub( + channel._channel, # pylint: disable=protected-access + service, + cardinalities, + effective_options.host, + effective_options.metadata_transformer, + effective_options.request_serializers, + effective_options.response_deserializers) ServerCredentials = grpc.ServerCredentials @@ -231,34 +234,36 @@ ssl_server_credentials = grpc.ssl_server_credentials class ServerOptions(object): - """A value encapsulating the various options for creation of a Server. + """A value encapsulating the various options for creation of a Server. This class and its instances have no supported interface - it exists to define the type of its instances and its instances exist to be passed to other functions. """ - def __init__( - self, multi_method_implementation, request_deserializers, - response_serializers, thread_pool, thread_pool_size, default_timeout, - maximum_timeout): - self.multi_method_implementation = multi_method_implementation - self.request_deserializers = request_deserializers - self.response_serializers = response_serializers - self.thread_pool = thread_pool - self.thread_pool_size = thread_pool_size - self.default_timeout = default_timeout - self.maximum_timeout = maximum_timeout + def __init__(self, multi_method_implementation, request_deserializers, + response_serializers, thread_pool, thread_pool_size, + default_timeout, maximum_timeout): + self.multi_method_implementation = multi_method_implementation + self.request_deserializers = request_deserializers + self.response_serializers = response_serializers + self.thread_pool = thread_pool + self.thread_pool_size = thread_pool_size + self.default_timeout = default_timeout + self.maximum_timeout = maximum_timeout + -_EMPTY_SERVER_OPTIONS = ServerOptions( - None, None, None, None, None, None, None) +_EMPTY_SERVER_OPTIONS = ServerOptions(None, None, None, None, None, None, None) -def server_options( - multi_method_implementation=None, request_deserializers=None, - response_serializers=None, thread_pool=None, thread_pool_size=None, - default_timeout=None, maximum_timeout=None): - """Creates a ServerOptions value to be passed at server creation. +def server_options(multi_method_implementation=None, + request_deserializers=None, + response_serializers=None, + thread_pool=None, + thread_pool_size=None, + default_timeout=None, + maximum_timeout=None): + """Creates a ServerOptions value to be passed at server creation. All parameters are optional and should always be passed by keyword. @@ -282,13 +287,13 @@ def server_options( Returns: A StubOptions value created from the passed parameters. """ - return ServerOptions( - multi_method_implementation, request_deserializers, response_serializers, - thread_pool, thread_pool_size, default_timeout, maximum_timeout) + return ServerOptions(multi_method_implementation, request_deserializers, + response_serializers, thread_pool, thread_pool_size, + default_timeout, maximum_timeout) def server(service_implementations, options=None): - """Creates an interfaces.Server with which RPCs can be serviced. + """Creates an interfaces.Server with which RPCs can be serviced. Args: service_implementations: A dictionary from service name-method name pair to @@ -299,9 +304,9 @@ def server(service_implementations, options=None): Returns: An interfaces.Server with which RPCs can be serviced. """ - effective_options = _EMPTY_SERVER_OPTIONS if options is None else options - return _server_adaptations.server( - service_implementations, effective_options.multi_method_implementation, - effective_options.request_deserializers, - effective_options.response_serializers, effective_options.thread_pool, - effective_options.thread_pool_size) + effective_options = _EMPTY_SERVER_OPTIONS if options is None else options + return _server_adaptations.server( + service_implementations, effective_options.multi_method_implementation, + effective_options.request_deserializers, + effective_options.response_serializers, effective_options.thread_pool, + effective_options.thread_pool_size) |