Typing Stubs for grpcio-health-checking

Warnings

• gotcha This package provides only type stubs and does not contain any runtime code. Its sole purpose is to provide type information for static analysis tools like MyPy.
  Fix: Install `grpcio` and `grpcio-health-checking` for runtime functionality. Install `types-grpcio-health-checking` only for type checking purposes.
• gotcha Do not attempt to import symbols directly from `types_grpcio_health_checking`. The stub package augments the original `grpcio-health-checking` library. All imports should be made from `grpc_health.v1` modules as if the stubs were not present.
  Fix: Always use standard `from grpc_health.v1 import ...` import statements. The `types-` package is picked up automatically by type checkers.
• breaking Type stubs are tightly coupled to the API of the runtime library they type. If you upgrade `grpcio-health-checking` to a new major version, the corresponding `types-grpcio-health-checking` stubs might become outdated or incorrect, potentially leading to type errors or undetected runtime issues.
  Fix: Always keep your `types-grpcio-health-checking` version in sync with your `grpcio-health-checking` version. Refer to the `typeshed` repository for specific version compatibility information.
• gotcha The version numbering for `types-` packages from `typeshed` (e.g., `1.0.0.20260408`) indicates the upstream package version (1.0.0) and the date the stub was generated/updated (20260408). It does not necessarily match the exact versioning scheme of the runtime `grpcio-health-checking` package.
  Fix: Understand that the date suffix signifies the freshness of the stub, not a direct API version. Always consult `typeshed` or `grpcio-health-checking` documentation for specific compatibility.

Install

• pip install types-grpcio-health-checking Install typing stubs
• pip install grpcio grpcio-health-checking mypy Install runtime dependencies and type checker (recommended)

Imports

• HealthServicer

  from grpc_health.v1.health import HealthServicer

  Typing stubs augment the existing runtime modules; you import directly from the original library path, not the stub package itself.
• HealthCheckRequest

  from grpc_health.v1 import health_pb2

  Messages like HealthCheckRequest are typically accessed via the _pb2 generated module.

Quickstart

This quickstart demonstrates how to use the type hints provided by `types-grpcio-health-checking` in a `grpcio-health-checking` service implementation. It highlights the correct import paths and how type annotations enhance code clarity and enable static analysis. Note that the `types-` package is for type checking, not for runtime execution; the actual runtime code requires `grpcio` and `grpcio-health-checking`.

import grpc
from grpc_health.v1 import health_pb2
from grpc_health.v1.health import HealthServicer

# This example demonstrates using type hints provided by types-grpcio-health-checking.
# For this code to run, 'grpcio' and 'grpcio-health-checking' must also be installed.
# The 'types-' package primarily assists static analysis tools like MyPy.

class MyHealthServicer(HealthServicer):
    """
    An example gRPC Health Servicer implementation. The type hints for
    `request` and the return value are validated by type checkers (like mypy)
    thanks to the 'types-grpcio-health-checking' package providing stubs
    for 'grpcio-health-checking'.
    """
    def Check(self,
              request: health_pb2.HealthCheckRequest,
              context: grpc.ServicerContext) -> health_pb2.HealthCheckResponse:
        """
        Implements the Check method of the gRPC Health Service.
        """
        print(f"Received health check for service: {request.service}")
        # In a real application, you'd check actual service status here.
        if request.service == "myservice":
            return health_pb2.HealthCheckResponse(status=health_pb2.HealthCheckResponse.ServingStatus.SERVING)
        return health_pb2.HealthCheckResponse(status=health_pb2.HealthCheckResponse.ServingStatus.NOT_SERVING)

    def Watch(self,
              request: health_pb2.HealthCheckRequest,
              context: grpc.ServicerContext) -> health_pb2.HealthCheckResponse:
        """
        Implements the Watch method (streaming). For simplicity,
        this example just yields a single response.
        """
        yield health_pb2.HealthCheckResponse(status=health_pb2.HealthCheckResponse.ServingStatus.SERVING)

# To verify type-checking with MyPy:
# 1. Ensure you have 'grpcio', 'grpcio-health-checking', 'types-grpcio-health-checking', and 'mypy' installed.
# 2. Save this code as 'health_types_example.py'.
# 3. Run: mypy health_types_example.py
# If 'types-grpcio-health-checking' were missing, mypy would report errors for `HealthServicer` and other type hints.