Welcome to gRPC Python’s documentation!

Version: 1.70.1 Release: 1.70.1

API Reference

Contents:

• gRPC
  • Module Contents
    • Version
    • Create Client
      • insecure_channel()
      • secure_channel()
      • intercept_channel()
    • Create Client Credentials
      • ssl_channel_credentials()
      • metadata_call_credentials()
      • access_token_call_credentials()
      • composite_call_credentials()
      • composite_channel_credentials()
      • local_channel_credentials()
      • compute_engine_channel_credentials()
    • Create Server
      • server()
    • Create Server Credentials
      • ssl_server_credentials()
      • ssl_server_certificate_configuration()
      • dynamic_ssl_server_credentials()
      • local_server_credentials()
    • Local Connection Type
      • LocalConnectionType
        • LocalConnectionType.UDS
        • LocalConnectionType.LOCAL_TCP
    • RPC Method Handlers
      • unary_unary_rpc_method_handler()
      • unary_stream_rpc_method_handler()
      • stream_unary_rpc_method_handler()
      • stream_stream_rpc_method_handler()
      • method_handlers_generic_handler()
    • Channel Ready Future
      • channel_ready_future()
    • Channel Connectivity
      • ChannelConnectivity
        • ChannelConnectivity.IDLE
        • ChannelConnectivity.CONNECTING
        • ChannelConnectivity.READY
        • ChannelConnectivity.TRANSIENT_FAILURE
        • ChannelConnectivity.SHUTDOWN
    • gRPC Status Code
      • StatusCode
        • StatusCode.OK
        • StatusCode.CANCELLED
        • StatusCode.UNKNOWN
        • StatusCode.INVALID_ARGUMENT
        • StatusCode.DEADLINE_EXCEEDED
        • StatusCode.NOT_FOUND
        • StatusCode.ALREADY_EXISTS
        • StatusCode.PERMISSION_DENIED
        • StatusCode.UNAUTHENTICATED
        • StatusCode.RESOURCE_EXHAUSTED
        • StatusCode.FAILED_PRECONDITION
        • StatusCode.ABORTED
        • StatusCode.UNIMPLEMENTED
        • StatusCode.INTERNAL
        • StatusCode.UNAVAILABLE
        • StatusCode.DATA_LOSS
    • Channel Object
      • Channel
        • Channel.__enter__()
        • Channel.__exit__()
        • Channel.close()
        • Channel.stream_stream()
        • Channel.stream_unary()
        • Channel.subscribe()
        • Channel.unary_stream()
        • Channel.unary_unary()
        • Channel.unsubscribe()
    • Server Object
      • Server
        • Server.add_generic_rpc_handlers()
        • Server.add_insecure_port()
        • Server.add_registered_method_handlers()
        • Server.add_secure_port()
        • Server.start()
        • Server.stop()
        • Server.wait_for_termination()
    • Authentication & Authorization Objects
      • ChannelCredentials
      • CallCredentials
      • AuthMetadataContext
        • AuthMetadataContext.service_url
        • AuthMetadataContext.method_name
      • AuthMetadataPluginCallback
        • AuthMetadataPluginCallback.__call__()
      • AuthMetadataPlugin
        • AuthMetadataPlugin.__call__()
      • ServerCredentials
      • ServerCertificateConfiguration
    • gRPC Exceptions
      • RpcError
    • RPC Context
      • RpcContext
        • RpcContext.add_callback()
        • RpcContext.cancel()
        • RpcContext.is_active()
        • RpcContext.time_remaining()
    • Client-Side Context
      • Call
        • Call.code()
        • Call.details()
        • Call.initial_metadata()
        • Call.trailing_metadata()
    • Client-Side Interceptor
      • ClientCallDetails
        • ClientCallDetails.method
        • ClientCallDetails.timeout
        • ClientCallDetails.metadata
        • ClientCallDetails.credentials
        • ClientCallDetails.wait_for_ready
        • ClientCallDetails.compression
      • UnaryUnaryClientInterceptor
        • UnaryUnaryClientInterceptor.intercept_unary_unary()
      • UnaryStreamClientInterceptor
        • UnaryStreamClientInterceptor.intercept_unary_stream()
      • StreamUnaryClientInterceptor
        • StreamUnaryClientInterceptor.intercept_stream_unary()
      • StreamStreamClientInterceptor
        • StreamStreamClientInterceptor.intercept_stream_stream()
    • Service-Side Context
      • ServicerContext
        • ServicerContext.abort()
        • ServicerContext.abort_with_status()
        • ServicerContext.auth_context()
        • ServicerContext.code()
        • ServicerContext.details()
        • ServicerContext.disable_next_message_compression()
        • ServicerContext.invocation_metadata()
        • ServicerContext.peer()
        • ServicerContext.peer_identities()
        • ServicerContext.peer_identity_key()
        • ServicerContext.send_initial_metadata()
        • ServicerContext.set_code()
        • ServicerContext.set_compression()
        • ServicerContext.set_details()
        • ServicerContext.set_trailing_metadata()
        • ServicerContext.trailing_metadata()
    • Service-Side Handler
      • RpcMethodHandler
        • RpcMethodHandler.request_streaming
        • RpcMethodHandler.response_streaming
        • RpcMethodHandler.request_deserializer
        • RpcMethodHandler.response_serializer
        • RpcMethodHandler.unary_unary
        • RpcMethodHandler.unary_stream
        • RpcMethodHandler.stream_unary
        • RpcMethodHandler.stream_stream
      • HandlerCallDetails
        • HandlerCallDetails.method
        • HandlerCallDetails.invocation_metadata
      • GenericRpcHandler
        • GenericRpcHandler.service()
      • ServiceRpcHandler
        • ServiceRpcHandler.service_name()
    • Service-Side Interceptor
      • ServerInterceptor
        • ServerInterceptor.intercept_service()
    • Multi-Callable Interfaces
      • UnaryUnaryMultiCallable
        • UnaryUnaryMultiCallable.__call__()
        • UnaryUnaryMultiCallable.future()
        • UnaryUnaryMultiCallable.with_call()
      • UnaryStreamMultiCallable
        • UnaryStreamMultiCallable.__call__()
      • StreamUnaryMultiCallable
        • StreamUnaryMultiCallable.__call__()
        • StreamUnaryMultiCallable.future()
        • StreamUnaryMultiCallable.with_call()
      • StreamStreamMultiCallable
        • StreamStreamMultiCallable.__call__()
    • Future Interfaces
      • FutureTimeoutError
      • FutureCancelledError
      • Future
        • Future.add_done_callback()
        • Future.cancel()
        • Future.cancelled()
        • Future.done()
        • Future.exception()
        • Future.result()
        • Future.running()
        • Future.traceback()
    • Compression
      • Compression
        • Compression.NoCompression
        • Compression.Deflate
        • Compression.Gzip
    • Runtime Protobuf Parsing
      • protos()
      • services()
      • protos_and_services()
