Skip to content

chore: refactor wrap method helper into a macro #2111

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 6 commits into from
Aug 30, 2024
Merged

chore: refactor wrap method helper into a macro #2111

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
af98897
chore: refactor wrapping method helper into a macro
ohmayr Aug 28, 2024
9de0df3
remove unused property
ohmayr Aug 28, 2024
c108f07
address PR comments
ohmayr Aug 29, 2024
d3ff02c
update assets
ohmayr Aug 29, 2024
65f8411
address PR comments
ohmayr Aug 29, 2024
3f50eeb
Merge branch 'main' into refactor-wrap-method-macro
ohmayr Aug 30, 2024
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: 5 additions & 3 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/_shared_macros.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def _prep_wrapped_messages(self, client_info):
""" Precompute the wrapped methods, overriding the base class method to use async wrappers."""
self._wrapped_methods = {
{% for method in service.methods.values() %}
self.{{ method.transport_safe_name|snake_case }}: self._wrap_method_with_kind(
self.{{ method.transport_safe_name|snake_case }}: self._wrap_method(
self.{{ method.transport_safe_name|snake_case }},
{% if method.retry %}
default_retry=retries.AsyncRetry(
Expand Down Expand Up @@ -194,10 +194,12 @@ def _prep_wrapped_messages(self, client_info):
}
{% endmacro %}

{# TODO: This helper logic to check if `kind` needs to be configured in wrap_method
can be removed once we required the correct version of the google-api-core dependency. #}
{% macro wrap_method_macro() %}
def _wrap_method_with_kind(self, func, *args, **kwargs):
def _wrap_method(self, func, *args, **kwargs):
{# TODO: Remove `pragma: NO COVER` once https://github.com/googleapis/python-api-core/pull/688 is merged. #}
if "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters: # pragma: NO COVER
if self._wrap_with_kind: # pragma: NO COVER
kwargs["kind"] = self.kind
return gapic_v1.method_async.wrap_method(func, *args, **kwargs)
{% endmacro %}
1 change: 1 addition & 0 deletions .../templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport):
)

# Wrap messages. This must be done after self._grpc_channel exists
self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters
self._prep_wrapped_messages(client_info)

@property
Expand Down
51 changes: 26 additions & 25 deletions ...ion/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ def __init__(self, *,
)

# Wrap messages. This must be done after self._grpc_channel exists
self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters
self._prep_wrapped_messages(client_info)

@property
Expand Down Expand Up @@ -942,17 +943,17 @@ def analyze_org_policy_governed_assets(self) -> Callable[
def _prep_wrapped_messages(self, client_info):
""" Precompute the wrapped methods, overriding the base class method to use async wrappers."""
self._wrapped_methods = {
self.export_assets: self._wrap_method_with_kind(
self.export_assets: self._wrap_method(
self.export_assets,
default_timeout=60.0,
client_info=client_info,
),
self.list_assets: self._wrap_method_with_kind(
self.list_assets: self._wrap_method(
self.list_assets,
default_timeout=None,
client_info=client_info,
),
self.batch_get_assets_history: self._wrap_method_with_kind(
self.batch_get_assets_history: self._wrap_method(
self.batch_get_assets_history,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -967,12 +968,12 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.create_feed: self._wrap_method_with_kind(
self.create_feed: self._wrap_method(
self.create_feed,
default_timeout=60.0,
client_info=client_info,
),
self.get_feed: self._wrap_method_with_kind(
self.get_feed: self._wrap_method(
self.get_feed,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -987,7 +988,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.list_feeds: self._wrap_method_with_kind(
self.list_feeds: self._wrap_method(
self.list_feeds,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -1002,12 +1003,12 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.update_feed: self._wrap_method_with_kind(
self.update_feed: self._wrap_method(
self.update_feed,
default_timeout=60.0,
client_info=client_info,
),
self.delete_feed: self._wrap_method_with_kind(
self.delete_feed: self._wrap_method(
self.delete_feed,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -1022,7 +1023,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.search_all_resources: self._wrap_method_with_kind(
self.search_all_resources: self._wrap_method(
self.search_all_resources,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -1037,7 +1038,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=15.0,
client_info=client_info,
),
self.search_all_iam_policies: self._wrap_method_with_kind(
self.search_all_iam_policies: self._wrap_method(
self.search_all_iam_policies,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -1052,7 +1053,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=15.0,
client_info=client_info,
),
self.analyze_iam_policy: self._wrap_method_with_kind(
self.analyze_iam_policy: self._wrap_method(
self.analyze_iam_policy,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -1066,70 +1067,70 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=300.0,
client_info=client_info,
),
self.analyze_iam_policy_longrunning: self._wrap_method_with_kind(
self.analyze_iam_policy_longrunning: self._wrap_method(
self.analyze_iam_policy_longrunning,
default_timeout=60.0,
client_info=client_info,
),
self.analyze_move: self._wrap_method_with_kind(
self.analyze_move: self._wrap_method(
self.analyze_move,
default_timeout=None,
client_info=client_info,
),
self.query_assets: self._wrap_method_with_kind(
self.query_assets: self._wrap_method(
self.query_assets,
default_timeout=None,
client_info=client_info,
),
self.create_saved_query: self._wrap_method_with_kind(
self.create_saved_query: self._wrap_method(
self.create_saved_query,
default_timeout=None,
client_info=client_info,
),
self.get_saved_query: self._wrap_method_with_kind(
self.get_saved_query: self._wrap_method(
self.get_saved_query,
default_timeout=None,
client_info=client_info,
),
self.list_saved_queries: self._wrap_method_with_kind(
self.list_saved_queries: self._wrap_method(
self.list_saved_queries,
default_timeout=None,
client_info=client_info,
),
self.update_saved_query: self._wrap_method_with_kind(
self.update_saved_query: self._wrap_method(
self.update_saved_query,
default_timeout=None,
client_info=client_info,
),
self.delete_saved_query: self._wrap_method_with_kind(
self.delete_saved_query: self._wrap_method(
self.delete_saved_query,
default_timeout=None,
client_info=client_info,
),
self.batch_get_effective_iam_policies: self._wrap_method_with_kind(
self.batch_get_effective_iam_policies: self._wrap_method(
self.batch_get_effective_iam_policies,
default_timeout=None,
client_info=client_info,
),
self.analyze_org_policies: self._wrap_method_with_kind(
self.analyze_org_policies: self._wrap_method(
self.analyze_org_policies,
default_timeout=None,
client_info=client_info,
),
self.analyze_org_policy_governed_containers: self._wrap_method_with_kind(
self.analyze_org_policy_governed_containers: self._wrap_method(
self.analyze_org_policy_governed_containers,
default_timeout=None,
client_info=client_info,
),
self.analyze_org_policy_governed_assets: self._wrap_method_with_kind(
self.analyze_org_policy_governed_assets: self._wrap_method(
self.analyze_org_policy_governed_assets,
default_timeout=None,
client_info=client_info,
),
}

def _wrap_method_with_kind(self, func, *args, **kwargs):
if "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters: # pragma: NO COVER
def _wrap_method(self, func, *args, **kwargs):
if self._wrap_with_kind: # pragma: NO COVER
kwargs["kind"] = self.kind
return gapic_v1.method_async.wrap_method(func, *args, **kwargs)

Expand Down
13 changes: 7 additions & 6 deletions ...credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ def __init__(self, *,
)

# Wrap messages. This must be done after self._grpc_channel exists
self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters
self._prep_wrapped_messages(client_info)

@property
Expand Down Expand Up @@ -356,7 +357,7 @@ def sign_jwt(self) -> Callable[
def _prep_wrapped_messages(self, client_info):
""" Precompute the wrapped methods, overriding the base class method to use async wrappers."""
self._wrapped_methods = {
self.generate_access_token: self._wrap_method_with_kind(
self.generate_access_token: self._wrap_method(
self.generate_access_token,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -371,7 +372,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.generate_id_token: self._wrap_method_with_kind(
self.generate_id_token: self._wrap_method(
self.generate_id_token,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -386,7 +387,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.sign_blob: self._wrap_method_with_kind(
self.sign_blob: self._wrap_method(
self.sign_blob,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -401,7 +402,7 @@ def _prep_wrapped_messages(self, client_info):
default_timeout=60.0,
client_info=client_info,
),
self.sign_jwt: self._wrap_method_with_kind(
self.sign_jwt: self._wrap_method(
self.sign_jwt,
default_retry=retries.AsyncRetry(
initial=0.1,
Expand All @@ -418,8 +419,8 @@ def _prep_wrapped_messages(self, client_info):
),
}

def _wrap_method_with_kind(self, func, *args, **kwargs):
if "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters: # pragma: NO COVER
def _wrap_method(self, func, *args, **kwargs):
if self._wrap_with_kind: # pragma: NO COVER
kwargs["kind"] = self.kind
return gapic_v1.method_async.wrap_method(func, *args, **kwargs)

Expand Down
41 changes: 21 additions & 20 deletions ...on/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ def __init__(self, *,
)

# Wrap messages. This must be done after self._grpc_channel exists
self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters
self._prep_wrapped_messages(client_info)

@property
Expand Down Expand Up @@ -740,100 +741,100 @@ def update_google_channel_config(self) -> Callable[
def _prep_wrapped_messages(self, client_info):
""" Precompute the wrapped methods, overriding the base class method to use async wrappers."""
self._wrapped_methods = {
self.get_trigger: self._wrap_method_with_kind(
self.get_trigger: self._wrap_method(
self.get_trigger,
default_timeout=None,
client_info=client_info,
),
self.list_triggers: self._wrap_method_with_kind(
self.list_triggers: self._wrap_method(
self.list_triggers,
default_timeout=None,
client_info=client_info,
),
self.create_trigger: self._wrap_method_with_kind(
self.create_trigger: self._wrap_method(
self.create_trigger,
default_timeout=None,
client_info=client_info,
),
self.update_trigger: self._wrap_method_with_kind(
self.update_trigger: self._wrap_method(
self.update_trigger,
default_timeout=None,
client_info=client_info,
),
self.delete_trigger: self._wrap_method_with_kind(
self.delete_trigger: self._wrap_method(
self.delete_trigger,
default_timeout=None,
client_info=client_info,
),
self.get_channel: self._wrap_method_with_kind(
self.get_channel: self._wrap_method(
self.get_channel,
default_timeout=None,
client_info=client_info,
),
self.list_channels: self._wrap_method_with_kind(
self.list_channels: self._wrap_method(
self.list_channels,
default_timeout=None,
client_info=client_info,
),
self.create_channel_: self._wrap_method_with_kind(
self.create_channel_: self._wrap_method(
self.create_channel_,
default_timeout=None,
client_info=client_info,
),
self.update_channel: self._wrap_method_with_kind(
self.update_channel: self._wrap_method(
self.update_channel,
default_timeout=None,
client_info=client_info,
),
self.delete_channel: self._wrap_method_with_kind(
self.delete_channel: self._wrap_method(
self.delete_channel,
default_timeout=None,
client_info=client_info,
),
self.get_provider: self._wrap_method_with_kind(
self.get_provider: self._wrap_method(
self.get_provider,
default_timeout=None,
client_info=client_info,
),
self.list_providers: self._wrap_method_with_kind(
self.list_providers: self._wrap_method(
self.list_providers,
default_timeout=None,
client_info=client_info,
),
self.get_channel_connection: self._wrap_method_with_kind(
self.get_channel_connection: self._wrap_method(
self.get_channel_connection,
default_timeout=None,
client_info=client_info,
),
self.list_channel_connections: self._wrap_method_with_kind(
self.list_channel_connections: self._wrap_method(
self.list_channel_connections,
default_timeout=None,
client_info=client_info,
),
self.create_channel_connection: self._wrap_method_with_kind(
self.create_channel_connection: self._wrap_method(
self.create_channel_connection,
default_timeout=None,
client_info=client_info,
),
self.delete_channel_connection: self._wrap_method_with_kind(
self.delete_channel_connection: self._wrap_method(
self.delete_channel_connection,
default_timeout=None,
client_info=client_info,
),
self.get_google_channel_config: self._wrap_method_with_kind(
self.get_google_channel_config: self._wrap_method(
self.get_google_channel_config,
default_timeout=None,
client_info=client_info,
),
self.update_google_channel_config: self._wrap_method_with_kind(
self.update_google_channel_config: self._wrap_method(
self.update_google_channel_config,
default_timeout=None,
client_info=client_info,
),
}

def _wrap_method_with_kind(self, func, *args, **kwargs):
if "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters: # pragma: NO COVER
def _wrap_method(self, func, *args, **kwargs):
if self._wrap_with_kind: # pragma: NO COVER
kwargs["kind"] = self.kind
return gapic_v1.method_async.wrap_method(func, *args, **kwargs)

Expand Down
Loading