feat: adds support for MixIns.

.github/workflows/tests.yaml

@@ -132,10 +132,12 @@ jobs:
     strategy:
       matrix:
         python: ["3.6", "3.7", "3.8", "3.9", "3.10"]
-        variant: ['', _alternative_templates]
+        variant: ['', _alternative_templates, _mixins, _alternative_templates_mixins]
         exclude:
           - python: "3.6"
             variant: _alternative_templates
+          - python: "3.6"
+            variant: _alternative_templates_mixins
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

BUILD.bazel

@@ -69,6 +69,7 @@ py_binary(
         requirement("MarkupSafe"),
         requirement("pypandoc"),
         requirement("PyYAML"),
+	requirement("grpc-google-iam-v1"),
     ] + select({
         ":gapic_gen_python_3_6": [requirement("dataclasses")],
         "//conditions:default": [],

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

@@ -32,10 +32,13 @@ except AttributeError:  # pragma: NO COVER
 {{ ref_type.ident.python_import }}
 {% endfor %}
 {% endfor %}
-{% if opts.add_iam_methods %}
+{% if opts.add_iam_methods or api.has_iam_mixin %}
 from google.iam.v1 import iam_policy_pb2  # type: ignore
 from google.iam.v1 import policy_pb2  # type: ignore
 {% endif %}
+{% if api.has_location_mixin %}
+from google.cloud.location import locations_pb2 # type: ignore
+{% endif %}
 {% endfilter %}
 from .transports.base import {{ service.name }}Transport, DEFAULT_CLIENT_INFO
 {% if 'grpc' in opts.transport %}
@@ -498,6 +501,9 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
         {{ "\n" }}
     {% endfor %}
 
+    {% include '%namespace/%name/%version/%sub/services/%service/_mixins.py.j2' %}
+
+    {# TODO: Remove after https://github.com/googleapis/gapic-generator-python/pull/1240 is merged. #}
     {% if opts.add_iam_methods %}
     def set_iam_policy(
         self,

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

@@ -0,0 +1,136 @@
+    {% if "grpc" in opts.transport %}
+
+    {% if api.has_location_mixin %}
+
+    {% if "ListLocations" in api.mixin_api_methods %}
+    @property
+    def list_locations(
+        self,
+    ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]:
+        r"""Return a callable for the list locations method over gRPC.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "list_locations" not in self._stubs:
+            self._stubs["list_locations"] = self.grpc_channel.unary_unary(
+                "/google.cloud.location.Locations/ListLocations",
+                request_serializer=locations_pb2.ListLocationsRequest.SerializeToString,
+                response_deserializer=locations_pb2.ListLocationsResponse.FromString,
+            )
+        return self._stubs["list_locations"]
+    {% endif %}
+
+    {% if "GetLocation" in api.mixin_api_methods %}
+    @property
+    def get_location(
+        self,
+    ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]:
+        r"""Return a callable for the list locations method over gRPC.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_location" not in self._stubs:
+            self._stubs["get_location"] = self.grpc_channel.unary_unary(
+                "/google.cloud.location.Locations/GetLocation",
+                request_serializer=locations_pb2.GetLocationRequest.SerializeToString,
+                response_deserializer=locations_pb2.Location.FromString,
+            )
+        return self._stubs["get_location"]
+    {% endif %}
+
+    {% endif %} {# Location #}
+
+    {# TODO: Remove after https://github.com/googleapis/gapic-generator-python/pull/1240 is merged. #}
+    {% if not opts.add_iam_methods and api.has_iam_mixin %}
+
+    {% if "SetIamPolicy" in api.mixin_api_methods %}
+    @property
+    def set_iam_policy(
+        self,
+    ) -> Callable[[iam_policy_pb2.SetIamPolicyRequest], policy_pb2.Policy]:
+        r"""Return a callable for the set iam policy method over gRPC.
+        Sets the IAM access control policy on the specified
+        function. Replaces any existing policy.
+        Returns:
+            Callable[[~.SetIamPolicyRequest],
+                    ~.Policy]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "set_iam_policy" not in self._stubs:
+            self._stubs["set_iam_policy"] = self.grpc_channel.unary_unary(
+                "/google.iam.v1.IAMPolicy/SetIamPolicy",
+                request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString,
+                response_deserializer=policy_pb2.Policy.FromString,
+            )
+        return self._stubs["set_iam_policy"]
+    {% endif %}
+
+    {% if "GetIamPolicy" in api.mixin_api_methods %}
+    @property
+    def get_iam_policy(
+        self,
+    ) -> Callable[[iam_policy_pb2.GetIamPolicyRequest], policy_pb2.Policy]:
+        r"""Return a callable for the get iam policy method over gRPC.
+        Gets the IAM access control policy for a function.
+        Returns an empty policy if the function exists and does
+        not have a policy set.
+        Returns:
+            Callable[[~.GetIamPolicyRequest],
+                    ~.Policy]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_iam_policy" not in self._stubs:
+            self._stubs["get_iam_policy"] = self.grpc_channel.unary_unary(
+                "/google.iam.v1.IAMPolicy/GetIamPolicy",
+                request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString,
+                response_deserializer=policy_pb2.Policy.FromString,
+            )
+        return self._stubs["get_iam_policy"]
+    {% endif %}
+
+    {% if "TestIamPermissions" in api.mixin_api_methods %}
+    @property
+    def test_iam_permissions(
+        self,
+    ) -> Callable[
+        [iam_policy_pb2.TestIamPermissionsRequest], iam_policy_pb2.TestIamPermissionsResponse
+    ]:
+        r"""Return a callable for the test iam permissions method over gRPC.
+        Tests the specified permissions against the IAM access control
+        policy for a function. If the function does not exist, this will
+        return an empty set of permissions, not a NOT_FOUND error.
+        Returns:
+            Callable[[~.TestIamPermissionsRequest],
+                    ~.TestIamPermissionsResponse]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "test_iam_permissions" not in self._stubs:
+            self._stubs["test_iam_permissions"] = self.grpc_channel.unary_unary(
+                "/google.iam.v1.IAMPolicy/TestIamPermissions",
+                request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString,
+                response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString,
+            )
+        return self._stubs["test_iam_permissions"]
+    {% endif %}
+    {% endif %} {# IAM #}
+
+    {% endif %} {# grpc is transport #}

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

@@ -22,10 +22,13 @@ from google.oauth2 import service_account # type: ignore
 {{ method.input.ident.python_import }}
 {{ method.output.ident.python_import }}
 {% endfor %}
-{% if opts.add_iam_methods %}
+{% if opts.add_iam_methods or api.has_iam_mixin %}
 from google.iam.v1 import iam_policy_pb2  # type: ignore
 from google.iam.v1 import policy_pb2  # type: ignore
 {% endif %}
+{% if api.has_location_mixin %}
+from google.cloud.location import locations_pb2 # type: ignore
+{% endif %}
 {% endfilter %}
 
 try:
@@ -169,7 +172,68 @@ class {{ service.name }}Transport(abc.ABC):
         raise NotImplementedError()
     {% endfor %}
 
+    {# TODO: Remove after https://github.com/googleapis/gapic-generator-python/pull/1240 is merged. #}
+    {% if not opts.add_iam_methods and api.has_iam_mixin %}
+    {% if "SetIamPolicy" in api.mixin_api_methods %}
+    @property
+    def set_iam_policy(
+        self,
+    ) -> Callable[
+        [iam_policy_pb2.SetIamPolicyRequest],
+        Union[policy_pb2.Policy, Awaitable[policy_pb2.Policy]],
+    ]:
+        raise NotImplementedError()
+    {% endif %}
+
+    {% if "GetIamPolicy" in api.mixin_api_methods %}
+    @property
+    def get_iam_policy(
+        self,
+    ) -> Callable[
+        [iam_policy_pb2.GetIamPolicyRequest],
+        Union[policy_pb2.Policy, Awaitable[policy_pb2.Policy]],
+    ]:
+        raise NotImplementedError()
+    {% endif %}
+
+    {% if "TestIamPermissions" in api.mixin_api_methods %}
+    @property
+    def test_iam_permissions(
+        self,
+    ) -> Callable[
+        [iam_policy_pb2.TestIamPermissionsRequest],
+        Union[
+            iam_policy_pb2.TestIamPermissionsResponse,
+            Awaitable[iam_policy_pb2.TestIamPermissionsResponse],
+        ],
+    ]:
+        raise NotImplementedError()
+    {% endif %}
+    {% endif %}
+
+    {% if api.has_location_mixin %}
+    {% if "GetLocation" in api.mixin_api_methods %}
+    @property
+    def get_location(self,
+    ) -> Callable[
+        [locations_pb2.GetLocationRequest],
+        Union[locations_pb2.Location, Awaitable[locations_pb2.Location]],
+    ]:
+        raise NotImplementedError()
+    {% endif %}
+
+    {% if "ListLocations" in api.mixin_api_methods %}
+    @property
+    def list_locations(self,
+    ) -> Callable[
+        [locations_pb2.ListLocationsRequest],
+        Union[locations_pb2.ListLocationsResponse, Awaitable[locations_pb2.ListLocationsResponse]],
+    ]:
+        raise NotImplementedError()
+    {% endif %}
+    {% endif %}
 
+    {# TODO: Remove after https://github.com/googleapis/gapic-generator-python/pull/1240 is merged. #}
     {% if opts.add_iam_methods %}
     @property
     def set_iam_policy(

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

@@ -21,10 +21,13 @@ import grpc  # type: ignore
 {{ method.input.ident.python_import }}
 {{ method.output.ident.python_import }}
 {% endfor %}
-{% if opts.add_iam_methods %}
+{% if opts.add_iam_methods or api.has_iam_mixin %}
 from google.iam.v1 import iam_policy_pb2  # type: ignore
 from google.iam.v1 import policy_pb2  # type: ignore
 {% endif %}
+{% if api.has_location_mixin %}
+from google.cloud.location import locations_pb2 # type: ignore
+{% endif %}
 {% endfilter %}
 from .base import {{ service.name }}Transport, DEFAULT_CLIENT_INFO
 
@@ -278,6 +281,7 @@ class {{ service.name }}GrpcTransport({{ service.name }}Transport):
         return self._stubs['{{ method.transport_safe_name|snake_case }}']
     {% endfor %}
 
+    {# TODO: Remove after https://github.com/googleapis/gapic-generator-python/pull/1240 is merged. #}
     {% if opts.add_iam_methods %}
     @property
     def set_iam_policy(
@@ -362,6 +366,8 @@ class {{ service.name }}GrpcTransport({{ service.name }}Transport):
     def close(self):
         self.grpc_channel.close()
 
+    {% include '%namespace/%name/%version/%sub/services/%service/transports/_mixins.py.j2' %}
+
 __all__ = (
     '{{ service.name }}GrpcTransport',
 )