Skip to content

feat: Add protobuf runtime version to x-goog-api-client header #2368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged

feat: Add protobuf runtime version to x-goog-api-client header #2368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc58f1f
tests: exclude google-auth 2.40.0 which breaks async rest
parthea May 6, 2025
88efc0e
feat: Add protobuf runtime version to x-goog-api-client header
parthea Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ from google.api_core import gapic_v1
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

{{ shared_macros.add_google_api_core_version_header_import(service.version) }}
try:
Expand Down Expand Up @@ -726,6 +727,9 @@ class {{ service.async_client_name }}:

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"{{ service.async_client_name }}",
Expand Down
3 changes: 3 additions & 0 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ from google.auth.transport import mtls # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf
{{ shared_macros.add_google_api_core_version_header_import(service.version) }}
try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
Expand Down Expand Up @@ -991,6 +992,8 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

__all__ = (
"{{ service.client_name }}",
Expand Down
4 changes: 4 additions & 0 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ from google.api_core import operations_v1
{% endif %}
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

{% filter sort_lines %}
{% set import_ns = namespace(has_operations_mixin=false) %}
Expand Down Expand Up @@ -51,6 +52,9 @@ from {{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + ser

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class {{ service.name }}Transport(abc.ABC):
"""Abstract transport class for {{ service.name }}."""
Expand Down
4 changes: 4 additions & 0 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/rest.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ from google.api_core import retry as retries
from google.api_core import rest_helpers
from google.api_core import rest_streaming
from google.api_core import gapic_v1
import google.protobuf

from google.protobuf import json_format
{% if service.has_lro %}
Expand Down Expand Up @@ -55,6 +56,9 @@ DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
rest_version=f"requests@{requests_version}",
)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


{{ shared_macros.create_interceptor_class(api, service, method, is_async=False) }}

Expand Down
5 changes: 4 additions & 1 deletion .../templates/%namespace/%name_%version/%sub/services/%service/transports/rest_asyncio.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ from google.cloud.location import locations_pb2 # type: ignore
from google.api_core import retry_async as retries
from google.api_core import rest_helpers
from google.api_core import rest_streaming_async # type: ignore

import google.protobuf

from google.protobuf import json_format
{% if service.has_lro %}
Expand Down Expand Up @@ -80,6 +80,9 @@ DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
rest_version=f"google-auth@{google.auth.__version__}",
)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

{{ shared_macros.create_interceptor_class(api, service, method, is_async=True) }}

@dataclasses.dataclass
Expand Down
8 changes: 8 additions & 0 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,14 @@ def showcase_library(
"-r",
constraints_path,
)
# Exclude `google-auth==2.40.0` which contains a regression
# https://github.com/googleapis/gapic-generator-python/issues/2385
session.install(
"--no-cache-dir",
"--force-reinstall",
"--upgrade",
"google-auth[aiohttp]!=2.40.0",
)
else:
# The ads templates do not have constraints files.
# See https://github.com/googleapis/gapic-generator-python/issues/1788
Expand Down
4 changes: 4 additions & 0 deletions tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf


try:
Expand Down Expand Up @@ -3213,6 +3214,9 @@ async def __aexit__(self, exc_type, exc, tb):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"AssetServiceAsyncClient",
Expand Down
3 changes: 3 additions & 0 deletions tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
Expand Down Expand Up @@ -3619,6 +3620,8 @@ def get_operation(

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

__all__ = (
"AssetServiceClient",
Expand Down
4 changes: 4 additions & 0 deletions ...integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,17 @@
from google.api_core import operations_v1
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

from google.cloud.asset_v1.types import asset_service
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class AssetServiceTransport(abc.ABC):
"""Abstract transport class for AssetService."""
Expand Down
4 changes: 4 additions & 0 deletions ...integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from google.api_core import rest_helpers
from google.api_core import rest_streaming
from google.api_core import gapic_v1
import google.protobuf

from google.protobuf import json_format
from google.api_core import operations_v1
Expand Down Expand Up @@ -60,6 +61,9 @@
rest_version=f"requests@{requests_version}",
)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class AssetServiceRestInterceptor:
"""Interceptor for AssetService.
Expand Down
4 changes: 4 additions & 0 deletions ...on/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf


try:
Expand Down Expand Up @@ -857,6 +858,9 @@ async def __aexit__(self, exc_type, exc, tb):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"IAMCredentialsAsyncClient",
Expand Down
3 changes: 3 additions & 0 deletions ...egration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
Expand Down Expand Up @@ -1215,6 +1216,8 @@ def __exit__(self, type, value, traceback):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

__all__ = (
"IAMCredentialsClient",
Expand Down
4 changes: 4 additions & 0 deletions ...goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,15 @@
from google.api_core import retry as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

from google.iam.credentials_v1.types import common

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class IAMCredentialsTransport(abc.ABC):
"""Abstract transport class for IAMCredentials."""
Expand Down
4 changes: 4 additions & 0 deletions ...goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from google.api_core import rest_helpers
from google.api_core import rest_streaming
from google.api_core import gapic_v1
import google.protobuf

from google.protobuf import json_format

Expand Down Expand Up @@ -57,6 +58,9 @@
rest_version=f"requests@{requests_version}",
)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class IAMCredentialsRestInterceptor:
"""Interceptor for IAMCredentials.
Expand Down
4 changes: 4 additions & 0 deletions ...s/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf


try:
Expand Down Expand Up @@ -3160,6 +3161,9 @@ async def __aexit__(self, exc_type, exc, tb):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"EventarcAsyncClient",
Expand Down
3 changes: 3 additions & 0 deletions tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
Expand Down Expand Up @@ -3608,6 +3609,8 @@ def list_locations(

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

__all__ = (
"EventarcClient",
Expand Down
4 changes: 4 additions & 0 deletions ...ntegration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import operations_v1
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

from google.cloud.eventarc_v1.types import channel
from google.cloud.eventarc_v1.types import channel_connection
Expand All @@ -41,6 +42,9 @@

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class EventarcTransport(abc.ABC):
"""Abstract transport class for Eventarc."""
Expand Down
4 changes: 4 additions & 0 deletions ...ntegration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from google.api_core import rest_helpers
from google.api_core import rest_streaming
from google.api_core import gapic_v1
import google.protobuf

from google.protobuf import json_format
from google.api_core import operations_v1
Expand Down Expand Up @@ -68,6 +69,9 @@
rest_version=f"requests@{requests_version}",
)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class EventarcRestInterceptor:
"""Interceptor for Eventarc.
Expand Down
4 changes: 4 additions & 0 deletions ...ration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf


try:
Expand Down Expand Up @@ -4058,6 +4059,9 @@ async def __aexit__(self, exc_type, exc, tb):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"ConfigServiceV2AsyncClient",
Expand Down
3 changes: 3 additions & 0 deletions .../integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.auth.exceptions import MutualTLSChannelError # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
Expand Down Expand Up @@ -4462,6 +4463,8 @@ def cancel_operation(

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

__all__ = (
"ConfigServiceV2Client",
Expand Down
4 changes: 4 additions & 0 deletions ...ion/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,17 @@
from google.api_core import operations_v1
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf

from google.cloud.logging_v2.types import logging_config
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


class ConfigServiceV2Transport(abc.ABC):
"""Abstract transport class for ConfigServiceV2."""
Expand Down
4 changes: 4 additions & 0 deletions ...ation/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from google.api_core import retry_async as retries
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
import google.protobuf


try:
Expand Down Expand Up @@ -1173,6 +1174,9 @@ async def __aexit__(self, exc_type, exc, tb):

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)

if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__


__all__ = (
"LoggingServiceV2AsyncClient",
Expand Down
Loading
Loading