Add health and reflection proto

XuanWang-Amos · XuanWang-Amos · commit e0fbf28f74b8 · 2025-02-20T23:15:04.000Z
diff --git a/examples/python/debug/asyncio_get_stats.py b/examples/python/debug/asyncio_get_stats.py
@@ -18,14 +18,8 @@
 import logging
 
 import grpc
-
-# Bazel build uses another path.
-try:
-    import channelz_pb2
-    import channelz_pb2_grpc
-except ImportError:
-    from grpc_channelz.v1 import channelz_pb2
-    from grpc_channelz.v1 import channelz_pb2_grpc
+from grpc_channelz.v1 import channelz_pb2
+from grpc_channelz.v1 import channelz_pb2_grpc
 
 
 async def run(addr: str) -> None:
diff --git a/examples/python/debug/get_stats.py b/examples/python/debug/get_stats.py
@@ -21,14 +21,8 @@
 import logging
 
 import grpc
-
-# Bazel build uses another path.
-try:
-    import channelz_pb2
-    import channelz_pb2_grpc
-except ImportError:
-    from grpc_channelz.v1 import channelz_pb2
-    from grpc_channelz.v1 import channelz_pb2_grpc
+from grpc_channelz.v1 import channelz_pb2
+from grpc_channelz.v1 import channelz_pb2_grpc
 
 
 def run(addr):
diff --git a/examples/python/health_checking/greeter_client.py b/examples/python/health_checking/greeter_client.py
@@ -17,17 +17,11 @@
 from time import sleep
 
 import grpc
+from grpc_health.v1 import health_pb2
+from grpc_health.v1 import health_pb2_grpc
 import helloworld_pb2
 import helloworld_pb2_grpc
 
