grpcreflect-py 0.1.0__py3-none-any.whl

grpcreflect/__init__.py

@@ -0,0 +1,14 @@
+"""An idiomatic Python implementation of gRPC Server Reflection."""
+
+from grpcreflect.client import Client, ClientStream
+from grpcreflect.reflector import ReflectionSchema, Reflector, ReflectorOptions
+from grpcreflect.server import mount_reflection_handlers
+
+__all__ = [
+    "Client",
+    "ClientStream",
+    "ReflectionSchema",
+    "Reflector",
+    "ReflectorOptions",
+    "mount_reflection_handlers",
+]

grpcreflect/_gen/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

grpcreflect/_gen/grpc/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

grpcreflect/_gen/grpc/reflection/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

grpcreflect/_gen/grpc/reflection/v1/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

grpcreflect/_gen/grpc/reflection/v1/reflection_connect.py

@@ -0,0 +1,174 @@
+# Generated from grpc/reflection/v1/reflection.proto. DO NOT EDIT.
+# Generated by protoc-gen-connectrpc-py v0.12.1 with parameter "".
+# ruff: noqa: PGH004
+# ruff: noqa
+# fmt: off
+
+from __future__ import annotations
+
+from typing import Protocol, TYPE_CHECKING
+
+from connectrpc.client import ConnectClient, ConnectClientSync
+from connectrpc.code import Code
+from connectrpc.errors import ConnectError
+from connectrpc.method import IdempotencyLevel, MethodInfo
+from connectrpc.server import ConnectASGIApplication, ConnectWSGIApplication, DEFAULT_READ_MAX_BYTES, Endpoint, EndpointSync
+from protobuf import DescService
+
+from . import reflection_pb
+from .reflection_pb import ServerReflectionRequest, ServerReflectionResponse
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncGenerator, AsyncIterator, Iterable, Iterator, Mapping
+
+    from connectrpc.codec import Codec
+    from connectrpc.compression import Compression
+    from connectrpc.interceptor import Interceptor, InterceptorSync
+    from connectrpc.request import Headers, RequestContext
+
+
+class ServerReflection(Protocol):
+    def server_reflection_info(self, request: AsyncIterator[ServerReflectionRequest], ctx: RequestContext[ServerReflectionRequest, ServerReflectionResponse], /) -> AsyncIterator[ServerReflectionResponse]:
+        """
+        The reflection service is structured as a bidirectional stream, ensuring
+        all related requests go to a single server.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    @classmethod
+    def desc(cls) -> DescService:
+        """Returns the descriptor for this service."""
+        return next(s for s in reflection_pb.desc().services if s.type_name == 'grpc.reflection.v1.ServerReflection')
+
+class ServerReflectionASGIApplication(ConnectASGIApplication[ServerReflection]):
+    def __init__(
+        self,
+        service: ServerReflection | AsyncGenerator[ServerReflection],
+        *,
+        interceptors: Iterable[Interceptor] = (),
+        read_max_bytes: int | None = DEFAULT_READ_MAX_BYTES,
+        compressions: Iterable[Compression] | None = None,
+        codecs: Iterable[Codec] | None = None,
+    ) -> None:
+        super().__init__(
+            service=service,
+            endpoints=lambda svc: {
+                "/grpc.reflection.v1.ServerReflection/ServerReflectionInfo": Endpoint.bidi_stream(
+                    method=MethodInfo(
+                        name="ServerReflectionInfo",
+                        service_name="grpc.reflection.v1.ServerReflection",
+                        input=ServerReflectionRequest,
+                        output=ServerReflectionResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=svc.server_reflection_info,
+                ),
+            },
+            interceptors=interceptors,
+            read_max_bytes=read_max_bytes,
+            compressions=compressions,
+            codecs=codecs,
+        )
+
+    @property
+    def path(self) -> str:
+        """Returns the URL path to mount the application to when serving multiple applications."""
+        return "/grpc.reflection.v1.ServerReflection"
+
+
+class ServerReflectionClient(ConnectClient):
+    def server_reflection_info(
+        self,
+        request: AsyncIterator[ServerReflectionRequest],
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> AsyncIterator[ServerReflectionResponse]:
+        """
+        The reflection service is structured as a bidirectional stream, ensuring
+        all related requests go to a single server.
+        """
+        return self.execute_bidi_stream(
+            request=request,
+            method=MethodInfo(
+                name="ServerReflectionInfo",
+                service_name="grpc.reflection.v1.ServerReflection",
+                input=ServerReflectionRequest,
+                output=ServerReflectionResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )
+
+class ServerReflectionSync(Protocol):
+    def server_reflection_info(self, request: Iterator[ServerReflectionRequest], ctx: RequestContext[ServerReflectionRequest, ServerReflectionResponse], /) -> Iterator[ServerReflectionResponse]:
+        """
+        The reflection service is structured as a bidirectional stream, ensuring
+        all related requests go to a single server.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    @classmethod
+    def desc(cls) -> DescService:
+        """Returns the descriptor for this service."""
+        return next(s for s in reflection_pb.desc().services if s.type_name == 'grpc.reflection.v1.ServerReflection')
+
+class ServerReflectionWSGIApplication(ConnectWSGIApplication):
+    def __init__(
+        self,
+        service: ServerReflectionSync,
+        interceptors: Iterable[InterceptorSync] = (),
+        read_max_bytes: int | None = DEFAULT_READ_MAX_BYTES,
+        compressions: Iterable[Compression] | None = None,
+        codecs: Iterable[Codec] | None = None,
+    ) -> None:
+        super().__init__(
+            endpoints={
+                "/grpc.reflection.v1.ServerReflection/ServerReflectionInfo": EndpointSync.bidi_stream(
+                    method=MethodInfo(
+                        name="ServerReflectionInfo",
+                        service_name="grpc.reflection.v1.ServerReflection",
+                        input=ServerReflectionRequest,
+                        output=ServerReflectionResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=service.server_reflection_info,
+                ),
+            },
+            interceptors=interceptors,
+            read_max_bytes=read_max_bytes,
+            compressions=compressions,
+            codecs=codecs,
+        )
+
+    @property
+    def path(self) -> str:
+        """Returns the URL path to mount the application to when serving multiple applications."""
+        return "/grpc.reflection.v1.ServerReflection"
+
+
+class ServerReflectionClientSync(ConnectClientSync):
+    def server_reflection_info(
+        self,
+        request: Iterator[ServerReflectionRequest],
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> Iterator[ServerReflectionResponse]:
+        """
+        The reflection service is structured as a bidirectional stream, ensuring
+        all related requests go to a single server.
+        """
+        return self.execute_bidi_stream(
+            request=request,
+            method=MethodInfo(
+                name="ServerReflectionInfo",
+                service_name="grpc.reflection.v1.ServerReflection",
+                input=ServerReflectionRequest,
+                output=ServerReflectionResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )

grpcreflect/_gen/grpc/reflection/v1/reflection_pb.py

@@ -0,0 +1,342 @@
+# Generated from grpc/reflection/v1/reflection.proto. DO NOT EDIT.
+# Generated by protoc-gen-py v0.5.0 with parameter "".
+# ruff: noqa: PGH004
+# ruff: noqa
+# fmt: off
+
+from __future__ import annotations
+
+from typing import Literal, TYPE_CHECKING, TypeAlias
+
+from protobuf import Message
+from protobuf._codegen import file_desc
+
+if TYPE_CHECKING:
+    from protobuf import DescFile, Oneof
+
+
+_ServerReflectionRequestFields: TypeAlias = Literal["host", "file_by_filename", "file_containing_symbol", "file_containing_extension", "all_extension_numbers_of_type", "list_services"]
+
+class ServerReflectionRequest(Message[_ServerReflectionRequestFields]):
+    """
+    The message sent by the client when calling ServerReflectionInfo method.
+
+    ```proto
+    message grpc.reflection.v1.ServerReflectionRequest
+    ```
+
+    Attributes:
+        host:
+            ```proto
+            string host = 1;
+            ```
+        message_request:
+            To use reflection service, the client should set one of the following
+            fields in message_request. The server distinguishes requests by their
+            defined field and then handles them using corresponding methods.
+
+            ```proto
+            oneof message_request
+            ```
+    """
+
+    __slots__ = ("host", "message_request")
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            host: str = "",
+            message_request: Oneof[Literal["file_by_filename"], str] | Oneof[Literal["file_containing_symbol"], str] | Oneof[Literal["file_containing_extension"], ExtensionRequest] | Oneof[Literal["all_extension_numbers_of_type"], str] | Oneof[Literal["list_services"], str] | None = None,
+        ) -> None:
+            pass
+
+        host: str
+        message_request: Oneof[Literal["file_by_filename"], str] | Oneof[Literal["file_containing_symbol"], str] | Oneof[Literal["file_containing_extension"], ExtensionRequest] | Oneof[Literal["all_extension_numbers_of_type"], str] | Oneof[Literal["list_services"], str] | None
+
+_ExtensionRequestFields: TypeAlias = Literal["containing_type", "extension_number"]
+
+class ExtensionRequest(Message[_ExtensionRequestFields]):
+    """
+    The type name and extension number sent by the client when requesting
+    file_containing_extension.
+
+    ```proto
+    message grpc.reflection.v1.ExtensionRequest
+    ```
+
+    Attributes:
+        containing_type:
+            Fully-qualified type name. The format should be <package>.<type>
+
+            ```proto
+            string containing_type = 1;
+            ```
+        extension_number:
+            ```proto
+            int32 extension_number = 2;
+            ```
+    """
+
+    __slots__ = ("containing_type", "extension_number")
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            containing_type: str = "",
+            extension_number: int = 0,
+        ) -> None:
+            pass
+
+        containing_type: str
+        extension_number: int
+
+_ServerReflectionResponseFields: TypeAlias = Literal["valid_host", "original_request", "file_descriptor_response", "all_extension_numbers_response", "list_services_response", "error_response"]
+
+class ServerReflectionResponse(Message[_ServerReflectionResponseFields]):
+    """
+    The message sent by the server to answer ServerReflectionInfo method.
+
+    ```proto
+    message grpc.reflection.v1.ServerReflectionResponse
+    ```
+
+    Attributes:
+        valid_host:
+            ```proto
+            string valid_host = 1;
+            ```
+        original_request:
+            ```proto
+            optional grpc.reflection.v1.ServerReflectionRequest original_request = 2;
+            ```
+        message_response:
+            The server sets one of the following fields according to the message_request
+            in the request.
+
+            ```proto
+            oneof message_response
+            ```
+    """
+
+    __slots__ = ("valid_host", "original_request", "message_response")
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            valid_host: str = "",
+            original_request: ServerReflectionRequest | None = None,
+            message_response: Oneof[Literal["file_descriptor_response"], FileDescriptorResponse] | Oneof[Literal["all_extension_numbers_response"], ExtensionNumberResponse] | Oneof[Literal["list_services_response"], ListServiceResponse] | Oneof[Literal["error_response"], ErrorResponse] | None = None,
+        ) -> None:
+            pass
+
+        valid_host: str
+        original_request: ServerReflectionRequest | None
+        message_response: Oneof[Literal["file_descriptor_response"], FileDescriptorResponse] | Oneof[Literal["all_extension_numbers_response"], ExtensionNumberResponse] | Oneof[Literal["list_services_response"], ListServiceResponse] | Oneof[Literal["error_response"], ErrorResponse] | None
+
+_FileDescriptorResponseFields: TypeAlias = Literal["file_descriptor_proto"]
+
+class FileDescriptorResponse(Message[_FileDescriptorResponseFields]):
+    """
+    Serialized FileDescriptorProto messages sent by the server answering
+    a file_by_filename, file_containing_symbol, or file_containing_extension
+    request.
+
+    ```proto
+    message grpc.reflection.v1.FileDescriptorResponse
+    ```
+
+    Attributes:
+        file_descriptor_proto:
+            Serialized FileDescriptorProto messages. We avoid taking a dependency on
+            descriptor.proto, which uses proto2 only features, by making them opaque
+            bytes instead.
+
+            ```proto
+            repeated bytes file_descriptor_proto = 1;
+            ```
+    """
+
+    __slots__ = ("file_descriptor_proto",)
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            file_descriptor_proto: list[bytes] | None = None,
+        ) -> None:
+            pass
+
+        file_descriptor_proto: list[bytes]
+
+_ExtensionNumberResponseFields: TypeAlias = Literal["base_type_name", "extension_number"]
+
+class ExtensionNumberResponse(Message[_ExtensionNumberResponseFields]):
+    """
+    A list of extension numbers sent by the server answering
+    all_extension_numbers_of_type request.
+
+    ```proto
+    message grpc.reflection.v1.ExtensionNumberResponse
+    ```
+
+    Attributes:
+        base_type_name:
+            Full name of the base type, including the package name. The format
+            is <package>.<type>
+
+            ```proto
+            string base_type_name = 1;
+            ```
+        extension_number:
+            ```proto
+            repeated int32 extension_number = 2 [packed = true];
+            ```
+    """
+
+    __slots__ = ("base_type_name", "extension_number")
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            base_type_name: str = "",
+            extension_number: list[int] | None = None,
+        ) -> None:
+            pass
+
+        base_type_name: str
+        extension_number: list[int]
+
+_ListServiceResponseFields: TypeAlias = Literal["service"]
+
+class ListServiceResponse(Message[_ListServiceResponseFields]):
+    """
+    A list of ServiceResponse sent by the server answering list_services request.
+
+    ```proto
+    message grpc.reflection.v1.ListServiceResponse
+    ```
+
+    Attributes:
+        service:
+            The information of each service may be expanded in the future, so we use
+            ServiceResponse message to encapsulate it.
+
+            ```proto
+            repeated grpc.reflection.v1.ServiceResponse service = 1;
+            ```
+    """
+
+    __slots__ = ("service",)
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            service: list[ServiceResponse] | None = None,
+        ) -> None:
+            pass
+
+        service: list[ServiceResponse]
+
+_ServiceResponseFields: TypeAlias = Literal["name"]
+
+class ServiceResponse(Message[_ServiceResponseFields]):
+    """
+    The information of a single service used by ListServiceResponse to answer
+    list_services request.
+
+    ```proto
+    message grpc.reflection.v1.ServiceResponse
+    ```
+
+    Attributes:
+        name:
+            Full name of a registered service, including its package name. The format
+            is <package>.<service>
+
+            ```proto
+            string name = 1;
+            ```
+    """
+
+    __slots__ = ("name",)
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            name: str = "",
+        ) -> None:
+            pass
+
+        name: str
+
+_ErrorResponseFields: TypeAlias = Literal["error_code", "error_message"]
+
+class ErrorResponse(Message[_ErrorResponseFields]):
+    """
+    The error code and error message sent by the server when an error occurs.
+
+    ```proto
+    message grpc.reflection.v1.ErrorResponse
+    ```
+
+    Attributes:
+        error_code:
+            This field uses the error codes defined in grpc::StatusCode.
+
+            ```proto
+            int32 error_code = 1;
+            ```
+        error_message:
+            ```proto
+            string error_message = 2;
+            ```
+    """
+
+    __slots__ = ("error_code", "error_message")
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            error_code: int = 0,
+            error_message: str = "",
+        ) -> None:
+            pass
+
+        error_code: int
+        error_message: str
+
+
+_DESC = file_desc(
+    b'\n#grpc/reflection/v1/reflection.proto\x12\x12grpc.reflection.v1"\xf3\x02\n\x17ServerReflectionRequest\x12\x12\n\x04host\x18\x01 \x01(\tR\x04host\x12*\n\x10file_by_filename\x18\x03 \x01(\tH\x00R\x0efileByFilename\x126\n\x16file_containing_symbol\x18\x04 \x01(\tH\x00R\x14fileContainingSymbol\x12b\n\x19file_containing_extension\x18\x05 \x01(\x0b2$.grpc.reflection.v1.ExtensionRequestH\x00R\x17fileContainingExtension\x12B\n\x1dall_extension_numbers_of_type\x18\x06 \x01(\tH\x00R\x19allExtensionNumbersOfType\x12%\n\rlist_services\x18\x07 \x01(\tH\x00R\x0clistServicesB\x11\n\x0fmessage_request"f\n\x10ExtensionRequest\x12\'\n\x0fcontaining_type\x18\x01 \x01(\tR\x0econtainingType\x12)\n\x10extension_number\x18\x02 \x01(\x05R\x0fextensionNumber"\xae\x04\n\x18ServerReflectionResponse\x12\x1d\n\nvalid_host\x18\x01 \x01(\tR\tvalidHost\x12V\n\x10original_request\x18\x02 \x01(\x0b2+.grpc.reflection.v1.ServerReflectionRequestR\x0foriginalRequest\x12f\n\x18file_descriptor_response\x18\x04 \x01(\x0b2*.grpc.reflection.v1.FileDescriptorResponseH\x00R\x16fileDescriptorResponse\x12r\n\x1eall_extension_numbers_response\x18\x05 \x01(\x0b2+.grpc.reflection.v1.ExtensionNumberResponseH\x00R\x1ballExtensionNumbersResponse\x12_\n\x16list_services_response\x18\x06 \x01(\x0b2\'.grpc.reflection.v1.ListServiceResponseH\x00R\x14listServicesResponse\x12J\n\x0eerror_response\x18\x07 \x01(\x0b2!.grpc.reflection.v1.ErrorResponseH\x00R\rerrorResponseB\x12\n\x10message_response"L\n\x16FileDescriptorResponse\x122\n\x15file_descriptor_proto\x18\x01 \x03(\x0cR\x13fileDescriptorProto"j\n\x17ExtensionNumberResponse\x12$\n\x0ebase_type_name\x18\x01 \x01(\tR\x0cbaseTypeName\x12)\n\x10extension_number\x18\x02 \x03(\x05R\x0fextensionNumber"T\n\x13ListServiceResponse\x12=\n\x07service\x18\x01 \x03(\x0b2#.grpc.reflection.v1.ServiceResponseR\x07service"%\n\x0fServiceResponse\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"S\n\rErrorResponse\x12\x1d\n\nerror_code\x18\x01 \x01(\x05R\terrorCode\x12#\n\rerror_message\x18\x02 \x01(\tR\x0cerrorMessage2\x89\x01\n\x10ServerReflection\x12u\n\x14ServerReflectionInfo\x12+.grpc.reflection.v1.ServerReflectionRequest\x1a,.grpc.reflection.v1.ServerReflectionResponse(\x010\x01B\xc9\x01\n\x16com.grpc.reflection.v1B\x0fReflectionProtoP\x01Z4google.golang.org/grpc/reflection/grpc_reflection_v1\xa2\x02\x03GRX\xaa\x02\x12Grpc.Reflection.V1\xca\x02\x12Grpc\\Reflection\\V1\xe2\x02\x1eGrpc\\Reflection\\V1\\GPBMetadata\xea\x02\x14Grpc::Reflection::V1b\x06proto3',
+    [],
+    {
+        "ServerReflectionRequest": ServerReflectionRequest,
+        "ExtensionRequest": ExtensionRequest,
+        "ServerReflectionResponse": ServerReflectionResponse,
+        "FileDescriptorResponse": FileDescriptorResponse,
+        "ExtensionNumberResponse": ExtensionNumberResponse,
+        "ListServiceResponse": ListServiceResponse,
+        "ServiceResponse": ServiceResponse,
+        "ErrorResponse": ErrorResponse,
+    },
+)
+
+
+def desc() -> DescFile:
+    """Returns the descriptor for the file `grpc/reflection/v1/reflection.proto`."""
+    return _DESC

grpcreflect/_gen/grpc/reflection/v1alpha/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations