Merge branch 'main' into add-protobuf-runtime

Author: parthea

.github/sync-repo-settings.yaml

@@ -15,14 +15,11 @@ branchProtectionRules:
     - 'mypy (3.13)'
     - 'showcase (3.7, showcase)'
     - 'showcase (3.13, showcase)'
-    - 'showcase (3.7, showcase_alternative_templates)'
-    - 'showcase (3.13, showcase_alternative_templates)'
     - 'showcase (3.7, showcase_w_rest_async)'
     - 'showcase (3.13, showcase_w_rest_async)'
     # TODO(dovs): reenable these when the mtls tests have been debugged and fixed
     # See #1218 for details
     # - 'showcase-mtls (showcase_mtls)'
-    # - 'showcase-mtls (showcase_mtls_alternative_templates)'
     - 'showcase-mypy'
     - 'showcase-mypy (_alternative_templates)'
     - 'showcase-unit (3.7)'

.github/workflows/tests.yaml

@@ -57,7 +57,7 @@ jobs:
       matrix:
         # TODO(https://github.com/googleapis/gapic-generator-python/issues/2121) Remove `showcase_w_rest_async` target when async rest is GA.
         python: ["3.7", "3.13"]
-        target: [showcase, showcase_alternative_templates, showcase_w_rest_async]
+        target: [showcase, showcase_w_rest_async]
         logging_scope: ["", "google"]
 
     # TODO(https://github.com/googleapis/gapic-generator-python/issues/2303): use `ubuntu-latest` once this bug is fixed.
@@ -102,7 +102,7 @@ jobs:
     if: ${{ false }}            # TODO(dovs): reenable when #1218 is fixed
     strategy:
       matrix:
-        target: [showcase_mtls, showcase_mtls_alternative_templates]
+        target: [showcase_mtls]
       max-parallel: 1
     runs-on: ubuntu-latest
     steps:

CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 
 
