grpcreflect-py 0.1.0__tar.gz

grpcreflect_py-0.1.0/LICENSE

@@ -0,0 +1,219 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are solely limited to
+      and are identified as being limited to a portion of the work).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been made to Licensor. For the
+      purposes of this definition, "Contribution" shall mean any work of
+      authorship, including the original version of the Work and any
+      modifications or additions to that Work or Derivative Works thereof,
+      that is intentionally submitted to Licensor for inclusion in the Work
+      by the copyright owner or by an individual or Legal Entity authorized
+      to submit on behalf of the copyright owner. For the purposes of this
+      definition, "submitted" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing
+      lists, source code control systems, and issue tracking systems that
+      are managed by, or on behalf of, the Licensor for the purpose of
+      discussing and improving the Work, but excluding communication that
+      is conspicuously marked or otherwise designated in writing by the
+      copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been made to Licensor. For the
+      purposes of this definition, "Contribution" shall mean any work of
+      authorship, including the original version of the Work and any
+      modifications or additions to that Work or Derivative Works thereof,
+      that is intentionally submitted to Licensor for inclusion in the Work
+      by the copyright owner or by an individual or Legal Entity authorized
+      to submit on behalf of the copyright owner. For the purposes of this
+      definition, "submitted" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing
+      lists, source code control systems, and issue tracking systems that
+      are managed by, or on behalf of, the Licensor for the purpose of
+      discussing and improving the Work, but excluding communication that
+      is conspicuously marked or otherwise designated in writing by the
+      copyright owner as "Not a Contribution."
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, distribute, and prepare
+      Derivative Works of, publicly display, publicly perform, sublicense,
+      and distribute the Work and such Derivative Works in source or object
+      form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in source or object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, trademark, patent,
+          attribution and other notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. Unless agreed to otherwise,
+      no Contributor is required to provide support, warranties,
+      indemnities, or other obligations to You. However, if You elect to
+      provide support, warranties, indemnities, or other obligations to
+      one or more recipients of Covered Software, You may do so only on
+      Your own behalf, and not on behalf of any Contributor. You must make
+      it absolutely clear that any such warranty, support, indemnity, or
+      other obligation is offered by You alone, and You hereby agree to
+      indemnify every Contributor for any liability incurred by such
+      Contributor as a result of warranty, support, indemnity or other
+      obligation You offer.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DataKit, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

