Skip to content

fix(pubsub): preserve publisher method type annotations #18106

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

Draft
ishaangandhi wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −13
Draft

fix(pubsub): preserve publisher method type annotations #18106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions packages/google-cloud-pubsub/google/pubsub_v1/services/publisher/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import re
from collections import OrderedDict
from typing import (
Any,
Callable,
Dict,
Mapping,
Expand All @@ -39,10 +40,7 @@

from google.pubsub_v1 import gapic_version as package_version

try:
OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore
OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]

@parthea parthea Aug 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for looking into cleaning up these type annotations!

You're right that with "google-api-core[grpc] >= 2.25.0, <3.0.0", gapic_v1.method._MethodDefault is guaranteed to exist at runtime, making the try/except AttributeError fallback obsolete here.

However, because the files under google/pubsub_v1/ are automatically generated, manual edits will be overwritten during the next generator run and will introduce drift from the other generated client services (like subscriber/client.py).

Would you be open to proposing this change upstream in the generator templates instead ?

You can update the Jinja template directly here:

google-cloud-python/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2

Lines 45 to 48 in 3ba7d02

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.Retry, object, None] # type: ignore

The PR should only include changes to packages/gapic-generator because the generator fix must first be merged and released to PyPI before downstream packages like google-cloud-pubsub can be regenerated with the updated version.


import google.protobuf.duration_pb2 as duration_pb2 # type: ignore
import google.protobuf.field_mask_pb2 as field_mask_pb2 # type: ignore
Expand Down Expand Up @@ -552,7 +550,7 @@ async def sample_update_topic():

async def publish(
self,
request: Optional[Union[pubsub.PublishRequest, dict]] = None,
request: Optional[Union[pubsub.PublishRequest, Dict[str, Any]]] = None,
*,
topic: Optional[str] = None,
messages: Optional[MutableSequence[pubsub.PubsubMessage]] = None,
Expand Down
8 changes: 3 additions & 5 deletions packages/google-cloud-pubsub/google/pubsub_v1/services/publisher/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from collections import OrderedDict
from http import HTTPStatus
from typing import (
Any,
Callable,
Dict,
Mapping,
Expand Down Expand Up @@ -49,10 +50,7 @@

from google.pubsub_v1 import gapic_version as package_version

try:
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.Retry, object, None] # type: ignore
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]

try:
from google.api_core import client_logging # type: ignore
Expand Down Expand Up @@ -1062,7 +1060,7 @@ def sample_update_topic():

def publish(
self,
request: Optional[Union[pubsub.PublishRequest, dict]] = None,
request: Optional[Union[pubsub.PublishRequest, Dict[str, Any]]] = None,
*,
topic: Optional[str] = None,
messages: Optional[MutableSequence[pubsub.PubsubMessage]] = None,
Expand Down
7 changes: 4 additions & 3 deletions packages/google-cloud-pubsub/google/pubsub_v1/types/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
#
from typing import Union

from google.api_core.timeout import ConstantTimeout, ExponentialTimeout

from .pubsub import (
AcknowledgeRequest,
AIInference,
Expand Down Expand Up @@ -91,10 +93,9 @@
)

TimeoutType = Union[
int,
float,
"google.api_core.timeout.ConstantTimeout",
"google.api_core.timeout.ExponentialTimeout",
ConstantTimeout,
ExponentialTimeout,
Comment thread
ishaangandhi marked this conversation as resolved.
]
"""The type of the timeout parameter of publisher client methods."""

Expand Down
Loading