|
| 1 | +{% extends '_base.py.j2' %} |
| 2 | + |
| 3 | +{% block content %} |
| 4 | +from collections import OrderedDict |
| 5 | +import functools |
| 6 | +import re |
| 7 | +from typing import Dict, {% if service.any_server_streaming %}AsyncIterable, {% endif %}{% if service.any_client_streaming %}AsyncIterator, {% endif %}Sequence, Tuple, Type, Union |
| 8 | +import pkg_resources |
| 9 | + |
| 10 | +import google.api_core.client_options as ClientOptions # type: ignore |
| 11 | +from google.api_core import exceptions # type: ignore |
| 12 | +from google.api_core import gapic_v1 # type: ignore |
| 13 | +from google.api_core import retry as retries # type: ignore |
| 14 | +from google.auth import credentials # type: ignore |
| 15 | +from google.oauth2 import service_account # type: ignore |
| 16 | + |
| 17 | +{% filter sort_lines -%} |
| 18 | +{% for method in service.methods.values() -%} |
| 19 | +{% for ref_type in method.flat_ref_types -%} |
| 20 | +{{ ref_type.ident.python_import }} |
| 21 | +{% endfor -%} |
| 22 | +{% endfor -%} |
| 23 | +{% endfilter %} |
| 24 | +from .transports.base import {{ service.name }}Transport |
| 25 | +from .transports.grpc_asyncio import {{ service.grpc_asyncio_transport_name }} |
| 26 | +from .client import {{ service.client_name }} |
| 27 | + |
| 28 | + |
| 29 | +class {{ service.async_client_name }}: |
| 30 | + """{{ service.meta.doc|rst(width=72, indent=4) }}""" |
| 31 | + |
| 32 | + _client: {{ service.client_name }} |
| 33 | + |
| 34 | + DEFAULT_ENDPOINT = {{ service.client_name }}.DEFAULT_ENDPOINT |
| 35 | + DEFAULT_MTLS_ENDPOINT = {{ service.client_name }}.DEFAULT_MTLS_ENDPOINT |
| 36 | + |
| 37 | + {% for message in service.resource_messages -%} |
| 38 | + {{ message.resource_type|snake_case }}_path = staticmethod({{ service.client_name }}.{{ message.resource_type|snake_case }}_path) |
| 39 | + |
| 40 | + {% endfor %} |
| 41 | + |
| 42 | + from_service_account_file = {{ service.client_name }}.from_service_account_file |
| 43 | + from_service_account_json = from_service_account_file |
| 44 | + |
| 45 | + get_transport_class = functools.partial(type({{ service.client_name }}).get_transport_class, type({{ service.client_name }})) |
| 46 | + |
| 47 | + def __init__(self, *, |
| 48 | + credentials: credentials.Credentials = None, |
| 49 | + transport: Union[str, {{ service.name }}Transport] = "grpc_asyncio", |
| 50 | + client_options: ClientOptions = None, |
| 51 | + ) -> None: |
| 52 | + """Instantiate the {{ (service.client_name|snake_case).replace('_', ' ') }}. |
| 53 | + |
| 54 | + Args: |
| 55 | + credentials (Optional[google.auth.credentials.Credentials]): The |
| 56 | + authorization credentials to attach to requests. These |
| 57 | + credentials identify the application to the service; if none |
| 58 | + are specified, the client will attempt to ascertain the |
| 59 | + credentials from the environment. |
| 60 | + transport (Union[str, ~.{{ service.name }}Transport]): The |
| 61 | + transport to use. If set to None, a transport is chosen |
| 62 | + automatically. |
| 63 | + client_options (ClientOptions): Custom options for the client. |
| 64 | + (1) The ``api_endpoint`` property can be used to override the |
| 65 | + default endpoint provided by the client. |
| 66 | + (2) If ``transport`` argument is None, ``client_options`` can be |
| 67 | + used to create a mutual TLS transport. If ``client_cert_source`` |
| 68 | + is provided, mutual TLS transport will be created with the given |
| 69 | + ``api_endpoint`` or the default mTLS endpoint, and the client |
| 70 | + SSL credentials obtained from ``client_cert_source``. |
| 71 | + |
| 72 | + Raises: |
| 73 | + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport |
| 74 | + creation failed for any reason. |
| 75 | + """ |
| 76 | + {# NOTE(lidiz) Not using kwargs since we want the docstring and types. #} |
| 77 | + self._client = {{ service.client_name }}( |
| 78 | + credentials=credentials, |
| 79 | + transport=transport, |
| 80 | + client_options=client_options, |
| 81 | + ) |
| 82 | + |
| 83 | + {% for method in service.methods.values() -%} |
| 84 | + {% if not method.server_streaming %}async {% endif -%}def {{ method.name|snake_case }}(self, |
| 85 | + {%- if not method.client_streaming %} |
| 86 | + request: {{ method.input.ident }} = None, |
| 87 | + *, |
| 88 | + {% for field in method.flattened_fields.values() -%} |
| 89 | + {{ field.name }}: {{ field.ident }} = None, |
| 90 | + {% endfor -%} |
| 91 | + {%- else %} |
| 92 | + requests: AsyncIterator[{{ method.input.ident }}] = None, |
| 93 | + *, |
| 94 | + {% endif -%} |
| 95 | + retry: retries.Retry = gapic_v1.method.DEFAULT, |
| 96 | + timeout: float = None, |
| 97 | + metadata: Sequence[Tuple[str, str]] = (), |
| 98 | + {%- if not method.server_streaming %} |
| 99 | + ) -> {{ method.client_output_async.ident }}: |
| 100 | + {%- else %} |
| 101 | + ) -> AsyncIterable[{{ method.client_output_async.ident }}]: |
| 102 | + {%- endif %} |
| 103 | + r"""{{ method.meta.doc|rst(width=72, indent=8) }} |
| 104 | + |
| 105 | + Args: |
| 106 | + {%- if not method.client_streaming %} |
| 107 | + request (:class:`{{ method.input.ident.sphinx }}`): |
| 108 | + The request object.{{ ' ' -}} |
| 109 | + {{ method.input.meta.doc|wrap(width=72, offset=36, indent=16) }} |
| 110 | + {% for key, field in method.flattened_fields.items() -%} |
| 111 | + {{ field.name }} (:class:`{{ field.ident.sphinx }}`): |
| 112 | + {{ field.meta.doc|rst(width=72, indent=16, nl=False) }} |
| 113 | + This corresponds to the ``{{ key }}`` field |
| 114 | + on the ``request`` instance; if ``request`` is provided, this |
| 115 | + should not be set. |
| 116 | + {% endfor -%} |
| 117 | + {%- else %} |
| 118 | + requests (AsyncIterator[`{{ method.input.ident.sphinx }}`]): |
| 119 | + The request object AsyncIterator.{{ ' ' -}} |
| 120 | + {{ method.input.meta.doc|wrap(width=72, offset=36, indent=16) }} |
| 121 | + {%- endif %} |
| 122 | + retry (google.api_core.retry.Retry): Designation of what errors, if any, |
| 123 | + should be retried. |
| 124 | + timeout (float): The timeout for this request. |
| 125 | + metadata (Sequence[Tuple[str, str]]): Strings which should be |
| 126 | + sent along with the request as metadata. |
| 127 | + {%- if not method.void %} |
| 128 | + |
| 129 | + Returns: |
| 130 | + {%- if not method.server_streaming %} |
| 131 | + {{ method.client_output_async.ident.sphinx }}: |
| 132 | + {%- else %} |
| 133 | + AsyncIterable[{{ method.client_output_async.ident.sphinx }}]: |
| 134 | + {%- endif %} |
| 135 | + {{ method.client_output_async.meta.doc|rst(width=72, indent=16) }} |
| 136 | + {%- endif %} |
| 137 | + """ |
| 138 | + {%- if not method.client_streaming %} |
| 139 | + # Create or coerce a protobuf request object. |
| 140 | + {% if method.flattened_fields -%} |
| 141 | + # Sanity check: If we got a request object, we should *not* have |
| 142 | + # gotten any keyword arguments that map to the request. |
| 143 | + if request is not None and any([{{ method.flattened_fields.values()|join(', ', attribute='name') }}]): |
| 144 | + raise ValueError('If the `request` argument is set, then none of ' |
| 145 | + 'the individual field arguments should be set.') |
| 146 | + |
| 147 | + {% endif -%} |
| 148 | + {% if method.input.ident.package != method.ident.package -%} {# request lives in a different package, so there is no proto wrapper #} |
| 149 | + # The request isn't a proto-plus wrapped type, |
| 150 | + # so it must be constructed via keyword expansion. |
| 151 | + if isinstance(request, dict): |
| 152 | + request = {{ method.input.ident }}(**request) |
| 153 | + {% if method.flattened_fields -%}{# Cross-package req and flattened fields #} |
| 154 | + elif not request: |
| 155 | + request = {{ method.input.ident }}() |
| 156 | + {% endif -%}{# Cross-package req and flattened fields #} |
| 157 | + {%- else %} |
| 158 | + request = {{ method.input.ident }}(request) |
| 159 | + {% endif %} {# different request package #} |
| 160 | + |
| 161 | + {#- Vanilla python protobuf wrapper types cannot _set_ repeated fields #} |
| 162 | + {% if method.flattened_fields -%} |
| 163 | + # If we have keyword arguments corresponding to fields on the |
| 164 | + # request, apply these. |
| 165 | + {% endif -%} |
| 166 | + {%- for key, field in method.flattened_fields.items() if not(field.repeated and method.input.ident.package != method.ident.package) %} |
| 167 | + if {{ field.name }} is not None: |
| 168 | + request.{{ key }} = {{ field.name }} |
| 169 | + {%- endfor %} |
| 170 | + {# They can be _extended_, however -#} |
| 171 | + {%- for key, field in method.flattened_fields.items() if (field.repeated and method.input.ident.package != method.ident.package) %} |
| 172 | + if {{ field.name }}: |
| 173 | + request.{{ key }}.extend({{ field.name }}) |
| 174 | + {%- endfor %} |
| 175 | + {%- endif %} |
| 176 | + |
| 177 | + # Wrap the RPC method; this adds retry and timeout information, |
| 178 | + # and friendly error handling. |
| 179 | + rpc = gapic_v1.method_async.wrap_method( |
| 180 | + self._client._transport.{{ method.name|snake_case }}, |
| 181 | + {%- if method.retry %} |
| 182 | + default_retry=retries.Retry( |
| 183 | + {% if method.retry.initial_backoff %}initial={{ method.retry.initial_backoff }},{% endif %} |
| 184 | + {% if method.retry.max_backoff %}maximum={{ method.retry.max_backoff }},{% endif %} |
| 185 | + {% if method.retry.backoff_multiplier %}multiplier={{ method.retry.backoff_multiplier }},{% endif %} |
| 186 | + predicate=retries.if_exception_type( |
| 187 | + {%- filter sort_lines %} |
| 188 | + {%- for ex in method.retry.retryable_exceptions %} |
| 189 | + exceptions.{{ ex.__name__ }}, |
| 190 | + {%- endfor %} |
| 191 | + {%- endfilter %} |
| 192 | + ), |
| 193 | + ), |
| 194 | + {%- endif %} |
| 195 | + default_timeout={{ method.timeout }}, |
| 196 | + client_info=_client_info, |
| 197 | + ) |
| 198 | + {%- if method.field_headers %} |
| 199 | + |
| 200 | + # Certain fields should be provided within the metadata header; |
| 201 | + # add these here. |
| 202 | + metadata = tuple(metadata) + ( |
| 203 | + gapic_v1.routing_header.to_grpc_metadata(( |
| 204 | + {%- for field_header in method.field_headers %} |
| 205 | + ('{{ field_header }}', request.{{ field_header }}), |
| 206 | + {%- endfor %} |
| 207 | + )), |
| 208 | + ) |
| 209 | + {%- endif %} |
| 210 | + |
| 211 | + # Send the request. |
| 212 | + {% if not method.void %}response = {% endif %} |
| 213 | + {%- if not method.server_streaming %}await {% endif %}rpc( |
| 214 | + {%- if not method.client_streaming %} |
| 215 | + request, |
| 216 | + {%- else %} |
| 217 | + requests, |
| 218 | + {%- endif %} |
| 219 | + retry=retry, |
| 220 | + timeout=timeout, |
| 221 | + metadata=metadata, |
| 222 | + ) |
| 223 | + {%- if method.lro %} |
| 224 | + |
| 225 | + # Wrap the response in an operation future. |
| 226 | + response = operation_async.from_gapic( |
| 227 | + response, |
| 228 | + self._client._transport.operations_client, |
| 229 | + {{ method.lro.response_type.ident }}, |
| 230 | + metadata_type={{ method.lro.metadata_type.ident }}, |
| 231 | + ) |
| 232 | + {%- elif method.paged_result_field %} |
| 233 | + |
| 234 | + # This method is paged; wrap the response in a pager, which provides |
| 235 | + # an `__aiter__` convenience method. |
| 236 | + response = {{ method.client_output_async.ident }}( |
| 237 | + method=rpc, |
| 238 | + request=request, |
| 239 | + response=response, |
| 240 | + ) |
| 241 | + {%- endif %} |
| 242 | + {%- if not method.void %} |
| 243 | + |
| 244 | + # Done; return the response. |
| 245 | + return response |
| 246 | + {%- endif %} |
| 247 | + {{ '\n' }} |
| 248 | + {% endfor %} |
| 249 | + |
| 250 | + |
| 251 | +try: |
| 252 | + _client_info = gapic_v1.client_info.ClientInfo( |
| 253 | + gapic_version=pkg_resources.get_distribution( |
| 254 | + '{{ api.naming.warehouse_package_name }}', |
| 255 | + ).version, |
| 256 | + ) |
| 257 | +except pkg_resources.DistributionNotFound: |
| 258 | + _client_info = gapic_v1.client_info.ClientInfo() |
| 259 | + |
| 260 | + |
| 261 | +__all__ = ( |
| 262 | + '{{ service.async_client_name }}', |
| 263 | +) |
| 264 | +{% endblock %} |
0 commit comments