• gRPC AsyncIO API
  • Overview
  • Caveats
  • Blocking Code in AsyncIO
  • Module Contents
    • Create Channel
      • insecure_channel()
      • secure_channel()
    • Channel Object
      • Channel
        • Channel.__aenter__()
        • Channel.__aexit__()
        • Channel.channel_ready()
        • Channel.close()
        • Channel.get_state()
        • Channel.stream_stream()
        • Channel.stream_unary()
        • Channel.unary_stream()
        • Channel.unary_unary()
        • Channel.wait_for_state_change()
    • Create Server
      • server()
    • Server Object
      • Server
        • Server.add_generic_rpc_handlers()
        • Server.add_insecure_port()
        • Server.add_registered_method_handlers()
        • Server.add_secure_port()
        • Server.start()
        • Server.stop()
        • Server.wait_for_termination()
    • gRPC Exceptions
      • BaseError
      • UsageError
      • AbortError
      • InternalError
      • AioRpcError
        • AioRpcError.code()
        • AioRpcError.debug_error_string()
        • AioRpcError.details()
        • AioRpcError.initial_metadata()
        • AioRpcError.trailing_metadata()
    • gRPC Metadata
      • Metadata
        • Metadata.__delitem__()
        • Metadata.__getitem__()
        • Metadata.__len__()
        • Metadata.__setitem__()
        • Metadata.delete_all()
        • Metadata.get_all()
    • RPC Context
      • RpcContext
        • RpcContext.add_done_callback()
        • RpcContext.cancel()
        • RpcContext.cancelled()
        • RpcContext.done()
        • RpcContext.time_remaining()
    • Client-Side Context
      • Call
        • Call.code()
        • Call.details()
        • Call.initial_metadata()
        • Call.trailing_metadata()
        • Call.wait_for_connection()
      • UnaryUnaryCall
        • UnaryUnaryCall.__await__()
      • UnaryStreamCall
        • UnaryStreamCall.__aiter__()
        • UnaryStreamCall.read()
      • StreamUnaryCall
        • StreamUnaryCall.__await__()
        • StreamUnaryCall.done_writing()
        • StreamUnaryCall.write()
      • StreamStreamCall
        • StreamStreamCall.__aiter__()
        • StreamStreamCall.done_writing()
        • StreamStreamCall.read()
        • StreamStreamCall.write()
    • Server-Side Context
      • ServicerContext
        • ServicerContext.abort()
        • ServicerContext.add_done_callback()
        • ServicerContext.auth_context()
        • ServicerContext.cancelled()
        • ServicerContext.code()
        • ServicerContext.details()
        • ServicerContext.disable_next_message_compression()
        • ServicerContext.done()
        • ServicerContext.invocation_metadata()
        • ServicerContext.peer()
        • ServicerContext.peer_identities()
        • ServicerContext.peer_identity_key()
        • ServicerContext.read()
        • ServicerContext.send_initial_metadata()
        • ServicerContext.set_code()
        • ServicerContext.set_compression()
        • ServicerContext.set_details()
        • ServicerContext.set_trailing_metadata()
        • ServicerContext.time_remaining()
        • ServicerContext.trailing_metadata()
        • ServicerContext.write()
    • Client-Side Interceptor
      • ClientCallDetails
      • InterceptedUnaryUnaryCall
        • InterceptedUnaryUnaryCall.time_remaining()
      • ClientInterceptor
      • UnaryUnaryClientInterceptor
        • UnaryUnaryClientInterceptor.intercept_unary_unary()
      • UnaryStreamClientInterceptor
        • UnaryStreamClientInterceptor.intercept_unary_stream()
      • StreamUnaryClientInterceptor
        • StreamUnaryClientInterceptor.intercept_stream_unary()
      • StreamStreamClientInterceptor
        • StreamStreamClientInterceptor.intercept_stream_stream()
    • Server-Side Interceptor
      • ServerInterceptor
        • ServerInterceptor.intercept_service()
    • Multi-Callable Interfaces
      • UnaryUnaryMultiCallable
        • UnaryUnaryMultiCallable.__call__()
      • UnaryStreamMultiCallable
        • UnaryStreamMultiCallable.__call__()
      • StreamUnaryMultiCallable
        • StreamUnaryMultiCallable.__call__()
      • StreamStreamMultiCallable
        • StreamStreamMultiCallable.__call__()