+## [1.24.1](https://github.com/googleapis/gapic-generator-python/compare/v1.24.0...v1.24.1) (2025-04-17)
+
+
+### Bug Fixes
+
+* Update generated docs to match synthtool templates ([3f62f31](https://github.com/googleapis/gapic-generator-python/commit/3f62f31d5146147c4bc6393fbeef18ce1d9a1a42))
+
+## [1.24.0](https://github.com/googleapis/gapic-generator-python/compare/v1.23.6...v1.24.0) (2025-04-11)
+
+
+### Features
+
+* Adds augmented pagination to account for BQ family of APIs ([#2372](https://github.com/googleapis/gapic-generator-python/issues/2372)) ([30cd1a4](https://github.com/googleapis/gapic-generator-python/commit/30cd1a49353048fc190114cfb7a73e14ec2eff31))
+
+
+### Bug Fixes
+
+* Fixed internal method generation naming issues ([#2365](https://github.com/googleapis/gapic-generator-python/issues/2365)) ([868f201](https://github.com/googleapis/gapic-generator-python/commit/868f201957b271c9390bf41374897a2ce728a5e2))
+* Missing DEFAULT_HOST should still result in compiling code ([#2051](https://github.com/googleapis/gapic-generator-python/issues/2051)) ([dc6d4f7](https://github.com/googleapis/gapic-generator-python/commit/dc6d4f7ec0853557bb7c25a8276fbe262c5bda5d))
+
 ## [1.23.6](https://github.com/googleapis/gapic-generator-python/compare/v1.23.5...v1.23.6) (2025-03-17)
 
 

docs/conf.py

@@ -40,7 +40,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+needs_sphinx = "4.5.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

gapic/ads-templates/docs/conf.py.j2

@@ -28,7 +28,7 @@ __version__ = "0.1.0"
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "4.0.1"
+needs_sphinx = "4.5.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

gapic/schema/wrappers.py

@@ -1830,13 +1830,34 @@ def ident(self) -> metadata.Address:
         """Return the identifier data to be used in templates."""
         return self.meta.address
 
+    def _validate_paged_field_size_type(self, page_field_size) -> bool:
+        """Validates allowed paged_field_size type(s).
+
+        Confirms whether the paged_field_size.type is an allowed wrapper type:
+        The norm is for type to be int, but an additional check is included to
+        account for BigQuery legacy APIs which allowed UInt32Value and
+        Int32Value.
+        """
+
+        pb_type = page_field_size.type
+
+        return pb_type == int or (
+            isinstance(pb_type, MessageType)
+            and pb_type.message_pb.name in {"UInt32Value", "Int32Value"}
+        )
+
     @utils.cached_property
     def paged_result_field(self) -> Optional[Field]:
-        """Return the response pagination field if the method is paginated."""
-        # If the request field lacks any of the expected pagination fields,
-        # then the method is not paginated.
+        """Return the response pagination field if the method is paginated.
+
+        The request field must have a page_token field and a page_size field (or
+        for legacy APIs, a max_results field) and the response field
+        must have a next_token_field and a repeated field.
+
+        For the purposes of supporting legacy APIs, additional wrapper types are
+        allowed.
+        """
 
-        # The request must have page_token and next_page_token as they keep track of pages
         for source, source_type, name in (
             (self.input, str, "page_token"),
             (self.output, str, "next_page_token"),
@@ -1845,13 +1866,18 @@ def paged_result_field(self) -> Optional[Field]:
             if not field or field.type != source_type:
                 return None
 
-        # The request must have max_results or page_size
+        # The request must have page_size (or max_results if legacy API)
         page_fields = (
             self.input.fields.get("max_results", None),
             self.input.fields.get("page_size", None),
         )
         page_field_size = next((field for field in page_fields if field), None)
-        if not page_field_size or page_field_size.type != int:
+
+        if not page_field_size:
+            return None
+
+        # Confirm whether the paged_field_size is an allowed type.
+        if not self._validate_paged_field_size_type(page_field_size=page_field_size):
             return None
 
         # Return the first repeated field.

gapic/templates/%namespace/%name_%version/%sub/services/%service/_shared_macros.j2

@@ -264,6 +264,42 @@ def _get_http_options():
 {% endmacro %}
 
 
+{% macro unary_request_interceptor_common(service) %}
+        logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG)
+        if logging_enabled:  # pragma: NO COVER
+            request_metadata = client_call_details.metadata
+            if isinstance(request, proto.Message):
+                {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2293): Investigate if we can improve this logic
+                    or wait for next gen protobuf.
+                #}
+                request_payload = type(request).to_json(request)
+            elif isinstance(request, google.protobuf.message.Message):
+                request_payload = MessageToJson(request)
+            else:
+                request_payload = f"{type(request).__name__}: {pickle.dumps(request)}"
+
+            request_metadata = {
+                key: value.decode("utf-8") if isinstance(value, bytes) else value
+                for key, value in request_metadata
+            }
+            grpc_request = {
+                "payload": request_payload,
+                "requestMethod": "grpc",
+                "metadata": dict(request_metadata),
+            }
+            _LOGGER.debug(
+                f"Sending request for {client_call_details.method}",
+                extra = {
+                    "serviceName": "{{ service.meta.address.proto }}",
+                    "rpcName": str(client_call_details.method),
+                    "request": grpc_request,
+                    {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2275): logging `metadata` seems repetitive and may need to be cleaned up. We're including it within "request" for consistency with REST transport. #}
+                    "metadata": grpc_request["metadata"],
+                },
+            )
+{%- endmacro %}
+
+
 {% macro prep_wrapped_messages_async_method(api, service) %}
 def _prep_wrapped_messages(self, client_info):
     """ Precompute the wrapped methods, overriding the base class method to use async wrappers."""

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2

@@ -65,7 +65,7 @@ class {{ service.name }}Transport(abc.ABC):
         {% endfor %}
     )
 
-    DEFAULT_HOST: str = {% if service.host %}'{{ service.host }}'{% else %}{{ '' }}{% endif %}
+    DEFAULT_HOST: str = '{% if service.host %}{{ service.host }}{% endif %}'
 
     def __init__(
             self, *,

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2

@@ -1,5 +1,7 @@
 {% extends '_base.py.j2' %}
 
+{% import "%namespace/%name_%version/%sub/services/%service/_shared_macros.j2" as shared_macros %}
+
 {% block content %}
 
 import json
@@ -59,39 +61,7 @@ _LOGGER = std_logging.getLogger(__name__)
 
 class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor):  # pragma: NO COVER
     def intercept_unary_unary(self, continuation, client_call_details, request):
-        logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG)
-        if logging_enabled:  # pragma: NO COVER
-            request_metadata = client_call_details.metadata
-            if isinstance(request, proto.Message):
-                {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2293): Investigate if we can improve this logic
-                    or wait for next gen protobuf.
-                #}
-                request_payload = type(request).to_json(request)
-            elif isinstance(request, google.protobuf.message.Message):
-                request_payload = MessageToJson(request)
-            else:
-                request_payload = f"{type(request).__name__}: {pickle.dumps(request)}"
-
-            request_metadata = {
-                key: value.decode("utf-8") if isinstance(value, bytes) else value
-                for key, value in request_metadata
-            }
-            grpc_request = {
-                "payload": request_payload,
-                "requestMethod": "grpc",
-                "metadata": dict(request_metadata),
-            }
-            _LOGGER.debug(
-                f"Sending request for {client_call_details.method}",
-                extra = {
-                    "serviceName": "{{ service.meta.address.proto }}",
-                    "rpcName": client_call_details.method,
-                    "request": grpc_request,
-                    {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2275): logging `metadata` seems repetitive and may need to be cleaned up. We're including it within "request" for consistency with REST transport. #}
-                    "metadata": grpc_request["metadata"],
-                },
-            )
-
+{{ shared_macros.unary_request_interceptor_common(service) }}
         response = continuation(client_call_details, request)
         if logging_enabled:  # pragma: NO COVER
             response_metadata = response.trailing_metadata()

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2

@@ -1,5 +1,7 @@
 {% extends '_base.py.j2' %}
 
+{% import "%namespace/%name_%version/%sub/services/%service/_shared_macros.j2" as shared_macros %}
+
 {% block content %}
 {% import "%namespace/%name_%version/%sub/services/%service/_shared_macros.j2" as shared_macros %}
 
@@ -64,38 +66,7 @@ _LOGGER = std_logging.getLogger(__name__)
 
 class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor):  # pragma: NO COVER
     async def intercept_unary_unary(self, continuation, client_call_details, request):
-        logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG)
-        if logging_enabled:  # pragma: NO COVER
-            request_metadata = client_call_details.metadata
-            if isinstance(request, proto.Message):
-                {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2293): Investigate if we can improve this logic
-                    or wait for next gen protobuf.
-                #}
-                request_payload = type(request).to_json(request)
-            elif isinstance(request, google.protobuf.message.Message):
-                request_payload = MessageToJson(request)
-            else:
-                request_payload = f"{type(request).__name__}: {pickle.dumps(request)}"
-
-            request_metadata = {
-                key: value.decode("utf-8") if isinstance(value, bytes) else value
-                for key, value in request_metadata
-            }
-            grpc_request = {
-                "payload": request_payload,
-                "requestMethod": "grpc",
-                "metadata": dict(request_metadata),
-            }
-            _LOGGER.debug(
-                f"Sending request for {client_call_details.method}",
-                extra = {
-                    "serviceName": "{{ service.meta.address.proto }}",
-                    "rpcName": str(client_call_details.method),
-                    "request": grpc_request,
-                    {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2275): logging `metadata` seems repetitive and may need to be cleaned up. We're including it within "request" for consistency with REST transport.' #}
-                    "metadata": grpc_request["metadata"],
-                },
-            )
+{{ shared_macros.unary_request_interceptor_common(service) }}
         response = await continuation(client_call_details, request)
         if logging_enabled:  # pragma: NO COVER
             response_metadata = await response.trailing_metadata()