feat: implement async rest transport constructor

Author: ohmayr

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

@@ -1,3 +1,8 @@
+{# TODO: Remove the following condition for async rest transport once support for it is GA:
+ # {% if rest_async_io_enabled %}
+ # See related issue: https://github.com/googleapis/gapic-generator-python/issues/2121.
+#}
+{% set rest_async_io_enabled = api.all_library_settings[api.naming.proto_package].python_settings.experimental_features.rest_async_io_enabled %}
 {% extends '_base.py.j2' %}
 
 {% block content %}
@@ -62,6 +67,9 @@ from .transports.grpc_asyncio import {{ service.grpc_asyncio_transport_name }}
 {% endif %}
 {% if 'rest' in opts.transport %}
 from .transports.rest import {{ service.name }}RestTransport
+{% if rest_async_io_enabled %}
+from .transports.rest_asyncio import Async{{ service.name }}RestTransport
+{% endif %}{# if rest_async_io_enabled #}
 {% endif %}
 
 
@@ -79,6 +87,9 @@ class {{ service.client_name }}Meta(type):
     {% endif %}
     {% if "rest" in opts.transport %}
     _transport_registry["rest"] = {{ service.name }}RestTransport
+    {% if rest_async_io_enabled %}
+    _transport_registry["rest_asyncio"] = {{ service.name }}RestTransport
+    {% endif %}{# if rest_async_io_enabled #}
     {% endif %}
 
     def get_transport_class(cls,

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

@@ -4,4 +4,87 @@
 #}
 {% set rest_async_io_enabled = api.all_library_settings[api.naming.proto_package].python_settings.experimental_features.rest_async_io_enabled %}
 {% if rest_async_io_enabled %}
+{% extends '_base.py.j2' %}
+
+{% block content %}
+
+from google.api_core import gapic_v1
+
+from typing import Any, Optional
+
+from .rest_base import _Base{{ service.name }}RestTransport
+
+from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
+
+{# TODO (ohmayr): determine the version of rest. aiohttp or google.auth.aio. #}
+DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+    gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version,
+    grpc_version=None,
+    rest_version=None,
+)
+
+class Async{{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
+    """Asynchronous REST backend transport for {{ service.name }}.
+
+    {{ service.meta.doc|rst(width=72, indent=4) }}
+
+    This class defines the same methods as the primary client, so the
+    primary client can load the underlying transport implementation
+    and call it.
+
+    It sends JSON representations of protocol buffers over HTTP/1.1
+    """
+    def __init__(self, *,
+            host: str{% if service.host %} = '{{ service.host }}'{% endif %},
+            {# TODO (ohmayr): Update the default type for credentials. #}
+            credentials: Optional[Any] = None,
+            client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+            url_scheme: str = 'https',
+            ) -> None:
+        """Instantiate the transport.
+
+       {% if not opts.rest_numeric_enums %}
+       NOTE: This async REST transport functionality is currently in a beta
+       state (preview). We welcome your feedback via a GitHub issue in
+       this library's repository. Thank you!
+       {% endif %}
+
+        Args:
+            host ({% if service.host %}Optional[str]{% else %}str{% endif %}):
+                {{ ' ' }}The hostname to connect to {% if service.host %}(default: '{{ service.host }}'){% endif %}.
+            {# TODO (ohmayr): Update the default type for credentials. #}
+            credentials (Optional[Any]): The
+                authorization credentials to attach to requests. These
+                credentials identify the application to the service; if none
+                are specified, the client will attempt to ascertain the
+                credentials from the environment.
+            client_info (google.api_core.gapic_v1.client_info.ClientInfo):
+                The client info used to send a user-agent string along with
+                API requests. If ``None``, then default info will be used.
+                Generally, you only need to set this if you are developing
+                your own client library.
+            url_scheme: the protocol scheme for the API endpoint.  Normally
+                "https", but for testing or local servers,
+                "http" can be specified.
+        """
+        # Run the base constructor
+        super().__init__(
+            host=host,
+            credentials=credentials,
+            client_info=client_info,
+            always_use_jwt_access=False,
+            url_scheme=url_scheme,
+            api_audience=None
+        )
+
+        {# TODO (ohmayr): configure session once the following PR in google-auth-library-python
+        i.e. https://github.com/googleapis/google-auth-library-python/pull/1577 is merged. #}
+        {# TODO (ohmayr): call prep wrapped methods #}
+        {# self._prep_wrapped_messages(client_info) #}
+
+    @property
+    def kind(self) -> str:
+        return "rest_asyncio"
+
+{% endblock %}
 {% endif %}{# if rest_async_io_enabled #}

gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2

@@ -1,3 +1,8 @@
+{# TODO: Remove the following condition for async rest transport once support for it is GA:
+ # {% if rest_async_io_enabled %}
+ # See related issue: https://github.com/googleapis/gapic-generator-python/issues/2121.
+#}
+{% set rest_async_io_enabled = api.all_library_settings[api.naming.proto_package].python_settings.experimental_features.rest_async_io_enabled %}
 {% extends "_base.py.j2" %}
 
 {% block content %}
@@ -1041,9 +1046,21 @@ def test_transport_adc(transport_class):
         transport_class()
         adc.assert_called_once()
 
-{{ test_macros.transport_kind_test(service, opts) }}
+{% set configs = [] %}
+{% for transport_name in opts.transport %}
+    {% do configs.append({'service':service, 'transport_name':transport_name,'credentials':'ga_credentials.AnonymousCredentials()'}) %}
+{# TODO: Remove the following guard once support for async REST is GA.
+ # See related issue: https://github.com/googleapis/gapic-generator-python/issues/2121.
+#}
+{% if 'grpc' in transport_name or rest_async_io_enabled %}
+    {% do configs.append({'service':service, 'transport_name':transport_name + "_asyncio",'credentials':'async_anonymous_credentials()'}) %}
+{% endif %}
+{% endfor %}
 
-{{ test_macros.transport_kind_test(service, opts, is_async=True) }}
+{% for conf in configs %}
+{{ test_macros.transport_kind_test(**conf) }}
+
+{% endfor %}
 
 {% if 'grpc' in opts.transport %}
 def test_transport_grpc_default():

gapic/templates/tests/unit/gapic/%name_%version/%sub/test_macros.j2

@@ -1878,32 +1878,12 @@ def test_{{ method_name }}_empty_call():
 {% endmacro %}
 
 
-{% macro transport_kind_test(service, opts, is_async=False) %}
-@pytest.mark.parametrize("transport_name", [
-    {% if is_async %}
-    {% if "grpc" in opts.transport %}
-    "grpc_asyncio",
-    {% endif %}
-    {% else %}{# if not is_async #}
-    {% if "grpc" in opts.transport%}
-    "grpc",
-    {% endif %}
-    {% if "rest" in opts.transport %}
-    "rest",
-    {% endif %}
-    {% endif %}{# is_async #}
-])
-{% if is_async %}
-@pytest.mark.asyncio
-async def test_transport_kind_async(transport_name):
-    transport = {{ service.async_client_name }}.get_transport_class(transport_name)(
-        credentials=async_anonymous_credentials(),
-    )
-{% else %}
-def test_transport_kind(transport_name):
-    transport = {{ service.client_name }}.get_transport_class(transport_name)(
-        credentials=ga_credentials.AnonymousCredentials(),
+{% macro transport_kind_test(service, transport_name, credentials) %}
+{%- set named_clients = { 'rest': service.client_name, 'grpc': service.client_name, 'grpc_asyncio': service.async_client_name, 'rest_asyncio': service.async_client_name}
+-%}
+def test_transport_kind_{{transport_name}}():
+    transport = {{ named_clients[transport_name] }}.get_transport_class("{{transport_name}}")(
+        credentials={{credentials}}
     )
-{% endif %}
-    assert transport.kind == transport_name
-{% endmacro %}
+    assert transport.kind == "{{ transport_name }}"
+{% endmacro %}

tests/integration/cloudasset_v1.yaml

@@ -44,4 +44,11 @@ authentication:
   - selector: google.longrunning.Operations.GetOperation
     oauth:
       canonical_scopes: |-
-        https://www.googleapis.com/auth/cloud-platform
+        https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+  library_settings:
+  - version: 'google.cloud.asset.v1'
+    python_settings:
+      experimental_features:
+        rest_async_io_enabled: true

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

@@ -50,6 +50,7 @@
 from .transports.grpc import AssetServiceGrpcTransport
 from .transports.grpc_asyncio import AssetServiceGrpcAsyncIOTransport
 from .transports.rest import AssetServiceRestTransport
+from .transports.rest_asyncio import AsyncAssetServiceRestTransport
 
 
 class AssetServiceClientMeta(type):
@@ -63,6 +64,7 @@ class AssetServiceClientMeta(type):
     _transport_registry["grpc"] = AssetServiceGrpcTransport
     _transport_registry["grpc_asyncio"] = AssetServiceGrpcAsyncIOTransport
     _transport_registry["rest"] = AssetServiceRestTransport
+    _transport_registry["rest_asyncio"] = AssetServiceRestTransport
 
     def get_transport_class(cls,
             label: Optional[str] = None,

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

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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.
+#
+from google.api_core import gapic_v1
+
+from typing import Any, Optional
+
+from .rest_base import _BaseAssetServiceRestTransport
+
+from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
+
+DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+    gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version,
+    grpc_version=None,
+    rest_version=None,
+)
+
+class AsyncAssetServiceRestTransport(_BaseAssetServiceRestTransport):
+    """Asynchronous REST backend transport for AssetService.
+
+    Asset service definition.
+
+    This class defines the same methods as the primary client, so the
+    primary client can load the underlying transport implementation
+    and call it.
+
+    It sends JSON representations of protocol buffers over HTTP/1.1
+    """
+    def __init__(self, *,
+            host: str = 'cloudasset.googleapis.com',
+            credentials: Optional[Any] = None,
+            client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+            url_scheme: str = 'https',
+            ) -> None:
+        """Instantiate the transport.
+
+       NOTE: This async REST transport functionality is currently in a beta
+       state (preview). We welcome your feedback via a GitHub issue in
+       this library's repository. Thank you!
+
+        Args:
+            host (Optional[str]):
+                 The hostname to connect to (default: 'cloudasset.googleapis.com').
+            credentials (Optional[Any]): The
+                authorization credentials to attach to requests. These
+                credentials identify the application to the service; if none
+                are specified, the client will attempt to ascertain the
+                credentials from the environment.
+            client_info (google.api_core.gapic_v1.client_info.ClientInfo):
+                The client info used to send a user-agent string along with
+                API requests. If ``None``, then default info will be used.
+                Generally, you only need to set this if you are developing
+                your own client library.
+            url_scheme: the protocol scheme for the API endpoint.  Normally
+                "https", but for testing or local servers,
+                "http" can be specified.
+        """
+        # Run the base constructor
+        super().__init__(
+            host=host,
+            credentials=credentials,
+            client_info=client_info,
+            always_use_jwt_access=False,
+            url_scheme=url_scheme,
+            api_audience=None
+        )
+
+    @property
+    def kind(self) -> str:
+        return "rest_asyncio"

tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py

@@ -16405,26 +16405,33 @@ def test_transport_adc(transport_class):
         transport_class()
         adc.assert_called_once()
 
-@pytest.mark.parametrize("transport_name", [
-    "grpc",
-    "rest",
-])
-def test_transport_kind(transport_name):
-    transport = AssetServiceClient.get_transport_class(transport_name)(
-        credentials=ga_credentials.AnonymousCredentials(),
+
+def test_transport_kind_grpc():
+    transport = AssetServiceClient.get_transport_class("grpc")(
+        credentials=ga_credentials.AnonymousCredentials()
     )
-    assert transport.kind == transport_name
+    assert transport.kind == "grpc"
 
 
-@pytest.mark.parametrize("transport_name", [
-    "grpc_asyncio",
-])
-@pytest.mark.asyncio
-async def test_transport_kind_async(transport_name):
-    transport = AssetServiceAsyncClient.get_transport_class(transport_name)(
-        credentials=async_anonymous_credentials(),
+def test_transport_kind_grpc_asyncio():
+    transport = AssetServiceAsyncClient.get_transport_class("grpc_asyncio")(
+        credentials=async_anonymous_credentials()
+    )
+    assert transport.kind == "grpc_asyncio"
+
+
+def test_transport_kind_rest():
+    transport = AssetServiceClient.get_transport_class("rest")(
+        credentials=ga_credentials.AnonymousCredentials()
+    )
+    assert transport.kind == "rest"
+
+
+def test_transport_kind_rest_asyncio():
+    transport = AssetServiceAsyncClient.get_transport_class("rest_asyncio")(
+        credentials=async_anonymous_credentials()
     )
-    assert transport.kind == transport_name
+    assert transport.kind == "rest_asyncio"
 
 
 def test_transport_grpc_default():

tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py

@@ -3490,26 +3490,26 @@ def test_transport_adc(transport_class):
         transport_class()
         adc.assert_called_once()
 
-@pytest.mark.parametrize("transport_name", [
-    "grpc",
-    "rest",
-])
-def test_transport_kind(transport_name):
-    transport = IAMCredentialsClient.get_transport_class(transport_name)(
-        credentials=ga_credentials.AnonymousCredentials(),
+
+def test_transport_kind_grpc():
+    transport = IAMCredentialsClient.get_transport_class("grpc")(
+        credentials=ga_credentials.AnonymousCredentials()
     )
-    assert transport.kind == transport_name
+    assert transport.kind == "grpc"
 
 
-@pytest.mark.parametrize("transport_name", [
-    "grpc_asyncio",
-])
-@pytest.mark.asyncio
-async def test_transport_kind_async(transport_name):
-    transport = IAMCredentialsAsyncClient.get_transport_class(transport_name)(
-        credentials=async_anonymous_credentials(),
+def test_transport_kind_grpc_asyncio():
+    transport = IAMCredentialsAsyncClient.get_transport_class("grpc_asyncio")(
+        credentials=async_anonymous_credentials()
+    )
+    assert transport.kind == "grpc_asyncio"
+
+
+def test_transport_kind_rest():
+    transport = IAMCredentialsClient.get_transport_class("rest")(
+        credentials=ga_credentials.AnonymousCredentials()
     )
-    assert transport.kind == transport_name
+    assert transport.kind == "rest"
 
 
 def test_transport_grpc_default():