grpcreflect_py-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: grpcreflect-py
+Version: 0.1.0
+Summary: An idiomatic Python implementation of gRPC Server Reflection compatible with ConnectRPC
+Author: Jordan Fowler
+Author-email: Jordan Fowler <jordan@withdatakit.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: connectrpc>=0.12.1
+Requires-Dist: protobuf-py>=0.5.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# grpcreflect-py
+
+An idiomatic Python implementation of the [gRPC Server Reflection
+protocol][grpc-reflection] (`grpc.reflection.v1` and
+`grpc.reflection.v1alpha`), built on [`protobuf-py`][protobuf-py] and
+[`connectrpc`][connect-python]. Modeled on Buf's Go reference
+implementation, [`grpcreflect-go`][grpcreflect-go].
+
+Since the reflection services here are just `ConnectASGIApplication`s like
+any other, they work over whichever of `connectrpc`'s protocols your own
+services already speak -- Connect, gRPC, and gRPC-Web -- with no extra
+configuration.
+
+[grpc-reflection]: https://github.com/grpc/grpc/blob/master/doc/server-reflection.md
+[protobuf-py]: https://github.com/bufbuild/protobuf-py
+[connect-python]: https://github.com/connectrpc/connect-py
+[grpcreflect-go]: https://github.com/connectrpc/grpcreflect-go
+
+## Install
+
+```sh
+uv add grpcreflect-py
+```
+
+## Usage
+
+`mount_reflection_handlers()` takes the same `ConnectASGIApplication`
+instances you're already mounting for your own services, derives a registry
+from their descriptors, and returns them alongside ready-to-mount v1 and
+v1alpha reflection applications:
+
+```python
+from starlette.applications import Starlette
+from starlette.routing import Mount
+from grpcreflect.server import mount_reflection_handlers
+
+from example.greet import GreetServiceImpl
+from example.gen.greet.v1.greet_connect import GreetServiceASGIApplication
+
+app = Starlette(
+    routes=[
+        Mount(a.path, app=a)
+        for a in mount_reflection_handlers(
+            GreetServiceASGIApplication(GreetServiceImpl())
+        )
+    ]
+)
+```
+
+`ServerReflectionInfo` is a bidirectional streaming RPC, which requires an
+HTTP/2-capable ASGI server. As of this writing, [`pyvoy`][pyvoy] is the
+server most reliably passing the Connect conformance suite's HTTP/2 and
+bidi-streaming tests, so it's the recommended way to serve `app` above:
+
+```python
+import asyncio
+import pyvoy
+
+async def main() -> None:
+    server = pyvoy.PyvoyServer("myapp:app", port=8080)
+    await server.start()
+    await server.wait()
+
+asyncio.run(main())
+```
+
+You aren't required to use `pyvoy` -- any ASGI server with working HTTP/2
+and bidi-streaming support will do -- but not every ASGI server reliably
+supports both today.
+
+[pyvoy]: https://github.com/curioswitch/pyvoy
+
+## Client
+
+`Client` speaks gRPC Server Reflection against a server, preferring v1 and
+falling back to v1alpha automatically the first time it discovers v1 isn't
+implemented. `new_stream()` opens a `ClientStream`, which pins a sequence of
+calls to one open stream so they're all answered by a single, consistent
+view of the server's schema:
+
+```python
+import asyncio
+
+from grpcreflect.client import Client
+
+
+async def main() -> None:
+    async with Client("http://localhost:8080") as client, client.new_stream() as stream:
+        print(await stream.list_services())
+
+        for descriptor in await stream.file_containing_symbol("greet.v1.GreetService"):
+            print(descriptor.name)
+
+
+asyncio.run(main())
+```
+
+## Development
+
+```sh
+uv run -- buf generate   # regenerate src/grpcreflect/_gen from the upstream schema
+uv run pytest
+```

grpcreflect_py-0.1.0/README.md

@@ -0,0 +1,103 @@
+# grpcreflect-py
+
+An idiomatic Python implementation of the [gRPC Server Reflection
+protocol][grpc-reflection] (`grpc.reflection.v1` and
+`grpc.reflection.v1alpha`), built on [`protobuf-py`][protobuf-py] and
+[`connectrpc`][connect-python]. Modeled on Buf's Go reference
+implementation, [`grpcreflect-go`][grpcreflect-go].
+
+Since the reflection services here are just `ConnectASGIApplication`s like
+any other, they work over whichever of `connectrpc`'s protocols your own
+services already speak -- Connect, gRPC, and gRPC-Web -- with no extra
+configuration.
+
+[grpc-reflection]: https://github.com/grpc/grpc/blob/master/doc/server-reflection.md
+[protobuf-py]: https://github.com/bufbuild/protobuf-py
+[connect-python]: https://github.com/connectrpc/connect-py
+[grpcreflect-go]: https://github.com/connectrpc/grpcreflect-go
+
+## Install
+
+```sh
+uv add grpcreflect-py
+```
+
+## Usage
+
+`mount_reflection_handlers()` takes the same `ConnectASGIApplication`
+instances you're already mounting for your own services, derives a registry
+from their descriptors, and returns them alongside ready-to-mount v1 and
+v1alpha reflection applications:
+
+```python
+from starlette.applications import Starlette
+from starlette.routing import Mount
+from grpcreflect.server import mount_reflection_handlers
+
+from example.greet import GreetServiceImpl
+from example.gen.greet.v1.greet_connect import GreetServiceASGIApplication
+
+app = Starlette(
+    routes=[
+        Mount(a.path, app=a)
+        for a in mount_reflection_handlers(
+            GreetServiceASGIApplication(GreetServiceImpl())
+        )
+    ]
+)
+```
+
+`ServerReflectionInfo` is a bidirectional streaming RPC, which requires an
+HTTP/2-capable ASGI server. As of this writing, [`pyvoy`][pyvoy] is the
+server most reliably passing the Connect conformance suite's HTTP/2 and
+bidi-streaming tests, so it's the recommended way to serve `app` above:
+
+```python
+import asyncio
+import pyvoy
+
+async def main() -> None:
+    server = pyvoy.PyvoyServer("myapp:app", port=8080)
+    await server.start()
+    await server.wait()
+
+asyncio.run(main())
+```
+
+You aren't required to use `pyvoy` -- any ASGI server with working HTTP/2
+and bidi-streaming support will do -- but not every ASGI server reliably
+supports both today.
+
+[pyvoy]: https://github.com/curioswitch/pyvoy
+
+## Client
+
+`Client` speaks gRPC Server Reflection against a server, preferring v1 and
+falling back to v1alpha automatically the first time it discovers v1 isn't
+implemented. `new_stream()` opens a `ClientStream`, which pins a sequence of
+calls to one open stream so they're all answered by a single, consistent
+view of the server's schema:
+
+```python
+import asyncio
+
+from grpcreflect.client import Client
+
+
+async def main() -> None:
+    async with Client("http://localhost:8080") as client, client.new_stream() as stream:
+        print(await stream.list_services())
+
+        for descriptor in await stream.file_containing_symbol("greet.v1.GreetService"):
+            print(descriptor.name)
+
+
+asyncio.run(main())
+```
+
+## Development
+
+```sh
+uv run -- buf generate   # regenerate src/grpcreflect/_gen from the upstream schema
+uv run pytest
+```