• gRPC Admin
  • What is gRPC Admin?
  • Module Contents
    • add_admin_servicers()
• gRPC Channelz
  • What is gRPC Channelz?
  • Module Contents
    • ChannelzServicer
      • ChannelzServicer.GetChannel()
      • ChannelzServicer.GetServer()
      • ChannelzServicer.GetServerSockets()
      • ChannelzServicer.GetServers()
      • ChannelzServicer.GetSocket()
      • ChannelzServicer.GetSubchannel()
      • ChannelzServicer.GetTopChannels()
    • add_channelz_servicer()
• gRPC CSDS
  • What is gRPC CSDS?
  • Module Contents
    • ClientStatusDiscoveryServiceServicer
    • add_csds_servicer()
• gRPC Health Checking
  • Module Contents
    • HealthServicer
      • HealthServicer.Check()
      • HealthServicer.Watch()
      • HealthServicer.enter_graceful_shutdown()
      • HealthServicer.set()
• gRPC Reflection
  • What is gRPC reflection?
  • Example
  • Module Contents
    • Server-side
      • ReflectionServicer
        • ReflectionServicer.ServerReflectionInfo()
      • enable_server_reflection()
    • Client-side
      • ProtoReflectionDescriptorDatabase
        • ProtoReflectionDescriptorDatabase.get_services()
        • ProtoReflectionDescriptorDatabase.FindFileByName()
        • ProtoReflectionDescriptorDatabase.FindFileContainingSymbol()
        • ProtoReflectionDescriptorDatabase.FindAllExtensionNumbers()
        • ProtoReflectionDescriptorDatabase.FindFileContainingExtension()
• gRPC Status
  • Module Contents
    • from_call()
    • to_status()
• gRPC Testing
  • Module Contents
    • Channel
      • Channel.take_stream_stream()
      • Channel.take_stream_unary()
      • Channel.take_unary_stream()
      • Channel.take_unary_unary()
    • Server
      • Server.invoke_stream_stream()
      • Server.invoke_stream_unary()
      • Server.invoke_unary_stream()
      • Server.invoke_unary_unary()
    • StreamStreamChannelRpc
      • StreamStreamChannelRpc.cancelled()
      • StreamStreamChannelRpc.requests_closed()
      • StreamStreamChannelRpc.send_initial_metadata()
      • StreamStreamChannelRpc.send_response()
      • StreamStreamChannelRpc.take_request()
      • StreamStreamChannelRpc.terminate()
    • StreamStreamServerRpc
      • StreamStreamServerRpc.cancel()
      • StreamStreamServerRpc.initial_metadata()
      • StreamStreamServerRpc.requests_closed()
      • StreamStreamServerRpc.send_request()
      • StreamStreamServerRpc.take_response()
      • StreamStreamServerRpc.termination()
    • StreamUnaryChannelRpc
      • StreamUnaryChannelRpc.cancelled()
      • StreamUnaryChannelRpc.requests_closed()
      • StreamUnaryChannelRpc.send_initial_metadata()
      • StreamUnaryChannelRpc.take_request()
      • StreamUnaryChannelRpc.terminate()
    • StreamUnaryServerRpc
      • StreamUnaryServerRpc.cancel()
      • StreamUnaryServerRpc.initial_metadata()
      • StreamUnaryServerRpc.requests_closed()
      • StreamUnaryServerRpc.send_request()
      • StreamUnaryServerRpc.termination()
    • Time
      • Time.call_at()
      • Time.call_in()
      • Time.sleep_for()
      • Time.sleep_until()
      • Time.time()
    • UnaryStreamChannelRpc
      • UnaryStreamChannelRpc.cancelled()
      • UnaryStreamChannelRpc.send_initial_metadata()
      • UnaryStreamChannelRpc.send_response()
      • UnaryStreamChannelRpc.terminate()
    • UnaryStreamServerRpc
      • UnaryStreamServerRpc.cancel()
      • UnaryStreamServerRpc.initial_metadata()
      • UnaryStreamServerRpc.take_response()
      • UnaryStreamServerRpc.termination()
    • UnaryUnaryChannelRpc
      • UnaryUnaryChannelRpc.cancelled()
      • UnaryUnaryChannelRpc.send_initial_metadata()
      • UnaryUnaryChannelRpc.terminate()
    • UnaryUnaryServerRpc
      • UnaryUnaryServerRpc.cancel()
      • UnaryUnaryServerRpc.initial_metadata()
      • UnaryUnaryServerRpc.termination()
    • channel()
    • server_from_dictionary()
    • strict_fake_time()
    • strict_real_time()
• gRPC Python Observability
  • Module Contents
    • OpenTelemetryPlugin
      • OpenTelemetryPlugin.deregister_global()
      • OpenTelemetryPlugin.register_global()
• Glossary

Indices and tables

• Index

• Module Index

• Search Page