Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 49205d9

Browse files
authored
fix: add 'dict' type annotation to 'request' (#966)
* fix: add 'dict' type annotation to request * Update client.py.j2
1 parent f14ceba commit 49205d9

File tree

8 files changed

+120
-120
lines changed
  • gapic
    • ads-templates/%namespace/%name/%version/%sub/services/%service
    • templates/%namespace/%name_%version/%sub/services/%service
  • tests/integration/goldens
    • asset/google/cloud/asset_v1/services/asset_service
    • credentials/google/iam/credentials_v1/services/iam_credentials
    • logging/google/cloud/logging_v2/services
    • redis/google/cloud/redis_v1/services/cloud_redis

8 files changed

+120
-120
lines changed

gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/client.py.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
285285
{% for method in service.methods.values() %}
286286
def {{ method.name|snake_case }}(self,
287287
{% if not method.client_streaming %}
288-
request: {{ method.input.ident }} = None,
288+
request: Union[{{ method.input.ident }}, dict] = None,
289289
*,
290290
{% for field in method.flattened_fields.values() %}
291291
{{ field.name }}: {{ field.ident }} = None,
@@ -306,7 +306,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
306306

307307
Args:
308308
{% if not method.client_streaming %}
309-
request (:class:`{{ method.input.ident.sphinx }}`):
309+
request (Union[{{ method.input.ident.sphinx }}, dict]):
310310
The request object.{{ ' ' }}
311311
{{- method.input.meta.doc|wrap(width=72, offset=36, indent=16) }}
312312
{% for key, field in method.flattened_fields.items() %}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
316316
{% for method in service.methods.values() %}
317317
def {{ method.name|snake_case }}(self,
318318
{% if not method.client_streaming %}
319-
request: {{ method.input.ident }} = None,
319+
request: Union[{{ method.input.ident }}, dict] = None,
320320
*,
321321
{% for field in method.flattened_fields.values() %}
322322
{{ field.name }}: {{ field.ident }} = None,
@@ -337,7 +337,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
337337

338338
Args:
339339
{% if not method.client_streaming %}
340-
request ({{ method.input.ident.sphinx }}):
340+
request (Union[{{ method.input.ident.sphinx }}, dict]):
341341
The request object.{{ " " }}
342342
{{- method.input.meta.doc|wrap(width=72, offset=36, indent=16) }}
343343
{% for key, field in method.flattened_fields.items() %}

tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/client.py

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ def __init__(self, *,
351351
)
352352

353353
def export_assets(self,
354-
request: asset_service.ExportAssetsRequest = None,
354+
request: Union[asset_service.ExportAssetsRequest, dict] = None,
355355
*,
356356
retry: retries.Retry = gapic_v1.method.DEFAULT,
357357
timeout: float = None,
@@ -372,7 +372,7 @@ def export_assets(self,
372372
the export operation usually finishes within 5 minutes.
373373
374374
Args:
375-
request (google.cloud.asset_v1.types.ExportAssetsRequest):
375+
request (Union[google.cloud.asset_v1.types.ExportAssetsRequest, dict]):
376376
The request object. Export asset request.
377377
retry (google.api_core.retry.Retry): Designation of what errors, if any,
378378
should be retried.
@@ -431,7 +431,7 @@ def export_assets(self,
431431
return response
432432

433433
def list_assets(self,
434-
request: asset_service.ListAssetsRequest = None,
434+
request: Union[asset_service.ListAssetsRequest, dict] = None,
435435
*,
436436
parent: str = None,
437437
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -442,7 +442,7 @@ def list_assets(self,
442442
paged results in response.
443443
444444
Args:
445-
request (google.cloud.asset_v1.types.ListAssetsRequest):
445+
request (Union[google.cloud.asset_v1.types.ListAssetsRequest, dict]):
446446
The request object. ListAssets request.
447447
parent (str):
448448
Required. Name of the organization or project the assets
@@ -520,7 +520,7 @@ def list_assets(self,
520520
return response
521521

522522
def batch_get_assets_history(self,
523-
request: asset_service.BatchGetAssetsHistoryRequest = None,
523+
request: Union[asset_service.BatchGetAssetsHistoryRequest, dict] = None,
524524
*,
525525
retry: retries.Retry = gapic_v1.method.DEFAULT,
526526
timeout: float = None,
@@ -535,7 +535,7 @@ def batch_get_assets_history(self,
535535
INVALID_ARGUMENT error.
536536
537537
Args:
538-
request (google.cloud.asset_v1.types.BatchGetAssetsHistoryRequest):
538+
request (Union[google.cloud.asset_v1.types.BatchGetAssetsHistoryRequest, dict]):
539539
The request object. Batch get assets history request.
540540
retry (google.api_core.retry.Retry): Designation of what errors, if any,
541541
should be retried.
@@ -579,7 +579,7 @@ def batch_get_assets_history(self,
579579
return response
580580

581581
def create_feed(self,
582-
request: asset_service.CreateFeedRequest = None,
582+
request: Union[asset_service.CreateFeedRequest, dict] = None,
583583
*,
584584
parent: str = None,
585585
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -591,7 +591,7 @@ def create_feed(self,
591591
updates.
592592
593593
Args:
594-
request (google.cloud.asset_v1.types.CreateFeedRequest):
594+
request (Union[google.cloud.asset_v1.types.CreateFeedRequest, dict]):
595595
The request object. Create asset feed request.
596596
parent (str):
597597
Required. The name of the
@@ -667,7 +667,7 @@ def create_feed(self,
667667
return response
668668

669669
def get_feed(self,
670-
request: asset_service.GetFeedRequest = None,
670+
request: Union[asset_service.GetFeedRequest, dict] = None,
671671
*,
672672
name: str = None,
673673
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -677,7 +677,7 @@ def get_feed(self,
677677
r"""Gets details about an asset feed.
678678
679679
Args:
680-
request (google.cloud.asset_v1.types.GetFeedRequest):
680+
request (Union[google.cloud.asset_v1.types.GetFeedRequest, dict]):
681681
The request object. Get asset feed request.
682682
name (str):
683683
Required. The name of the Feed and it must be in the
@@ -748,7 +748,7 @@ def get_feed(self,
748748
return response
749749

750750
def list_feeds(self,
751-
request: asset_service.ListFeedsRequest = None,
751+
request: Union[asset_service.ListFeedsRequest, dict] = None,
752752
*,
753753
parent: str = None,
754754
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -759,7 +759,7 @@ def list_feeds(self,
759759
project/folder/organization.
760760
761761
Args:
762-
request (google.cloud.asset_v1.types.ListFeedsRequest):
762+
request (Union[google.cloud.asset_v1.types.ListFeedsRequest, dict]):
763763
The request object. List asset feeds request.
764764
parent (str):
765765
Required. The parent
@@ -825,7 +825,7 @@ def list_feeds(self,
825825
return response
826826

827827
def update_feed(self,
828-
request: asset_service.UpdateFeedRequest = None,
828+
request: Union[asset_service.UpdateFeedRequest, dict] = None,
829829
*,
830830
feed: asset_service.Feed = None,
831831
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -835,7 +835,7 @@ def update_feed(self,
835835
r"""Updates an asset feed configuration.
836836
837837
Args:
838-
request (google.cloud.asset_v1.types.UpdateFeedRequest):
838+
request (Union[google.cloud.asset_v1.types.UpdateFeedRequest, dict]):
839839
The request object. Update asset feed request.
840840
feed (google.cloud.asset_v1.types.Feed):
841841
Required. The new values of feed details. It must match
@@ -907,7 +907,7 @@ def update_feed(self,
907907
return response
908908

909909
def delete_feed(self,
910-
request: asset_service.DeleteFeedRequest = None,
910+
request: Union[asset_service.DeleteFeedRequest, dict] = None,
911911
*,
912912
name: str = None,
913913
retry: retries.Retry = gapic_v1.method.DEFAULT,
@@ -917,7 +917,7 @@ def delete_feed(self,
917917
r"""Deletes an asset feed.
918918
919919
Args:
920-
request (google.cloud.asset_v1.types.DeleteFeedRequest):
920+
request (Union[google.cloud.asset_v1.types.DeleteFeedRequest, dict]):
921921
The request object.
922922
name (str):
923923
Required. The name of the feed and it must be in the
@@ -974,7 +974,7 @@ def delete_feed(self,
974974
)
975975

976976
def search_all_resources(self,
977-
request: asset_service.SearchAllResourcesRequest = None,
977+
request: Union[asset_service.SearchAllResourcesRequest, dict] = None,
978978
*,
979979
scope: str = None,
980980
query: str = None,
@@ -989,7 +989,7 @@ def search_all_resources(self,
989989
desired scope, otherwise the request will be rejected.
990990
991991
Args:
992-
request (google.cloud.asset_v1.types.SearchAllResourcesRequest):
992+
request (Union[google.cloud.asset_v1.types.SearchAllResourcesRequest, dict]):
993993
The request object. Search all resources request.
994994
scope (str):
995995
Required. A scope can be a project, a folder, or an
@@ -1154,7 +1154,7 @@ def search_all_resources(self,
11541154
return response
11551155

11561156
def search_all_iam_policies(self,
1157-
request: asset_service.SearchAllIamPoliciesRequest = None,
1157+
request: Union[asset_service.SearchAllIamPoliciesRequest, dict] = None,
11581158
*,
11591159
scope: str = None,
11601160
query: str = None,
@@ -1168,7 +1168,7 @@ def search_all_iam_policies(self,
11681168
desired scope, otherwise the request will be rejected.
11691169
11701170
Args:
1171-
request (google.cloud.asset_v1.types.SearchAllIamPoliciesRequest):
1171+
request (Union[google.cloud.asset_v1.types.SearchAllIamPoliciesRequest, dict]):
11721172
The request object. Search all IAM policies request.
11731173
scope (str):
11741174
Required. A scope can be a project, a folder, or an
@@ -1313,7 +1313,7 @@ def search_all_iam_policies(self,
13131313
return response
13141314

13151315
def analyze_iam_policy(self,
1316-
request: asset_service.AnalyzeIamPolicyRequest = None,
1316+
request: Union[asset_service.AnalyzeIamPolicyRequest, dict] = None,
13171317
*,
13181318
retry: retries.Retry = gapic_v1.method.DEFAULT,
13191319
timeout: float = None,
@@ -1323,7 +1323,7 @@ def analyze_iam_policy(self,
13231323
what accesses on which resources.
13241324
13251325
Args:
1326-
request (google.cloud.asset_v1.types.AnalyzeIamPolicyRequest):
1326+
request (Union[google.cloud.asset_v1.types.AnalyzeIamPolicyRequest, dict]):
13271327
The request object. A request message for
13281328
[AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
13291329
retry (google.api_core.retry.Retry): Designation of what errors, if any,
@@ -1370,7 +1370,7 @@ def analyze_iam_policy(self,
13701370
return response
13711371

13721372
def analyze_iam_policy_longrunning(self,
1373-
request: asset_service.AnalyzeIamPolicyLongrunningRequest = None,
1373+
request: Union[asset_service.AnalyzeIamPolicyLongrunningRequest, dict] = None,
13741374
*,
13751375
retry: retries.Retry = gapic_v1.method.DEFAULT,
13761376
timeout: float = None,
@@ -1390,7 +1390,7 @@ def analyze_iam_policy_longrunning(self,
13901390
to help callers to map responses to requests.
13911391
13921392
Args:
1393-
request (google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningRequest):
1393+
request (Union[google.cloud.asset_v1.types.AnalyzeIamPolicyLongrunningRequest, dict]):
13941394
The request object. A request message for
13951395
[AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
13961396
retry (google.api_core.retry.Retry): Designation of what errors, if any,

tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/client.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ def __init__(self, *,
347347
)
348348

349349
def generate_access_token(self,
350-
request: common.GenerateAccessTokenRequest = None,
350+
request: Union[common.GenerateAccessTokenRequest, dict] = None,
351351
*,
352352
name: str = None,
353353
delegates: Sequence[str] = None,
@@ -361,7 +361,7 @@ def generate_access_token(self,
361361
account.
362362
363363
Args:
364-
request (google.iam.credentials_v1.types.GenerateAccessTokenRequest):
364+
request (Union[google.iam.credentials_v1.types.GenerateAccessTokenRequest, dict]):
365365
The request object.
366366
name (str):
367367
Required. The resource name of the service account for
@@ -473,7 +473,7 @@ def generate_access_token(self,
473473
return response
474474

475475
def generate_id_token(self,
476-
request: common.GenerateIdTokenRequest = None,
476+
request: Union[common.GenerateIdTokenRequest, dict] = None,
477477
*,
478478
name: str = None,
479479
delegates: Sequence[str] = None,
@@ -487,7 +487,7 @@ def generate_id_token(self,
487487
account.
488488
489489
Args:
490-
request (google.iam.credentials_v1.types.GenerateIdTokenRequest):
490+
request (Union[google.iam.credentials_v1.types.GenerateIdTokenRequest, dict]):
491491
The request object.
492492
name (str):
493493
Required. The resource name of the service account for
@@ -593,7 +593,7 @@ def generate_id_token(self,
593593
return response
594594

595595
def sign_blob(self,
596-
request: common.SignBlobRequest = None,
596+
request: Union[common.SignBlobRequest, dict] = None,
597597
*,
598598
name: str = None,
599599
delegates: Sequence[str] = None,
@@ -606,7 +606,7 @@ def sign_blob(self,
606606
private key.
607607
608608
Args:
609-
request (google.iam.credentials_v1.types.SignBlobRequest):
609+
request (Union[google.iam.credentials_v1.types.SignBlobRequest, dict]):
610610
The request object.
611611
name (str):
612612
Required. The resource name of the service account for
@@ -699,7 +699,7 @@ def sign_blob(self,
699699
return response
700700

701701
def sign_jwt(self,
702-
request: common.SignJwtRequest = None,
702+
request: Union[common.SignJwtRequest, dict] = None,
703703
*,
704704
name: str = None,
705705
delegates: Sequence[str] = None,
@@ -712,7 +712,7 @@ def sign_jwt(self,
712712
private key.
713713
714714
Args:
715-
request (google.iam.credentials_v1.types.SignJwtRequest):
715+
request (Union[google.iam.credentials_v1.types.SignJwtRequest, dict]):
716716
The request object.
717717
name (str):
718718
Required. The resource name of the service account for

0 commit comments

Comments
 (0)