feat: add async samples (#861)

googleapis · Jun 11, 2021 · e385ffd · e385ffd
1 parent 25aa8c9
commit e385ffd
Show file tree

Hide file tree

Showing 134 changed files with 3,365 additions and 161 deletions.
diff --git a/gapic/samplegen/samplegen.py b/gapic/samplegen/samplegen.py
@@ -293,7 +293,15 @@ def preprocess_sample(sample, api_schema: api.API, rpc: wrappers.Method):
         sample["module_name"] = api_schema.naming.versioned_module_name
         sample["module_namespace"] = api_schema.naming.module_namespace
 
-        sample["client_name"] = api_schema.services[sample["service"]].client_name
+        # Assume the gRPC transport if the transport is not specified
+        sample.setdefault("transport", api.TRANSPORT_GRPC)
+
+        if sample["transport"] == api.TRANSPORT_GRPC_ASYNC:
+            sample["client_name"] = api_schema.services[sample["service"]
+                                                        ].async_client_name
+        else:
+            sample["client_name"] = api_schema.services[sample["service"]].client_name
+
         # the type of the request object passed to the rpc e.g, `ListRequest`
         sample["request_type"] = rpc.input.ident.name
 
@@ -946,17 +954,16 @@ def generate_sample_specs(api_schema: api.API, *, opts) -> Generator[Dict[str, A
 
     for service_name, service in gapic_metadata.services.items():
         api_short_name = api_schema.services[f"{api_schema.naming.proto_package}.{service_name}"].shortname
-        for transport_type, client in service.clients.items():
-            if transport_type == "grpc-async":
-                # TODO(busunkim): Enable generation of async samples
-                continue
+        for transport, client in service.clients.items():
+            transport_type = "async" if transport == api.TRANSPORT_GRPC_ASYNC else "sync"
             for rpc_name, method_list in client.rpcs.items():
                 # Region Tag Format:
                 # [{START|END} ${apishortname}_generated_${api}_${apiVersion}_${serviceName}_${rpcName}_{sync|async}_${overloadDisambiguation}]
                 region_tag = f"{api_short_name}_generated_{api_schema.naming.versioned_module_name}_{service_name}_{rpc_name}_{transport_type}"
                 spec = {
                     "sample_type": "standalone",
                     "rpc": rpc_name,
+                    "transport": transport,
                     "request": [],
                     # response is populated in `preprocess_sample`
                     "service": f"{api_schema.naming.proto_package}.{service_name}",

diff --git a/gapic/schema/api.py b/gapic/schema/api.py
@@ -45,6 +45,11 @@
 from gapic.utils import RESERVED_NAMES
 
 
+TRANSPORT_GRPC = "grpc"
+TRANSPORT_GRPC_ASYNC = "grpc-async"
+TRANSPORT_REST = "rest"
+
+
 @dataclasses.dataclass(frozen=True)
 class Proto:
     """A representation of a particular proto file within an API."""
@@ -414,11 +419,12 @@ def gapic_metadata(self, options: Options) -> gapic_metadata_pb2.GapicMetadata:
             # This assumes the options are generated by the class method factory.
             transports = []
             if "grpc" in options.transport:
-                transports.append(("grpc", service.client_name))
-                transports.append(("grpc-async", service.async_client_name))
+                transports.append((TRANSPORT_GRPC, service.client_name))
+                transports.append(
+                    (TRANSPORT_GRPC_ASYNC, service.async_client_name))
 
             if "rest" in options.transport:
-                transports.append(("rest", service.client_name))
+                transports.append((TRANSPORT_REST, service.client_name))
 
             methods = sorted(service.methods.values(), key=lambda m: m.name)
             for tprt, client_name in transports:

diff --git a/gapic/templates/examples/feature_fragments.j2 b/gapic/templates/examples/feature_fragments.j2
@@ -202,8 +202,13 @@ request=request
 {% endmacro %}
 
 
-{% macro render_method_call(sample, calling_form, calling_form_enum) %}
+{% macro render_method_call(sample, calling_form, calling_form_enum, transport) %}
 {# Note: this doesn't deal with enums or unions #}
+{# LROs return operation objects and paged requests return pager objects #}
+{% if transport == "grpc-async" and calling_form not in
+[calling_form_enum.LongRunningRequestPromise, calling_form_enum.RequestPagedAll] %}
+await{{ " "}}
+{%- endif -%}
 {% if calling_form in [calling_form_enum.RequestStreamingBidi,
                        calling_form_enum.RequestStreamingClient] %}
 client.{{ sample.rpc|snake_case }}([{{ render_request_params(sample.request.request_list)|trim }}])
@@ -215,7 +220,7 @@ client.{{ sample.rpc|snake_case }}({{ render_request_params_unary(sample.request
 
 {# Setting up the method invocation is the responsibility of the caller: #}
 {# it's just easier to set up client side streaming and other things from outside this macro. #}
-{% macro render_calling_form(method_invocation_text, calling_form, calling_form_enum, response_statements ) %}
+{% macro render_calling_form(method_invocation_text, calling_form, calling_form_enum, transport, response_statements ) %}
 # Make the request
 {% if calling_form == calling_form_enum.Request %}
 response = {{ method_invocation_text|trim }}
@@ -228,21 +233,21 @@ response = {{ method_invocation_text|trim }}
 {% endif %}
 {% elif calling_form == calling_form_enum.RequestPagedAll %}
 page_result = {{ method_invocation_text|trim }}
-for response in page_result:
+{% if transport == "grpc-async" %}async {% endif %}for response in page_result:
   {% for statement in response_statements %}
     {{ dispatch_statement(statement)|trim }}
   {% endfor %}
 {% elif calling_form == calling_form_enum.RequestPaged %}
 page_result = {{ method_invocation_text|trim }}
-for page in page_result.pages():
+{% if transport == "grpc-async" %}async {% endif %}for page in page_result.pages():
     for response in page:
   {% for statement in response_statements %}
         {{ dispatch_statement(statement)|trim }}
   {% endfor %}
 {% elif calling_form in [calling_form_enum.RequestStreamingServer,
                         calling_form_enum.RequestStreamingBidi] %}
 stream = {{ method_invocation_text|trim }}
-for response in stream:
+{% if transport == "grpc-async" %}async {% endif %}for response in stream:
   {% for statement in response_statements %}
     {{ dispatch_statement(statement)|trim }}
   {% endfor %}
@@ -251,7 +256,7 @@ operation = {{ method_invocation_text|trim }}
 
 print("Waiting for operation to complete...")
 
-response = operation.result()
+response = {% if transport == "grpc-async" %}await {% endif %}operation.result()
 {% for statement in response_statements %}
 {{ dispatch_statement(statement)|trim }}
 {% endfor %}

diff --git a/gapic/templates/examples/sample.py.j2 b/gapic/templates/examples/sample.py.j2
@@ -31,13 +31,13 @@ from {{ sample.module_namespace|join(".") }} import {{ sample.module_name }}
 
 
 {# also need calling form #}
-def sample_{{ frags.render_method_name(sample.rpc)|trim }}({{ frags.print_input_params(sample.request)|trim }}):
+{% if sample.transport == "grpc-async" %}async {% endif %}def sample_{{ frags.render_method_name(sample.rpc)|trim }}({{ frags.print_input_params(sample.request)|trim }}):
     """{{ sample.description }}"""
 
     {{ frags.render_client_setup(sample.module_name, sample.client_name)|indent }}
     {{ frags.render_request_setup(sample.request, sample.module_name, sample.request_type)|indent }}
-    {% with method_call = frags.render_method_call(sample, calling_form, calling_form_enum) %}
-    {{ frags.render_calling_form(method_call, calling_form, calling_form_enum, sample.response)|indent -}}
+    {% with method_call = frags.render_method_call(sample, calling_form, calling_form_enum, sample.transport) %}
+    {{ frags.render_calling_form(method_call, calling_form, calling_form_enum, sample.transport, sample.response)|indent -}}
     {% endwith %}
 
 # [END {{ sample.id }}]

diff --git a/...generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_async.py b/...generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_async.py
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Generated code. DO NOT EDIT!
+#
+# Snippet for AnalyzeIamPolicy
+# NOTE: This snippet has been automatically generated for illustrative purposes only.
+# It may require modifications to work in your environment.
+
+# To install the latest published package dependency, execute the following:
+#   python3 -m pip install google-cloud-asset
+
+
+# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_async]
+from google.cloud import asset_v1
+
+
+async def sample_analyze_iam_policy():
+    """Snippet for analyze_iam_policy"""
+
+    # Create a client
+    client = asset_v1.AssetServiceAsyncClient()
+
+    # Initialize request argument(s)
+    request = asset_v1.AnalyzeIamPolicyRequest(
+    )
+
+    # Make the request
+    response = await client.analyze_iam_policy(request=request)
+
+    # Handle response
+    print("{}".format(response))
+
+# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_async]
diff --git a/...mples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_longrunning_async.py b/...mples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_longrunning_async.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Generated code. DO NOT EDIT!
+#
+# Snippet for AnalyzeIamPolicyLongrunning
+# NOTE: This snippet has been automatically generated for illustrative purposes only.
+# It may require modifications to work in your environment.
+
+# To install the latest published package dependency, execute the following:
+#   python3 -m pip install google-cloud-asset
+
+
+# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_async]
+from google.cloud import asset_v1
+
+
+async def sample_analyze_iam_policy_longrunning():
+    """Snippet for analyze_iam_policy_longrunning"""
+
+    # Create a client
+    client = asset_v1.AssetServiceAsyncClient()
+
+    # Initialize request argument(s)
+    request = asset_v1.AnalyzeIamPolicyLongrunningRequest(
+    )
+
+    # Make the request
+    operation = client.analyze_iam_policy_longrunning(request=request)
+
+    print("Waiting for operation to complete...")
+
+    response = await operation.result()
+    print("{}".format(response))
+
+# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_async]
diff --git a/...ce_analyze_iam_policy_longrunning_grpc.py → ...ce_analyze_iam_policy_longrunning_sync.py b/...ce_analyze_iam_policy_longrunning_grpc.py → ...ce_analyze_iam_policy_longrunning_sync.py
@@ -23,7 +23,7 @@
 #   python3 -m pip install google-cloud-asset
 
 
-# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_grpc]
+# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_sync]
 from google.cloud import asset_v1
 
 
@@ -45,4 +45,4 @@ def sample_analyze_iam_policy_longrunning():
     response = operation.result()
     print("{}".format(response))
 
-# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_grpc]
+# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_sync]
diff --git a/..._asset_service_analyze_iam_policy_grpc.py → ..._asset_service_analyze_iam_policy_sync.py b/..._asset_service_analyze_iam_policy_grpc.py → ..._asset_service_analyze_iam_policy_sync.py
@@ -23,7 +23,7 @@
 #   python3 -m pip install google-cloud-asset
 
 
-# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_grpc]
+# [START cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_sync]
 from google.cloud import asset_v1
 
 
@@ -43,4 +43,4 @@ def sample_analyze_iam_policy():
     # Handle response
     print("{}".format(response))
 
-# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_grpc]
+# [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_sync]
diff --git a/...ted_samples/cloudasset_generated_asset_v1_asset_service_batch_get_assets_history_async.py b/...ted_samples/cloudasset_generated_asset_v1_asset_service_batch_get_assets_history_async.py
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Generated code. DO NOT EDIT!
+#
+# Snippet for BatchGetAssetsHistory
+# NOTE: This snippet has been automatically generated for illustrative purposes only.
+# It may require modifications to work in your environment.
+
+# To install the latest published package dependency, execute the following:
+#   python3 -m pip install google-cloud-asset
+
+
+# [START cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_async]
+from google.cloud import asset_v1
+
+
+async def sample_batch_get_assets_history():
+    """Snippet for batch_get_assets_history"""
+
+    # Create a client
+    client = asset_v1.AssetServiceAsyncClient()
+
+    # Initialize request argument(s)
+    request = asset_v1.BatchGetAssetsHistoryRequest(
+    )
+
+    # Make the request
+    response = await client.batch_get_assets_history(request=request)
+
+    # Handle response
+    print("{}".format(response))
+
+# [END cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_async]
diff --git a/..._service_batch_get_assets_history_grpc.py → ..._service_batch_get_assets_history_sync.py b/..._service_batch_get_assets_history_grpc.py → ..._service_batch_get_assets_history_sync.py
@@ -23,7 +23,7 @@
 #   python3 -m pip install google-cloud-asset
 
 
-# [START cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_grpc]
+# [START cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_sync]
 from google.cloud import asset_v1
 
 
@@ -43,4 +43,4 @@ def sample_batch_get_assets_history():
     # Handle response
     print("{}".format(response))
 
-# [END cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_grpc]
+# [END cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_sync]
diff --git a/...amples/generated_samples/cloudasset_generated_asset_v1_asset_service_create_feed_async.py b/...amples/generated_samples/cloudasset_generated_asset_v1_asset_service_create_feed_async.py
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Generated code. DO NOT EDIT!
+#
+# Snippet for CreateFeed
+# NOTE: This snippet has been automatically generated for illustrative purposes only.
+# It may require modifications to work in your environment.
+
+# To install the latest published package dependency, execute the following:
+#   python3 -m pip install google-cloud-asset
+
+
+# [START cloudasset_generated_asset_v1_AssetService_CreateFeed_async]
+from google.cloud import asset_v1
+
+
+async def sample_create_feed():
+    """Snippet for create_feed"""
+
+    # Create a client
+    client = asset_v1.AssetServiceAsyncClient()
+
+    # Initialize request argument(s)
+    request = asset_v1.CreateFeedRequest(
+    )
+
+    # Make the request
+    response = await client.create_feed(request=request)
+
+    # Handle response
+    print("{}".format(response))
+
+# [END cloudasset_generated_asset_v1_AssetService_CreateFeed_async]
diff --git a/...sset_v1_asset_service_create_feed_grpc.py → ...sset_v1_asset_service_create_feed_sync.py b/...sset_v1_asset_service_create_feed_grpc.py → ...sset_v1_asset_service_create_feed_sync.py
@@ -23,7 +23,7 @@
 #   python3 -m pip install google-cloud-asset
 
 
-# [START cloudasset_generated_asset_v1_AssetService_CreateFeed_grpc]
+# [START cloudasset_generated_asset_v1_AssetService_CreateFeed_sync]
 from google.cloud import asset_v1
 
 
@@ -43,4 +43,4 @@ def sample_create_feed():
     # Handle response
     print("{}".format(response))
 
-# [END cloudasset_generated_asset_v1_AssetService_CreateFeed_grpc]
+# [END cloudasset_generated_asset_v1_AssetService_CreateFeed_sync]