add comments

Author: ohmayr

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

@@ -227,6 +227,7 @@ def _get_http_options():
         request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri'])
         method = transcoded_request['method']
         {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2137): Remove `type:  ignore` once version check is added for google-api-core. #}
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         raise core_exceptions.format_http_response_error(response, method, request_url, payload)  # type: ignore # fmt: skip
         {% else %}
         raise core_exceptions.from_http_response(response)

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

@@ -131,6 +131,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
 
     DEFAULT_ENDPOINT = {% if service.host %}"{{ service.host }}"{% else %}None{% endif %}
 
+    {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
     DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__(  # type: ignore # fmt: skip
         DEFAULT_ENDPOINT
     )

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

@@ -273,6 +273,7 @@ class {{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
             {{method.output.ident}}]:
         # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here.
         # In C++ this would require a dynamic_cast
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         return self._{{method.name}}(self._session, self._host, self._interceptor) # type: ignore # fmt: skip
 
     {% endfor %}

gapic/templates/%namespace/%name_%version/%sub/__init__.py.j2

@@ -10,8 +10,10 @@ import sys
 
 __version__ = package_version.__version__
 
+{# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
 if sys.version_info >= (3, 8):  # pragma: NO COVER # fmt: skip
     from importlib import metadata
+{# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
 else:  # pragma: NO COVER # fmt: skip
     # TODO(https://github.com/googleapis/python-api-core/issues/835): Remove
     # this code path once we drop support for Python 3.7
@@ -46,10 +48,12 @@ from .types.{{ proto.module_name }} import {{ enum.name }}
 {% endfor %}
 {% endfor %}
 
+{# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
 if hasattr(api_core, "check_python_version") and hasattr(api_core, "check_dependency_versions"):   # pragma: NO COVER # fmt: skip
     {# TODO(api_core): remove `type:ignore` below when minimum version of api_core makes the else clause unnecessary. #}
     api_core.check_python_version("{{package_path}}") # type: ignore
     api_core.check_dependency_versions("{{package_path}}") # type: ignore
+{# Add `# pragma: NO COVER` to keep `# pragma: NO COVER` on the same line #}
 else:   # pragma: NO COVER # fmt: skip
 {# TODO(api_core): Remove this try-catch when we require api-core at a version that
    supports the changes in https://github.com/googleapis/python-api-core/pull/832

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

@@ -104,6 +104,7 @@ except ImportError:  # pragma: NO COVER
     `add_google_api_core_version_header_import` to add the necessary import statements.
 #}
     {% if service_version %}
+        {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if HAS_GOOGLE_API_CORE_VERSION_HEADER:  # pragma: NO COVER # fmt: skip
             metadata = tuple(metadata) + (
                 version_header.to_api_version_header("{{ service_version }}"),
@@ -214,6 +215,7 @@ def _get_http_options():
     # Jsonify the query params
     query_params = _Base{{ service_name }}RestTransport._Base{{method_name}}._get_query_params_json(transcoded_request)
 
+    {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
     if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG):  # pragma: NO COVER # fmt: skip
         request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri'])
         method = transcoded_request['method']
@@ -256,6 +258,7 @@ def _get_http_options():
         request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri'])
         method = transcoded_request['method']
         {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2137): Remove `type:  ignore` once version check is added for google-api-core. #}
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         raise core_exceptions.format_http_response_error(response, method, request_url, payload)  # type: ignore # fmt: skip
         {% else %}
         raise core_exceptions.from_http_response(response)
@@ -266,6 +269,7 @@ def _get_http_options():
 
 {% macro unary_request_interceptor_common(service) %}
         logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG)
+        {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if logging_enabled:  # pragma: NO COVER # fmt: skip
             request_metadata = client_call_details.metadata
             if isinstance(request, proto.Message):
@@ -354,6 +358,7 @@ See related issue: https://github.com/googleapis/gapic-generator-python/issues/2
 {% macro wrap_async_method_macro() %}
 def _wrap_method(self, func, *args, **kwargs):
     {# TODO: Remove `pragma: NO COVER` once https://github.com/googleapis/python-api-core/pull/688 is merged. #}
+    {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
     if self._wrap_with_kind:  # pragma: NO COVER # fmt: skip
         kwargs["kind"] = self.kind
     return gapic_v1.method_async.wrap_method(func, *args, **kwargs)
@@ -488,6 +493,7 @@ class {{ async_method_name_prefix }}{{ service.name }}RestInterceptor:
 
 @property
 def {{ name|snake_case }}(self):
+    {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
     return self.{{ name|make_private }}(self._session, self._host, self._interceptor) # type: ignore # fmt: skip
 
 class {{ name|make_private }}(_Base{{ service.name }}RestTransport._Base{{name}}, {{ async_method_name_prefix }}{{service.name}}RestStub):
@@ -534,6 +540,7 @@ class {{ name|make_private }}(_Base{{ service.name }}RestTransport._Base{{name}}
         resp = {{ sig.response_type }}()
         resp = json_format.Parse(content, resp)
         resp = {{ await_prefix }}self._interceptor.post_{{ name|snake_case }}(resp)
+        {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG):  # pragma: NO COVER # fmt: skip
             try:
                 response_payload = json_format.MessageToJson(resp)

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

@@ -98,6 +98,7 @@ class {{ service.async_client_name }}:
         Returns:
             {{ service.async_client_name }}: The constructed client.
         """
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         return {{ service.client_name }}.from_service_account_info.__func__({{ service.async_client_name }}, info, *args, **kwargs)  # type: ignore # fmt: skip
 
     @classmethod
@@ -114,6 +115,7 @@ class {{ service.async_client_name }}:
         Returns:
             {{ service.async_client_name }}: The constructed client.
         """
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         return {{ service.client_name }}.from_service_account_file.__func__({{ service.async_client_name }}, filename, *args, **kwargs)  # type: ignore # fmt: skip
 
     from_service_account_json = from_service_account_file
@@ -150,6 +152,7 @@ class {{ service.async_client_name }}:
         Raises:
             google.auth.exceptions.MutualTLSChannelError: If any errors happen.
         """
+        {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
         return {{ service.client_name }}.get_mtls_endpoint_and_cert_source(client_options)  # type: ignore # fmt: skip
 
     @property
@@ -252,6 +255,7 @@ class {{ service.async_client_name }}:
 
         )
 
+        {# Add ` # fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG):  # pragma: NO COVER # fmt: skip
             _LOGGER.debug(
                 "Created client `{{ service.meta.address.proto_package_versioned }}.{{ service.async_client_name }}`.",

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

@@ -127,6 +127,7 @@ class {{ service.client_name }}Meta(type):
         {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2121): Remove this condition when async rest is GA. #}
         {% if rest_async_io_enabled %}
         {# NOTE: `pragma: NO COVER` is needed since the coverage for presubmits isn't combined. #}
+        {# Add ` # fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if label == "rest_asyncio" and not HAS_ASYNC_REST_DEPENDENCIES:  # pragma: NO COVER # fmt: skip
             raise ASYNC_REST_EXCEPTION
         {% endif %}
@@ -175,6 +176,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
     # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
     DEFAULT_ENDPOINT = {% if service.host %}"{{ service.host }}"{% else %}None{% endif %}
 
+    {# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
     DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__(  # type: ignore # fmt: skip
         DEFAULT_ENDPOINT
     )
@@ -568,6 +570,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
         # Initialize the universe domain validation.
         self._is_universe_domain_valid = False
 
+        {# Add ` # fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if CLIENT_LOGGING_SUPPORTED:  # pragma: NO COVER # fmt: skip
             # Setup logging.
             client_logging.initialize_logging()
@@ -660,6 +663,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
             )
 
         if "async" not in str(self._transport):
+            {# Add ` # pragma: NO COVER` to keep `# type: ignore` on the same line #}
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG):  # pragma: NO COVER # fmt: skip
                 _LOGGER.debug(
                     "Created client `{{ service.meta.address.proto_package_versioned }}.{{ service.client_name }}`.",
@@ -1014,6 +1018,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)
 
+{# Add ` # fmt: skip` to keep `# pragma: NO COVER` on the same line #}
 if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"):  # pragma: NO COVER # fmt: skip
     DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
 

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

@@ -39,6 +39,7 @@ _transport_registry['grpc_asyncio'] = {{ service.name }}GrpcAsyncIOTransport
 {% if 'rest' in opts.transport %}
 _transport_registry['rest'] = {{ service.name }}RestTransport
 {% if rest_async_io_enabled %}
+{# Add ` # fmt: skip` to keep `# pragma: NO COVER` on the same line #}
 if HAS_REST_ASYNC:  # pragma: NO COVER # fmt: skip
     _transport_registry['rest_asyncio'] = Async{{ service.name }}RestTransport
 {% endif %}{# if rest_async_io_enabled #}

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

@@ -52,6 +52,7 @@ from {{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + ser
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__)
 
+{# Add `# fmt: skip` to keep `# type: ignore` on the same line #}
 if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"):  # pragma: NO COVER # fmt: skip
     DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
 

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

@@ -63,6 +63,7 @@ class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor):  # pragma: NO
     def intercept_unary_unary(self, continuation, client_call_details, request):
 {{ shared_macros.unary_request_interceptor_common(service) }}
         response = continuation(client_call_details, request)
+        {# Add `# fmt: skip` to keep `# pragma: NO COVER` on the same line #}
         if logging_enabled:  # pragma: NO COVER # fmt: skip
             response_metadata = response.trailing_metadata()
             # Convert gRPC metadata `<class 'grpc.aio._metadata.Metadata'>` to list of tuples