grpcreflect_py-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "grpcreflect-py"
+version = "0.1.0"
+description = "An idiomatic Python implementation of gRPC Server Reflection compatible with ConnectRPC"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+dependencies = [
+    "connectrpc>=0.12.1",
+    "protobuf-py>=0.5.0",
+]
+
+[[project.authors]]
+name = "Jordan Fowler"
+email = "jordan@withdatakit.com"
+
+[build-system]
+requires = ["uv_build>=0.12.17,<0.13.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "buf-bin>=1.73.0",
+    "protoc-gen-connectrpc>=0.12.1",
+    "protoc-gen-py>=0.5.0",
+    "pytest>=9.1.1",
+    "pytest-asyncio>=1.4.0",
+    "pyvoy>=1.1.0",
+    "ruff>=0.17.3",
+    "starlette>=1.6.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.uv.build-backend]
+module-name = ["grpcreflect"]
+
+[tool.ruff]
+extend-exclude = ["src/grpcreflect/_gen"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "UP",
+    "B",
+]
+ignore = [
+    "E501",
+    "UP046",
+]

grpcreflect_py-0.1.0/pyproject.toml.orig

@@ -0,0 +1,39 @@
+[project]
+name = "grpcreflect-py"
+version = "0.1.0"
+description = "An idiomatic Python implementation of gRPC Server Reflection compatible with ConnectRPC"
+readme = "README.md"
+authors = [{ name = "Jordan Fowler", email = "jordan@withdatakit.com" }]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+dependencies = ["connectrpc>=0.12.1", "protobuf-py>=0.5.0"]
+
+[build-system]
+requires = ["uv_build>=0.12.17,<0.13.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "buf-bin>=1.73.0",
+    "protoc-gen-connectrpc>=0.12.1",
+    "protoc-gen-py>=0.5.0",
+    "pytest>=9.1.1",
+    "pytest-asyncio>=1.4.0",
+    "pyvoy>=1.1.0",
+    "ruff>=0.17.3",
+    "starlette>=1.6.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.uv.build-backend]
+module-name = ["grpcreflect"]
+
+[tool.ruff]
+extend-exclude = ["src/grpcreflect/_gen"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+ignore = ["E501", "UP046"]

grpcreflect_py-0.1.0/src/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_py-0.1.0/src/grpcreflect/_gen/__init__.py

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

grpcreflect_py-0.1.0/src/grpcreflect/_gen/grpc/__init__.py

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

grpcreflect_py-0.1.0/src/grpcreflect/_gen/grpc/reflection/__init__.py

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

grpcreflect_py-0.1.0/src/grpcreflect/_gen/grpc/reflection/v1/__init__.py

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