grpchealth-py 0.1.0__tar.gz

grpchealth_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.

grpchealth_py-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: grpchealth-py
+Version: 0.1.0
+Summary: An idiomatic Python implementation of gRPC Service Health 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
+
+# grpchealth-py
+
+An idiomatic Python implementation of [gRPC's health checking protocol][grpc-health]
+(`grpc.health.v1`), built on [`protobuf-py`][protobuf-py] and
+[`connectrpc`][connect-python]. Modeled on Buf's Go reference implementation,
+[`grpchealth-go`][grpchealth-go].
+
+Since the health service here is just a `ConnectASGIApplication` like any
+other, it works over whichever of `connectrpc`'s protocols your own services
+already speak -- Connect, gRPC, and gRPC-Web -- with no extra configuration.
+
+[grpc-health]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md
+[protobuf-py]: https://github.com/bufbuild/protobuf-py
+[connect-python]: https://github.com/connectrpc/connect-py
+[grpchealth-go]: https://github.com/connectrpc/grpchealth-go
+
+## Install
+
+```sh
+uv add grpchealth-py
+```
+
+## Usage
+
+`mount_health_handler()` takes a `Checker` -- optionally one that also
+implements `Watcher`, to support the streaming `Watch` RPC -- and returns a
+ready-to-mount `ConnectASGIApplication`:
+
+```python
+from starlette.applications import Starlette
+from starlette.routing import Mount
+from grpchealth.checker import StaticChecker
+from grpchealth.server import mount_health_handler
+
+health = mount_health_handler(StaticChecker("acme.greet.v1.GreetService"))
+
+app = Starlette(routes=[Mount(health.path, app=health)])
+```
+
+`Watch` is a server-streaming RPC, which benefits from 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 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
+streaming support will do -- but not every ASGI server reliably supports both
+today.
+
+[pyvoy]: https://github.com/curioswitch/pyvoy
+
+## Client
+
+`Client` calls the gRPC health-checking API against a server. It structurally
+satisfies `Checker` (and, via `watch`, `Watcher`), so it can be used anywhere
+either is expected:
+
+```python
+import asyncio
+
+from grpchealth.checker import CheckRequest
+from grpchealth.client import Client
+
+
+async def main() -> None:
+    async with Client("http://localhost:8080") as client:
+        response = await client.check(
+            CheckRequest(service="acme.greet.v1.GreetService")
+        )
+        print(response.status)
+
+        async for response in client.watch(
+            CheckRequest(service="acme.greet.v1.GreetService")
+        ):
+            print(response.status)
+
+
+asyncio.run(main())
+```
+
+## Development
+
+```sh
+uv run -- buf generate   # regenerate src/grpchealth/_gen from the upstream schema
+uv run pytest
+```

grpchealth_py-0.1.0/README.md

@@ -0,0 +1,99 @@
+# grpchealth-py
+
+An idiomatic Python implementation of [gRPC's health checking protocol][grpc-health]
+(`grpc.health.v1`), built on [`protobuf-py`][protobuf-py] and
+[`connectrpc`][connect-python]. Modeled on Buf's Go reference implementation,
+[`grpchealth-go`][grpchealth-go].
+
+Since the health service here is just a `ConnectASGIApplication` like any
+other, it works over whichever of `connectrpc`'s protocols your own services
+already speak -- Connect, gRPC, and gRPC-Web -- with no extra configuration.
+
+[grpc-health]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md
+[protobuf-py]: https://github.com/bufbuild/protobuf-py
+[connect-python]: https://github.com/connectrpc/connect-py
+[grpchealth-go]: https://github.com/connectrpc/grpchealth-go
+
+## Install
+
+```sh
+uv add grpchealth-py
+```
+
+## Usage
+
+`mount_health_handler()` takes a `Checker` -- optionally one that also
+implements `Watcher`, to support the streaming `Watch` RPC -- and returns a
+ready-to-mount `ConnectASGIApplication`:
+
+```python
+from starlette.applications import Starlette
+from starlette.routing import Mount
+from grpchealth.checker import StaticChecker
+from grpchealth.server import mount_health_handler
+
+health = mount_health_handler(StaticChecker("acme.greet.v1.GreetService"))
+
+app = Starlette(routes=[Mount(health.path, app=health)])
+```
+
+`Watch` is a server-streaming RPC, which benefits from 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 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
+streaming support will do -- but not every ASGI server reliably supports both
+today.
+
+[pyvoy]: https://github.com/curioswitch/pyvoy
+
+## Client
+
+`Client` calls the gRPC health-checking API against a server. It structurally
+satisfies `Checker` (and, via `watch`, `Watcher`), so it can be used anywhere
+either is expected:
+
+```python
+import asyncio
+
+from grpchealth.checker import CheckRequest
+from grpchealth.client import Client
+
+
+async def main() -> None:
+    async with Client("http://localhost:8080") as client:
+        response = await client.check(
+            CheckRequest(service="acme.greet.v1.GreetService")
+        )
+        print(response.status)
+
+        async for response in client.watch(
+            CheckRequest(service="acme.greet.v1.GreetService")
+        ):
+            print(response.status)
+
+
+asyncio.run(main())
+```
+
+## Development
+
+```sh
+uv run -- buf generate   # regenerate src/grpchealth/_gen from the upstream schema
+uv run pytest
+```

grpchealth_py-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "grpchealth-py"
+version = "0.1.0"
+description = "An idiomatic Python implementation of gRPC Service Health 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 = ["grpchealth"]
+
+[tool.ruff]
+extend-exclude = ["src/grpchealth/_gen"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "UP",
+    "B",
+]
+ignore = [
+    "E501",
+    "UP046",
+]

grpchealth_py-0.1.0/pyproject.toml.orig

@@ -0,0 +1,39 @@
+[project]
+name = "grpchealth-py"
+version = "0.1.0"
+description = "An idiomatic Python implementation of gRPC Service Health 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 = ["grpchealth"]
+
+[tool.ruff]
+extend-exclude = ["src/grpchealth/_gen"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+ignore = ["E501", "UP046"]

grpchealth_py-0.1.0/src/grpchealth/__init__.py

@@ -0,0 +1,24 @@
+"""An idiomatic Python implementation of gRPC Service Health, compatible with ConnectRPC."""
+
+from grpchealth.checker import (
+    Checker,
+    CheckRequest,
+    CheckResponse,
+    StaticChecker,
+    Status,
+    Watcher,
+)
+from grpchealth.client import Client
+from grpchealth.server import HealthService, mount_health_handler
+
+__all__ = [
+    "CheckRequest",
+    "CheckResponse",
+    "Checker",
+    "Client",
+    "HealthService",
+    "StaticChecker",
+    "Status",
+    "Watcher",
+    "mount_health_handler",
+]

grpchealth_py-0.1.0/src/grpchealth/_gen/__init__.py

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

grpchealth_py-0.1.0/src/grpchealth/_gen/grpc/__init__.py

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

grpchealth_py-0.1.0/src/grpchealth/_gen/grpc/health/__init__.py

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

grpchealth_py-0.1.0/src/grpchealth/_gen/grpc/health/v1/__init__.py

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

grpchealth_py-0.1.0/src/grpchealth/_gen/grpc/health/v1/health_connect.py

@@ -0,0 +1,307 @@
+# Generated from grpc/health/v1/health.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 health_pb
+from .health_pb import HealthCheckRequest, HealthCheckResponse
+
+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 Health(Protocol):
+    async def check(self, request: HealthCheckRequest, ctx: RequestContext[HealthCheckRequest, HealthCheckResponse], /) -> HealthCheckResponse:
+        """
+        If the requested service is unknown, the call will fail with status
+        NOT_FOUND.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    def watch(self, request: HealthCheckRequest, ctx: RequestContext[HealthCheckRequest, HealthCheckResponse], /) -> AsyncIterator[HealthCheckResponse]:
+        """
+        Performs a watch for the serving status of the requested service.
+        The server will immediately send back a message indicating the current
+        serving status.  It will then subsequently send a new message whenever
+        the service's serving status changes.
+
+        If the requested service is unknown when the call is received, the
+        server will send a message setting the serving status to
+        SERVICE_UNKNOWN but will *not* terminate the call.  If at some
+        future point, the serving status of the service becomes known, the
+        server will send a new message with the service's serving status.
+
+        If the call terminates with status UNIMPLEMENTED, then clients
+        should assume this method is not supported and should not retry the
+        call.  If the call terminates with any other status (including OK),
+        clients should retry the call with appropriate exponential backoff.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    @classmethod
+    def desc(cls) -> DescService:
+        """Returns the descriptor for this service."""
+        return next(s for s in health_pb.desc().services if s.type_name == 'grpc.health.v1.Health')
+
+class HealthASGIApplication(ConnectASGIApplication[Health]):
+    def __init__(
+        self,
+        service: Health | AsyncGenerator[Health],
+        *,
+        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.health.v1.Health/Check": Endpoint.unary(
+                    method=MethodInfo(
+                        name="Check",
+                        service_name="grpc.health.v1.Health",
+                        input=HealthCheckRequest,
+                        output=HealthCheckResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=svc.check,
+                ),
+                "/grpc.health.v1.Health/Watch": Endpoint.server_stream(
+                    method=MethodInfo(
+                        name="Watch",
+                        service_name="grpc.health.v1.Health",
+                        input=HealthCheckRequest,
+                        output=HealthCheckResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=svc.watch,
+                ),
+            },
+            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.health.v1.Health"
+
+
+class HealthClient(ConnectClient):
+    async def check(
+        self,
+        request: HealthCheckRequest,
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> HealthCheckResponse:
+        """
+        If the requested service is unknown, the call will fail with status
+        NOT_FOUND.
+        """
+        return await self.execute_unary(
+            request=request,
+            method=MethodInfo(
+                name="Check",
+                service_name="grpc.health.v1.Health",
+                input=HealthCheckRequest,
+                output=HealthCheckResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )
+
+    def watch(
+        self,
+        request: HealthCheckRequest,
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> AsyncIterator[HealthCheckResponse]:
+        """
+        Performs a watch for the serving status of the requested service.
+        The server will immediately send back a message indicating the current
+        serving status.  It will then subsequently send a new message whenever
+        the service's serving status changes.
+
+        If the requested service is unknown when the call is received, the
+        server will send a message setting the serving status to
+        SERVICE_UNKNOWN but will *not* terminate the call.  If at some
+        future point, the serving status of the service becomes known, the
+        server will send a new message with the service's serving status.
+
+        If the call terminates with status UNIMPLEMENTED, then clients
+        should assume this method is not supported and should not retry the
+        call.  If the call terminates with any other status (including OK),
+        clients should retry the call with appropriate exponential backoff.
+        """
+        return self.execute_server_stream(
+            request=request,
+            method=MethodInfo(
+                name="Watch",
+                service_name="grpc.health.v1.Health",
+                input=HealthCheckRequest,
+                output=HealthCheckResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )
+
+class HealthSync(Protocol):
+    def check(self, request: HealthCheckRequest, ctx: RequestContext[HealthCheckRequest, HealthCheckResponse], /) -> HealthCheckResponse:
+        """
+        If the requested service is unknown, the call will fail with status
+        NOT_FOUND.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    def watch(self, request: HealthCheckRequest, ctx: RequestContext[HealthCheckRequest, HealthCheckResponse], /) -> Iterator[HealthCheckResponse]:
+        """
+        Performs a watch for the serving status of the requested service.
+        The server will immediately send back a message indicating the current
+        serving status.  It will then subsequently send a new message whenever
+        the service's serving status changes.
+
+        If the requested service is unknown when the call is received, the
+        server will send a message setting the serving status to
+        SERVICE_UNKNOWN but will *not* terminate the call.  If at some
+        future point, the serving status of the service becomes known, the
+        server will send a new message with the service's serving status.
+
+        If the call terminates with status UNIMPLEMENTED, then clients
+        should assume this method is not supported and should not retry the
+        call.  If the call terminates with any other status (including OK),
+        clients should retry the call with appropriate exponential backoff.
+        """
+        raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
+
+    @classmethod
+    def desc(cls) -> DescService:
+        """Returns the descriptor for this service."""
+        return next(s for s in health_pb.desc().services if s.type_name == 'grpc.health.v1.Health')
+
+class HealthWSGIApplication(ConnectWSGIApplication):
+    def __init__(
+        self,
+        service: HealthSync,
+        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.health.v1.Health/Check": EndpointSync.unary(
+                    method=MethodInfo(
+                        name="Check",
+                        service_name="grpc.health.v1.Health",
+                        input=HealthCheckRequest,
+                        output=HealthCheckResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=service.check,
+                ),
+                "/grpc.health.v1.Health/Watch": EndpointSync.server_stream(
+                    method=MethodInfo(
+                        name="Watch",
+                        service_name="grpc.health.v1.Health",
+                        input=HealthCheckRequest,
+                        output=HealthCheckResponse,
+                        idempotency_level=IdempotencyLevel.UNKNOWN,
+                    ),
+                    function=service.watch,
+                ),
+            },
+            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.health.v1.Health"
+
+
+class HealthClientSync(ConnectClientSync):
+    def check(
+        self,
+        request: HealthCheckRequest,
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> HealthCheckResponse:
+        """
+        If the requested service is unknown, the call will fail with status
+        NOT_FOUND.
+        """
+        return self.execute_unary(
+            request=request,
+            method=MethodInfo(
+                name="Check",
+                service_name="grpc.health.v1.Health",
+                input=HealthCheckRequest,
+                output=HealthCheckResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )
+    def watch(
+        self,
+        request: HealthCheckRequest,
+        *,
+        headers: Headers | Mapping[str, str] | None = None, 
+        timeout_ms: int | None = None,
+    ) -> Iterator[HealthCheckResponse]:
+        """
+        Performs a watch for the serving status of the requested service.
+        The server will immediately send back a message indicating the current
+        serving status.  It will then subsequently send a new message whenever
+        the service's serving status changes.
+
+        If the requested service is unknown when the call is received, the
+        server will send a message setting the serving status to
+        SERVICE_UNKNOWN but will *not* terminate the call.  If at some
+        future point, the serving status of the service becomes known, the
+        server will send a new message with the service's serving status.
+
+        If the call terminates with status UNIMPLEMENTED, then clients
+        should assume this method is not supported and should not retry the
+        call.  If the call terminates with any other status (including OK),
+        clients should retry the call with appropriate exponential backoff.
+        """
+        return self.execute_server_stream(
+            request=request,
+            method=MethodInfo(
+                name="Watch",
+                service_name="grpc.health.v1.Health",
+                input=HealthCheckRequest,
+                output=HealthCheckResponse,
+                idempotency_level=IdempotencyLevel.UNKNOWN,
+            ),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )

grpchealth_py-0.1.0/src/grpchealth/_gen/grpc/health/v1/health_pb.py

@@ -0,0 +1,120 @@
+# Generated from grpc/health/v1/health.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 Enum, Message
+from protobuf._codegen import file_desc
+
+if TYPE_CHECKING:
+    from protobuf import DescFile
+
+
+_HealthCheckRequestFields: TypeAlias = Literal["service"]
+
+class HealthCheckRequest(Message[_HealthCheckRequestFields]):
+    """
+    ```proto
+    message grpc.health.v1.HealthCheckRequest
+    ```
+
+    Attributes:
+        service:
+            ```proto
+            string service = 1;
+            ```
+    """
+
+    __slots__ = ("service",)
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            service: str = "",
+        ) -> None:
+            pass
+
+        service: str
+
+_HealthCheckResponseFields: TypeAlias = Literal["status"]
+
+class HealthCheckResponse(Message[_HealthCheckResponseFields]):
+    """
+    ```proto
+    message grpc.health.v1.HealthCheckResponse
+    ```
+
+    Attributes:
+        status:
+            ```proto
+            grpc.health.v1.HealthCheckResponse.ServingStatus status = 1;
+            ```
+    """
+
+    __slots__ = ("status",)
+
+    if TYPE_CHECKING:
+
+        def __init__(
+            self,
+            *,
+            status: HealthCheckResponse.ServingStatus | None = None,
+        ) -> None:
+            pass
+
+        status: HealthCheckResponse.ServingStatus
+
+    class ServingStatus(Enum):
+        """
+        ```proto
+        enum grpc.health.v1.HealthCheckResponse.ServingStatus
+        ```
+
+        Attributes:
+            UNKNOWN:
+                ```proto
+                UNKNOWN = 0
+                ```
+            SERVING:
+                ```proto
+                SERVING = 1
+                ```
+            NOT_SERVING:
+                ```proto
+                NOT_SERVING = 2
+                ```
+            SERVICE_UNKNOWN:
+                Used only by the Watch method.
+
+                ```proto
+                SERVICE_UNKNOWN = 3
+                ```
+        """
+
+        UNKNOWN = 0
+        SERVING = 1
+        NOT_SERVING = 2
+        SERVICE_UNKNOWN = 3
+
+
+_DESC = file_desc(
+    b'\n\x1bgrpc/health/v1/health.proto\x12\x0egrpc.health.v1".\n\x12HealthCheckRequest\x12\x18\n\x07service\x18\x01 \x01(\tR\x07service"\xb1\x01\n\x13HealthCheckResponse\x12I\n\x06status\x18\x01 \x01(\x0e21.grpc.health.v1.HealthCheckResponse.ServingStatusR\x06status"O\n\rServingStatus\x12\x0b\n\x07UNKNOWN\x10\x00\x12\x0b\n\x07SERVING\x10\x01\x12\x0f\n\x0bNOT_SERVING\x10\x02\x12\x13\n\x0fSERVICE_UNKNOWN\x10\x032\xae\x01\n\x06Health\x12P\n\x05Check\x12".grpc.health.v1.HealthCheckRequest\x1a#.grpc.health.v1.HealthCheckResponse\x12R\n\x05Watch\x12".grpc.health.v1.HealthCheckRequest\x1a#.grpc.health.v1.HealthCheckResponse0\x01B\xa9\x01\n\x12com.grpc.health.v1B\x0bHealthProtoP\x01Z,google.golang.org/grpc/health/grpc_health_v1\xa2\x02\x03GHX\xaa\x02\x0eGrpc.Health.V1\xca\x02\x0eGrpc\\Health\\V1\xe2\x02\x1aGrpc\\Health\\V1\\GPBMetadata\xea\x02\x10Grpc::Health::V1b\x06proto3',
+    [],
+    {
+        "HealthCheckRequest": HealthCheckRequest,
+        "HealthCheckResponse": HealthCheckResponse,
+        "HealthCheckResponse.ServingStatus": HealthCheckResponse.ServingStatus,
+    },
+)
+
+
+def desc() -> DescFile:
+    """Returns the descriptor for the file `grpc/health/v1/health.proto`."""
+    return _DESC

grpchealth_py-0.1.0/src/grpchealth/checker.py

@@ -0,0 +1,131 @@
+"""Health status types and the `Checker`/`Watcher` protocols implementations satisfy.
+
+Modeled on Go's `Checker`/`Watcher`/`StaticChecker`
+(`grpchealth-go/grpchealth.go`, `grpchealth-go/static_checker.go`), but with
+Go's callback-plus-stop-function `Watch` replaced by a plain async generator:
+`Watcher.watch()` is an `AsyncIterator` that yields the current status
+immediately, then again each time it may have changed.
+"""
+
+from __future__ import annotations
+
+import asyncio
+from dataclasses import dataclass
+from enum import IntEnum
+from typing import TYPE_CHECKING, Protocol, runtime_checkable
+
+from connectrpc.code import Code
+from connectrpc.errors import ConnectError
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator
+
+
+class Status(IntEnum):
+    """The serving status of a service, or of the whole process.
+
+    Mirrors `grpc.health.v1.HealthCheckResponse.ServingStatus`. `SERVICE_UNKNOWN`
+    is only ever seen in a `Watch` reply for a service that isn't known; a
+    `Checker` itself should never return it from `check()`.
+    """
+
+    UNKNOWN = 0
+    SERVING = 1
+    NOT_SERVING = 2
+    SERVICE_UNKNOWN = 3
+
+
+@dataclass(frozen=True, slots=True)
+class CheckRequest:
+    """A request for the health of a service.
+
+    An empty `service` asks for the health of the whole process.
+    """
+
+    service: str = ""
+
+
+@dataclass(frozen=True, slots=True)
+class CheckResponse:
+    """Reports the health of a service (or of the whole process)."""
+
+    status: Status
+
+
+@runtime_checkable
+class Checker(Protocol):
+    """Reports the health of a service. Must be safe to call concurrently."""
+
+    async def check(self, request: CheckRequest) -> CheckResponse:
+        """Returns the health of `request.service`.
+
+        If the service is unknown, raises a `ConnectError` with `Code.NOT_FOUND`.
+        """
+        ...
+
+
+@runtime_checkable
+class Watcher(Checker, Protocol):
+    """Extends `Checker` with the ability to stream status changes.
+
+    `watch()` yields the current status immediately, then again each time it
+    may have changed; it raises a `ConnectError` with `Code.NOT_FOUND` if
+    `request.service` is unknown.
+    """
+
+    def watch(self, request: CheckRequest) -> AsyncIterator[CheckResponse]:
+        """Streams `request.service`'s status until the caller stops iterating."""
+        ...
+
+
+class StaticChecker:
+    """A simple `Checker`/`Watcher`.
+
+    Always reports `Status.SERVING` for the whole process, and a static,
+    settable status for each service named at construction (or later, via
+    `set_status`).
+
+    If you have a dynamic list of services, want to ping a database as part
+    of your health check, or otherwise need something more specialized,
+    write your own `Checker`.
+    """
+
+    def __init__(self, *services: str) -> None:
+        self._statuses: dict[str, Status] = dict.fromkeys(services, Status.SERVING)
+        self._events: dict[str, asyncio.Event] = {}
+
+    def set_status(self, service: str, status: Status) -> None:
+        """Sets `service`'s health status, registering it if necessary.
+
+        An empty `service` sets the server-wide status returned to checks
+        that don't name a particular service (absent that, such checks
+        report `Status.SERVING`).
+        """
+        self._statuses[service] = status
+        event = self._events.get(service)
+        if event is not None:
+            event.set()
+
+    async def check(self, request: CheckRequest) -> CheckResponse:
+        status = self._statuses.get(request.service)
+        if status is not None:
+            return CheckResponse(status=status)
+        if not request.service:
+            return CheckResponse(status=Status.SERVING)
+        raise ConnectError(Code.NOT_FOUND, f"unknown service {request.service}")
+
+    async def watch(self, request: CheckRequest) -> AsyncIterator[CheckResponse]:
+        if request.service and request.service not in self._statuses:
+            raise ConnectError(Code.NOT_FOUND, f"unknown service {request.service}")
+        # Shared per-service, so `set_status` only has to wake whoever's watching it.
+        event = self._events.setdefault(request.service, asyncio.Event())
+        last: Status | None = None
+        while True:
+            # Cleared before reading status so a concurrent `set_status` is never missed.
+            event.clear()
+            status = self._statuses.get(request.service, Status.SERVING)
+            if status != last:
+                last = status
+                yield CheckResponse(status=status)
+            else:
+                await event.wait()

grpchealth_py-0.1.0/src/grpchealth/client.py

@@ -0,0 +1,84 @@
+"""Client for the gRPC health-checking API.
+
+Modeled on Go's `Client` (`grpchealth-go/client.go`): wraps the generated
+`HealthClient`, translating its wire-format request/response messages to and
+from `CheckRequest`/`CheckResponse`, so a `Client` instance structurally
+satisfies `Checker` (and, via `watch`, `Watcher`) and can be used anywhere
+either is expected -- for example, to proxy another server's health status
+through your own.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from grpchealth._gen.grpc.health.v1 import health_connect as _health_connect
+from grpchealth._gen.grpc.health.v1 import health_pb as _health_pb
+from grpchealth.checker import CheckRequest, CheckResponse, Status
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator
+
+    from connectrpc.request import Headers
+
+
+class Client:
+    """Calls the gRPC health-checking API against one server.
+
+    By default, transports use the Connect protocol with the binary Protobuf
+    codec; accepts the same keyword options as `connectrpc.client.ConnectClient`
+    to configure the gRPC protocol or otherwise.
+    """
+
+    def __init__(self, address: str, **client_options: Any) -> None:
+        self._client = _health_connect.HealthClient(address, **client_options)
+
+    async def check(
+        self,
+        request: CheckRequest,
+        *,
+        headers: Headers | None = None,
+        timeout_ms: int | None = None,
+    ) -> CheckResponse:
+        """Reports the health of `request.service`.
+
+        An empty `request.service` asks for the health of the whole server
+        process. If the service is unknown, raises a `ConnectError` with
+        `Code.NOT_FOUND`.
+        """
+        response = await self._client.check(
+            _health_pb.HealthCheckRequest(service=request.service),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        )
+        return CheckResponse(status=Status(response.status))
+
+    async def watch(
+        self,
+        request: CheckRequest,
+        *,
+        headers: Headers | None = None,
+        timeout_ms: int | None = None,
+    ) -> AsyncIterator[CheckResponse]:
+        """Streams health status changes for `request.service`.
+
+        Yields the current status immediately, then again each time it may
+        have changed. The stream ends when the server closes it or an error
+        occurs -- including `Code.UNIMPLEMENTED` if the server doesn't
+        support `Watch`.
+        """
+        async for response in self._client.watch(
+            _health_pb.HealthCheckRequest(service=request.service),
+            headers=headers,
+            timeout_ms=timeout_ms,
+        ):
+            yield CheckResponse(status=Status(response.status))
+
+    async def close(self) -> None:
+        await self._client.close()
+
+    async def __aenter__(self) -> Client:
+        return self
+
+    async def __aexit__(self, *exc_info: object) -> None:
+        await self.close()

grpchealth_py-0.1.0/src/grpchealth/server.py

@@ -0,0 +1,105 @@
+"""Adapts a `Checker`/`Watcher` to the generated `grpc.health.v1.Health` service.
+
+Mirrors Go's `Register` (`grpchealth-go/grpchealth.go`): `mount_health_handler`
+builds the `ConnectASGIApplication` for `grpc.health.v1.Health`, wired to
+answer `Check`/`Watch` from a `Checker` you supply. If the `Checker` doesn't
+also implement `Watcher`, `Watch` responds `Code.UNIMPLEMENTED`, same as Go.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from connectrpc.code import Code
+from connectrpc.errors import ConnectError
+from connectrpc.server import DEFAULT_READ_MAX_BYTES, ConnectASGIApplication
+
+from grpchealth._gen.grpc.health.v1 import health_connect as _health_connect
+from grpchealth._gen.grpc.health.v1 import health_pb as _health_pb
+from grpchealth.checker import Checker, CheckRequest, Watcher
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator, Iterable
+
+    from connectrpc.codec import Codec
+    from connectrpc.compression import Compression
+    from connectrpc.interceptor import Interceptor
+    from connectrpc.request import RequestContext
+    from protobuf import DescService
+
+
+class HealthService:
+    """Implements `grpc.health.v1.Health` over a `Checker`."""
+
+    def __init__(self, checker: Checker) -> None:
+        self._checker = checker
+        self._watcher = checker if isinstance(checker, Watcher) else None
+
+    async def check(
+        self,
+        request: _health_pb.HealthCheckRequest,
+        ctx: RequestContext[
+            _health_pb.HealthCheckRequest, _health_pb.HealthCheckResponse
+        ],
+        /,
+    ) -> _health_pb.HealthCheckResponse:
+        del ctx
+        response = await self._checker.check(CheckRequest(service=request.service))
+        return _health_pb.HealthCheckResponse(
+            status=_health_pb.HealthCheckResponse.ServingStatus(response.status)
+        )
+
+    def watch(
+        self,
+        request: _health_pb.HealthCheckRequest,
+        ctx: RequestContext[
+            _health_pb.HealthCheckRequest, _health_pb.HealthCheckResponse
+        ],
+        /,
+    ) -> AsyncIterator[_health_pb.HealthCheckResponse]:
+        del ctx
+        watcher = self._watcher
+        if watcher is None:
+            raise ConnectError(
+                Code.UNIMPLEMENTED, "watching health state is not supported"
+            )
+        return self._watch(watcher, request.service)
+
+    async def _watch(
+        self, watcher: Watcher, service: str
+    ) -> AsyncIterator[_health_pb.HealthCheckResponse]:
+        async for response in watcher.watch(CheckRequest(service=service)):
+            yield _health_pb.HealthCheckResponse(
+                status=_health_pb.HealthCheckResponse.ServingStatus(response.status)
+            )
+
+    @classmethod
+    def desc(cls) -> DescService:
+        return _health_connect.Health.desc()
+
+
+def mount_health_handler(
+    checker: Checker,
+    *,
+    interceptors: Iterable[Interceptor] = (),
+    read_max_bytes: int | None = DEFAULT_READ_MAX_BYTES,
+    compressions: Iterable[Compression] | None = None,
+    codecs: Iterable[Codec] | None = None,
+) -> ConnectASGIApplication[Any]:
+    """Builds the `grpc.health.v1.Health` ASGI application for `checker`.
+
+    If `checker` also implements `Watcher`, the returned application supports
+    the streaming `Watch` RPC; otherwise `Watch` responds `Code.UNIMPLEMENTED`.
+
+    ```python
+    health = mount_health_handler(StaticChecker("acme.user.v1.UserService"))
+    app = Starlette(routes=[Mount(health.path, app=health)])
+    ```
+    """
+    return _health_connect.HealthASGIApplication(
+        HealthService(checker),
+        interceptors=interceptors,
+        read_max_bytes=read_max_bytes,
+        compressions=compressions,
+        codecs=codecs,
+    )