-# Bazel build uses another path.
-try:
-    import health_pb2
-    import health_pb2_grpc
-except ImportError:
-    from grpc_health.v1 import health_pb2
-    from grpc_health.v1 import health_pb2_grpc
-
 
 def unary_call(stub: helloworld_pb2_grpc.GreeterStub, message: str):
     response = stub.SayHello(
diff --git a/examples/python/health_checking/greeter_server.py b/examples/python/health_checking/greeter_server.py
@@ -20,19 +20,11 @@
 
 import grpc
 from grpc_health.v1 import health
+from grpc_health.v1 import health_pb2
+from grpc_health.v1 import health_pb2_grpc
 import helloworld_pb2
 import helloworld_pb2_grpc
 
-# Bazel build uses another path.
-# pylint: disable=ungrouped-imports
-try:
-    import health_pb2
-    import health_pb2_grpc
-except ImportError:
-    from grpc_health.v1 import health_pb2
-    from grpc_health.v1 import health_pb2_grpc
-# pylint: enable=ungrouped-imports
-
 
 class Greeter(helloworld_pb2_grpc.GreeterServicer):
     def SayHello(self, request, context):
diff --git a/examples/python/xds/server.py b/examples/python/xds/server.py
@@ -20,21 +20,12 @@
 
 import grpc
 from grpc_health.v1 import health
+from grpc_health.v1 import health_pb2
+from grpc_health.v1 import health_pb2_grpc
 from grpc_reflection.v1alpha import reflection
 import helloworld_pb2
 import helloworld_pb2_grpc
 
-# Bazel build uses another path.
-# pylint: disable=ungrouped-imports
-try:
-    import health_pb2
-    import health_pb2_grpc
-except ImportError:
-    from grpc_health.v1 import health_pb2
-    from grpc_health.v1 import health_pb2_grpc
-# pylint: enable=ungrouped-imports
-
-
 _DESCRIPTION = "A general purpose phony server."
 
 _LISTEN_HOST = "0.0.0.0"
diff --git a/src/proto/grpc/health/v1/BUILD b/src/proto/grpc/health/v1/BUILD
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 load("//bazel:grpc_build_system.bzl", "grpc_cc_grpc_library", "grpc_cc_proto_library", "grpc_internal_proto_library", "grpc_package")
-load("@com_google_protobuf//bazel:proto_library.bzl", "proto_library")
 
 licenses(["notice"])
 
@@ -39,12 +38,6 @@ grpc_cc_grpc_library(
     deps = ["health_cc_proto"],
 )
 
-proto_library(
-    name = "health_proto_descriptor",
-    srcs = ["health.proto"],
-    strip_import_prefix = "/src/proto/grpc/health/v1",
-)
-
 filegroup(
     name = "health_proto_file",
     srcs = [
diff --git a/src/proto/grpc/reflection/v1/BUILD b/src/proto/grpc/reflection/v1/BUILD
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 load("//bazel:grpc_build_system.bzl", "grpc_package", "grpc_proto_library")
-load("@com_google_protobuf//bazel:proto_library.bzl", "proto_library")
 
 licenses(["notice"])
 
@@ -30,12 +29,6 @@ grpc_proto_library(
     srcs = ["reflection.proto"],
 )
 
-proto_library(
-    name = "reflection_proto_descriptor",
-    srcs = ["reflection.proto"],
-    strip_import_prefix = "/src/proto/grpc/reflection/v1",
-)
-
 filegroup(
     name = "reflection_proto_file",
     srcs = [
diff --git a/src/proto/grpc/reflection/v1alpha/BUILD b/src/proto/grpc/reflection/v1alpha/BUILD
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 load("//bazel:grpc_build_system.bzl", "grpc_package", "grpc_proto_library")
-load("@com_google_protobuf//bazel:proto_library.bzl", "proto_library")
 
 licenses(["notice"])
 
@@ -30,12 +29,6 @@ grpc_proto_library(
     srcs = ["reflection.proto"],
 )
 
-proto_library(
-    name = "reflection_proto_descriptor",
-    srcs = ["reflection.proto"],
-    strip_import_prefix = "/src/proto/grpc/reflection/v1alpha",
-)
-
 filegroup(
     name = "reflection_proto_file",
     srcs = [
diff --git a/src/python/grpcio_channelz/grpc_channelz/v1/_async.py b/src/python/grpcio_channelz/grpc_channelz/v1/_async.py
@@ -15,9 +15,9 @@
 
 from grpc.experimental import aio
 from grpc_channelz.v1._servicer import ChannelzServicer as _SyncChannelzServicer
+import grpc_channelz.v1.channelz_pb2 as _channelz_pb2
+import grpc_channelz.v1.channelz_pb2_grpc as _channelz_pb2_grpc
 
-from grpc_channelz.v1 import channelz_pb2 as _channelz_pb2
-from grpc_channelz.v1 import channelz_pb2_grpc as _channelz_pb2_grpc
 
 class ChannelzServicer(_channelz_pb2_grpc.ChannelzServicer):
     """AsyncIO servicer for handling RPCs for service statuses."""
diff --git a/src/python/grpcio_channelz/grpc_channelz/v1/_servicer.py b/src/python/grpcio_channelz/grpc_channelz/v1/_servicer.py
@@ -16,9 +16,9 @@
 from google.protobuf import json_format
 import grpc
 from grpc._cython import cygrpc
+import grpc_channelz.v1.channelz_pb2 as _channelz_pb2
+import grpc_channelz.v1.channelz_pb2_grpc as _channelz_pb2_grpc
 
-from grpc_channelz.v1 import channelz_pb2 as _channelz_pb2
-from grpc_channelz.v1 import channelz_pb2_grpc as _channelz_pb2_grpc
 
 class ChannelzServicer(_channelz_pb2_grpc.ChannelzServicer):
     """Servicer handling RPCs for service statuses."""
diff --git a/src/python/grpcio_channelz/grpc_channelz/v1/channelz.py b/src/python/grpcio_channelz/grpc_channelz/v1/channelz.py
@@ -17,8 +17,7 @@
 
 import grpc
 from grpc_channelz.v1._servicer import ChannelzServicer
-
-from grpc_channelz.v1 import channelz_pb2_grpc as _channelz_pb2_grpc
+import grpc_channelz.v1.channelz_pb2_grpc as _channelz_pb2_grpc
 
 _add_channelz_servicer_doc = """Add Channelz servicer to a server.
 
diff --git a/src/python/grpcio_health_checking/.gitignore b/src/python/grpcio_health_checking/.gitignore
@@ -1,4 +1,3 @@
-*.proto
 *_pb2.py
 *_pb2_grpc.py
 build/
diff --git a/src/python/grpcio_health_checking/grpc_health/v1/BUILD.bazel b/src/python/grpcio_health_checking/grpc_health/v1/BUILD.bazel
@@ -12,18 +12,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 load("@rules_python//python:defs.bzl", "py_library")
+load("@com_google_protobuf//bazel:proto_library.bzl", "proto_library")
 load("//bazel:python_rules.bzl", "py_grpc_library", "py_proto_library")
 
 package(default_visibility = ["//visibility:public"])
 
+proto_library(
+    name = "health_proto_descriptor",
+    srcs = ["health.proto"],
+)
+
 py_proto_library(
     name = "health_py_pb2",
-    deps = ["//src/proto/grpc/health/v1:health_proto_descriptor"],
+    deps = [":health_proto_descriptor"],
 )
 
 py_grpc_library(
     name = "health_py_pb2_grpc",
-    srcs = ["//src/proto/grpc/health/v1:health_proto_descriptor"],
+    srcs = [":health_proto_descriptor"],
     strip_prefixes = ["src.python.grpcio_health_checking."],
     deps = [":health_py_pb2"],
 )
diff --git a/src/python/grpcio_health_checking/grpc_health/v1/_async.py b/src/python/grpcio_health_checking/grpc_health/v1/_async.py
@@ -18,14 +18,8 @@
 from typing import MutableMapping
 
 import grpc
-
-# Bazel build uses another path.
-try:
-    import health_pb2 as _health_pb2
-    import health_pb2_grpc as _health_pb2_grpc
-except ImportError:
-    from grpc_health.v1 import health_pb2 as _health_pb2
-    from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
+from grpc_health.v1 import health_pb2 as _health_pb2
+from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
 
 
 class HealthServicer(_health_pb2_grpc.HealthServicer):
diff --git a/src/python/grpcio_health_checking/grpc_health/v1/health.proto b/src/python/grpcio_health_checking/grpc_health/v1/health.proto
@@ -0,0 +1,63 @@
+// Copyright 2015 The gRPC Authors
+//
+// 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.
+
+// The canonical version of this proto can be found at
+// https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto
+
+syntax = "proto3";
+
+package grpc.health.v1;
+
+option csharp_namespace = "Grpc.Health.V1";
+option go_package = "google.golang.org/grpc/health/grpc_health_v1";
+option java_multiple_files = true;
+option java_outer_classname = "HealthProto";
+option java_package = "io.grpc.health.v1";
+
+message HealthCheckRequest {
+  string service = 1;
+}
+
+message HealthCheckResponse {
+  enum ServingStatus {
+    UNKNOWN = 0;
+    SERVING = 1;
+    NOT_SERVING = 2;
+    SERVICE_UNKNOWN = 3;  // Used only by the Watch method.
+  }
+  ServingStatus status = 1;
+}
+
+service Health {
+  // If the requested service is unknown, the call will fail with status
+  // NOT_FOUND.
+  rpc Check(HealthCheckRequest) returns (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.
+  rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
+}
diff --git a/src/python/grpcio_health_checking/grpc_health/v1/health.py b/src/python/grpcio_health_checking/grpc_health/v1/health.py
@@ -18,14 +18,8 @@
 import threading
 
 import grpc
-
-# Bazel build uses another path.
-try:
-    import health_pb2 as _health_pb2
-    import health_pb2_grpc as _health_pb2_grpc
-except ImportError:
-    from grpc_health.v1 import health_pb2 as _health_pb2
-    from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
+from grpc_health.v1 import health_pb2 as _health_pb2
+from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
 
 if sys.version_info[0] >= 3 and sys.version_info[1] >= 6:
     # Exposes AsyncHealthServicer as public API.
diff --git a/src/python/grpcio_reflection/.gitignore b/src/python/grpcio_reflection/.gitignore
@@ -1,4 +1,3 @@
-*.proto
 *_pb2.py
 build/
 grpcio_reflection.egg-info/
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/BUILD.bazel b/src/python/grpcio_reflection/grpc_reflection/v1alpha/BUILD.bazel
@@ -12,18 +12,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 load("@rules_python//python:defs.bzl", "py_library")
+load("@com_google_protobuf//bazel:proto_library.bzl", "proto_library")
 load("//bazel:python_rules.bzl", "py_grpc_library", "py_proto_library")
 
 package(default_visibility = ["//visibility:public"])
 
+proto_library(
+    name = "reflection_proto_descriptor",
+    srcs = ["reflection.proto"],
+)
+
 py_proto_library(
     name = "reflection_py_pb2",
-    deps = ["//src/proto/grpc/reflection/v1alpha:reflection_proto_descriptor"],
+    deps = [":reflection_proto_descriptor"],
 )
 
 py_grpc_library(
     name = "reflection_py_pb2_grpc",
-    srcs = ["//src/proto/grpc/reflection/v1alpha:reflection_proto_descriptor"],
+    srcs = [":reflection_proto_descriptor"],
     strip_prefixes = ["src.python.grpcio_reflection."],
     deps = ["reflection_py_pb2"],
 )
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/_async.py b/src/python/grpcio_reflection/grpc_reflection/v1alpha/_async.py
@@ -16,16 +16,9 @@
 from typing import AsyncIterable
 
 import grpc
+from grpc_reflection.v1alpha import reflection_pb2 as _reflection_pb2
 from grpc_reflection.v1alpha._base import BaseReflectionServicer
 
-# Bazel build uses another path.
-# pylint: disable=ungrouped-imports
-try:
-    import reflection_pb2 as _reflection_pb2
-except ImportError:
-    from grpc_reflection.v1alpha import reflection_pb2 as _reflection_pb2
-# pylint: enable=ungrouped-imports
-
 
 class ReflectionServicer(BaseReflectionServicer):
     """Servicer handling RPCs for service statuses."""
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/_base.py b/src/python/grpcio_reflection/grpc_reflection/v1alpha/_base.py
@@ -16,16 +16,8 @@
 from google.protobuf import descriptor_pb2
 from google.protobuf import descriptor_pool
 import grpc
-
-# Bazel build uses another path.
-try:
-    import reflection_pb2 as _reflection_pb2
-    import reflection_pb2_grpc as _reflection_pb2_grpc
-except ImportError:
-    from grpc_reflection.v1alpha import (
-        reflection_pb2_grpc as _reflection_pb2_grpc,
-    )
-    from grpc_reflection.v1alpha import reflection_pb2 as _reflection_pb2
+from grpc_reflection.v1alpha import reflection_pb2 as _reflection_pb2
+from grpc_reflection.v1alpha import reflection_pb2_grpc as _reflection_pb2_grpc
 
 _POOL = descriptor_pool.Default()
 
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/proto_reflection_descriptor_database.py b/src/python/grpcio_reflection/grpc_reflection/v1alpha/proto_reflection_descriptor_database.py
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/reflection.proto b/src/python/grpcio_reflection/grpc_reflection/v1alpha/reflection.proto
diff --git a/src/python/grpcio_reflection/grpc_reflection/v1alpha/reflection.py b/src/python/grpcio_reflection/grpc_reflection/v1alpha/reflection.py
diff --git a/src/python/grpcio_tests/tests/admin/admin_test.py b/src/python/grpcio_tests/tests/admin/admin_test.py
diff --git a/src/python/grpcio_tests/tests/health_check/_health_servicer_test.py b/src/python/grpcio_tests/tests/health_check/_health_servicer_test.py
diff --git a/src/python/grpcio_tests/tests/reflection/_reflection_servicer_test.py b/src/python/grpcio_tests/tests/reflection/_reflection_servicer_test.py
diff --git a/src/python/grpcio_tests/tests_aio/channelz/channelz_servicer_test.py b/src/python/grpcio_tests/tests_aio/channelz/channelz_servicer_test.py
diff --git a/src/python/grpcio_tests/tests_aio/health_check/health_servicer_test.py b/src/python/grpcio_tests/tests_aio/health_check/health_servicer_test.py
diff --git a/src/python/grpcio_tests/tests_aio/reflection/reflection_servicer_test.py b/src/python/grpcio_tests/tests_aio/reflection/reflection_servicer_test.py
diff --git a/src/python/grpcio_tests/tests_py3_only/interop/xds_interop_server.py b/src/python/grpcio_tests/tests_py3_only/interop/xds_interop_server.py
