chore: add comment for handling the response in generated snippets (googleapis#1193)

Author: parthea

gapic/samplegen_utils/snippet_index.py

@@ -25,7 +25,7 @@
 CLIENT_INIT_RE = re.compile(r"^\s+# Create a client")
 REQUEST_INIT_RE = re.compile(r"^\s+# Initialize request argument\(s\)")
 REQUEST_EXEC_RE = re.compile(r"^\s+# Make the request")
-RESPONSE_HANDLING_RE = re.compile(r"^\s+# Handle response")
+RESPONSE_HANDLING_RE = re.compile(r"^\s+# Handle the response")
 
 
 class Snippet:

gapic/templates/examples/feature_fragments.j2

@@ -249,19 +249,23 @@ client.{{ sample.rpc|snake_case }}({{ render_request_params_unary(sample.request
 response = {{ method_invocation_text|trim }}
 
 {% if response_statements %}
-# Handle response
+# Handle the response
 {% for statement in response_statements %}
 {{ dispatch_statement(statement)|trim }}
 {% endfor %}
 {% endif %}
 {% elif calling_form == calling_form_enum.RequestPagedAll %}
 page_result = {{ method_invocation_text|trim }}
+
+# Handle the response
 {% 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 }}
+
+# Handle the response
 {% if transport == "grpc-async" %}async {% endif %}for page in page_result.pages():
     for response in page:
   {% for statement in response_statements %}
@@ -270,6 +274,8 @@ page_result = {{ method_invocation_text|trim }}
 {% elif calling_form in [calling_form_enum.RequestStreamingServer,
                         calling_form_enum.RequestStreamingBidi] %}
 stream = {{ method_invocation_text|trim }}
+
+# Handle the response
 {% if transport == "grpc-async" %}async {% endif %}for response in stream:
   {% for statement in response_statements %}
     {{ dispatch_statement(statement)|trim }}
@@ -280,6 +286,8 @@ operation = {{ method_invocation_text|trim }}
 print("Waiting for operation to complete...")
 
 response = {% if transport == "grpc-async" %}await {% endif %}operation.result()
+
+# Handle the response
 {% for statement in response_statements %}
 {{ dispatch_statement(statement)|trim }}
 {% endfor %}

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

@@ -234,6 +234,8 @@ def sample_export_assets():
                 print("Waiting for operation to complete...")
 
                 response = operation.result()
+
+                # Handle the response
                 print(response)
 
         Args:
@@ -321,6 +323,8 @@ def sample_list_assets():
 
                 # Make the request
                 page_result = client.list_assets(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -434,7 +438,7 @@ def sample_batch_get_assets_history():
                 # Make the request
                 response = client.batch_get_assets_history(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -521,7 +525,7 @@ def sample_create_feed():
                 # Make the request
                 response = client.create_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -626,7 +630,7 @@ def sample_get_feed():
                 # Make the request
                 response = client.get_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -735,7 +739,7 @@ def sample_list_feeds():
                 # Make the request
                 response = client.list_feeds(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -840,7 +844,7 @@ def sample_update_feed():
                 # Make the request
                 response = client.update_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -1036,6 +1040,8 @@ def sample_search_all_resources():
 
                 # Make the request
                 page_result = client.search_all_resources(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -1241,6 +1247,8 @@ def sample_search_all_iam_policies():
 
                 # Make the request
                 page_result = client.search_all_iam_policies(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -1426,7 +1434,7 @@ def sample_analyze_iam_policy():
                 # Make the request
                 response = client.analyze_iam_policy(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -1528,6 +1536,8 @@ def sample_analyze_iam_policy_longrunning():
                 print("Waiting for operation to complete...")
 
                 response = operation.result()
+
+                # Handle the response
                 print(response)
 
         Args:

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

@@ -431,6 +431,8 @@ def sample_export_assets():
                 print("Waiting for operation to complete...")
 
                 response = operation.result()
+
+                # Handle the response
                 print(response)
 
         Args:
@@ -520,6 +522,8 @@ def sample_list_assets():
 
                 # Make the request
                 page_result = client.list_assets(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -634,7 +638,7 @@ def sample_batch_get_assets_history():
                 # Make the request
                 response = client.batch_get_assets_history(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -716,7 +720,7 @@ def sample_create_feed():
                 # Make the request
                 response = client.create_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -822,7 +826,7 @@ def sample_get_feed():
                 # Make the request
                 response = client.get_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -925,7 +929,7 @@ def sample_list_feeds():
                 # Make the request
                 response = client.list_feeds(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -1024,7 +1028,7 @@ def sample_update_feed():
                 # Make the request
                 response = client.update_feed(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -1215,6 +1219,8 @@ def sample_search_all_resources():
 
                 # Make the request
                 page_result = client.search_all_resources(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -1414,6 +1420,8 @@ def sample_search_all_iam_policies():
 
                 # Make the request
                 page_result = client.search_all_iam_policies(request=request)
+
+                # Handle the response
                 for response in page_result:
                     print(response)
 
@@ -1593,7 +1601,7 @@ def sample_analyze_iam_policy():
                 # Make the request
                 response = client.analyze_iam_policy(request=request)
 
-                # Handle response
+                # Handle the response
                 print(response)
 
         Args:
@@ -1691,6 +1699,8 @@ def sample_analyze_iam_policy_longrunning():
                 print("Waiting for operation to complete...")
 
                 response = operation.result()
+
+                # Handle the response
                 print(response)
 
         Args:

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_async.py

@@ -42,7 +42,7 @@ async def sample_analyze_iam_policy():
     # Make the request
     response = await client.analyze_iam_policy(request=request)
 
-    # Handle response
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_async]

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_longrunning_async.py

@@ -49,6 +49,8 @@ async def sample_analyze_iam_policy_longrunning():
     print("Waiting for operation to complete...")
 
     response = await operation.result()
+
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_async]

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_longrunning_sync.py

@@ -49,6 +49,8 @@ def sample_analyze_iam_policy_longrunning():
     print("Waiting for operation to complete...")
 
     response = operation.result()
+
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicyLongrunning_sync]

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_analyze_iam_policy_sync.py

@@ -42,7 +42,7 @@ def sample_analyze_iam_policy():
     # Make the request
     response = client.analyze_iam_policy(request=request)
 
-    # Handle response
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_AnalyzeIamPolicy_sync]

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_batch_get_assets_history_async.py

@@ -39,7 +39,7 @@ async def sample_batch_get_assets_history():
     # Make the request
     response = await client.batch_get_assets_history(request=request)
 
-    # Handle response
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_async]

tests/integration/goldens/asset/samples/generated_samples/cloudasset_generated_asset_v1_asset_service_batch_get_assets_history_sync.py

@@ -39,7 +39,7 @@ def sample_batch_get_assets_history():
     # Make the request
     response = client.batch_get_assets_history(request=request)
 
-    # Handle response
+    # Handle the response
     print(response)
 
 # [END cloudasset_generated_asset_v1_AssetService_BatchGetAssetsHistory_sync]