Merge branch 'master' into self-signed-jwt

Author: bshaffer

.github/CODEOWNERS

@@ -4,5 +4,5 @@
 # For syntax help see:
 # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
 
-* @googleapis/actools-python @googleapis/yoshi-python @lukesneeringer
-*.yaml @googleapis/actools @googleapis/yoshi-python @googleapis/actools-python @lukesneeringer
+* @googleapis/actools-python @googleapis/yoshi-python
+*.yaml @googleapis/actools @googleapis/yoshi-python @googleapis/actools-python

.github/workflows/tests.yaml

@@ -310,4 +310,4 @@ jobs:
             python -m pip install autopep8
       - name: Check diff
         run: |
-            find gapic tests -name "*.py" | xargs autopep8 --in-place --exit-code
+            find gapic tests -name "*.py" | xargs autopep8 --diff --exit-code

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+### [0.42.2](https://www.github.com/googleapis/gapic-generator-python/compare/v0.42.1...v0.42.2) (2021-03-05)
+
+
+### Bug Fixes
+
+* s/grpcAsync/grpc-async for gapic metadata ([#803](https://www.github.com/googleapis/gapic-generator-python/issues/803)) ([96f7864](https://www.github.com/googleapis/gapic-generator-python/commit/96f78640d90cf50c6b525924d14c6afe31874be6))
+
+### [0.42.1](https://www.github.com/googleapis/gapic-generator-python/compare/v0.42.0...v0.42.1) (2021-03-04)
+
+
+### Bug Fixes
+
+* corner case fix for empty request generated test ([#801](https://www.github.com/googleapis/gapic-generator-python/issues/801)) ([039dc71](https://www.github.com/googleapis/gapic-generator-python/commit/039dc713fed291142058741e1138da5a4bec542f))
+
+## [0.42.0](https://www.github.com/googleapis/gapic-generator-python/compare/v0.41.0...v0.42.0) (2021-03-03)
+
+
+### Features
+
+* add flag for gapic metadata ([#795](https://www.github.com/googleapis/gapic-generator-python/issues/795)) ([9cd7664](https://www.github.com/googleapis/gapic-generator-python/commit/9cd7664141835edcd8970629d9cf3abe4b7fd7c4))
+
+## [0.41.0](https://www.github.com/googleapis/gapic-generator-python/compare/v0.40.12...v0.41.0) (2021-03-02)
+
+
+### Features
+
+* add gapic metadata file ([#781](https://www.github.com/googleapis/gapic-generator-python/issues/781)) ([5dd8fcc](https://www.github.com/googleapis/gapic-generator-python/commit/5dd8fccf6b4da57edef0347beb07102634daa992))
+
 ### [0.40.12](https://www.github.com/googleapis/gapic-generator-python/compare/v0.40.11...v0.40.12) (2021-02-26)
 
 

gapic/ads-templates/%namespace/%name/%version/__init__.py.j2

@@ -11,18 +11,18 @@ if sys.version_info < (3, 7):
 
 _lazy_type_to_package_map = {
     # Message types
-{%- for message in api.top_level_messages.values() %}
+{%- for _, message in api.top_level_messages|dictsort %}
     '{{ message.name }}': '{{ message.ident.package|join('.') }}.types.{{ message.ident.module }}',
 {%- endfor %}
-  
+
     # Enum types
-{%- for enum in api.top_level_enums.values() %}
+{%- for _, enum in api.top_level_enums|dictsort %}
     '{{ enum.name }}': '{{ enum.ident.package|join('.') }}.types.{{enum.ident.module }}',
 {%- endfor %}
-  
+
     {# TODO(yon-mg): add rest transport service once I know what this is #}
-    # Client classes and transports  
-{%- for service in api.services.values() %}
+    # Client classes and transports
+{%- for _, service in api.services|dictsort %}
     '{{ service.client_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}',
     '{{ service.transport_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}.transports',
     '{{ service.grpc_transport_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}.transports',

gapic/ads-templates/%namespace/%name/%version/gapic_metadata.json.j2

@@ -0,0 +1 @@
+{# {{ api.gapic_metadata_json(opts) }} #} {# TODO(dovs): This is temporarily commented out pending the addition of a flag #}

gapic/ads-templates/%namespace/%name/__init__.py.j2

@@ -11,18 +11,18 @@ if sys.version_info < (3, 7):
 
 _lazy_type_to_package_map = {
     # Message types
-{%- for message in api.top_level_messages.values() %}
+{%- for _, message in api.top_level_messages|dictsort %}
     '{{ message.name }}': '{{ message.ident.package|join('.') }}.types.{{ message.ident.module }}',
 {%- endfor %}
-  
+
     # Enum types
-{%- for enum in api.top_level_enums.values() %}
+{%- for _, enum in api.top_level_enums|dictsort %}
     '{{ enum.name }}': '{{ enum.ident.package|join('.') }}.types.{{enum.ident.module }}',
 {%- endfor %}
-  
+
     {# TODO(yon-mg): add rest transport service once I know what this is #}
-    # Client classes and transports  
-{%- for service in api.services.values() %}
+    # Client classes and transports
+{%- for _, service in api.services|dictsort %}
     '{{ service.client_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}',
     '{{ service.transport_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}.transports',
     '{{ service.grpc_transport_name }}': '{{ service.meta.address.package|join('.') }}.services.{{ service.meta.address.module }}.transports',
@@ -90,7 +90,7 @@ from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.'
 __all__ = (
 {%- filter indent %}
 {% filter sort_lines -%}
-{% for subpackage in api.subpackages.keys() -%}
+{% for subpackage, _ in api.subpackages|dictsort -%}
 '{{ subpackage }}',
 {% endfor -%}
 {% for service in api.services.values()|sort(attribute='name')

gapic/cli/generate.py

@@ -47,10 +47,11 @@ def generate(
     # This generator uses a slightly different mechanism for determining
     # which files to generate; it tracks at package level rather than file
     # level.
-    package = os.path.commonprefix([i.package for i in filter(
-        lambda p: p.name in req.file_to_generate,
-        req.proto_file,
-    )]).rstrip('.')
+    package = os.path.commonprefix([
+        p.package
+        for p in req.proto_file
+        if p.name in req.file_to_generate
+    ]).rstrip('.')
 
     # Build the API model object.
     # This object is a frozen representation of the whole API, and is sent

gapic/generator/generator.py

@@ -105,11 +105,12 @@ def get_response(
                     template_name, api_schema=api_schema, opts=opts)
             )
 
-        output_files.update(
-            self._generate_samples_and_manifest(
-                api_schema, self._env.get_template(sample_templates[0]),
-            )
-        )
+        sample_output = self._generate_samples_and_manifest(
+            api_schema,
+            self._env.get_template(sample_templates[0]),
+        ) if sample_templates else {}
+
+        output_files.update(sample_output)
 
         # Return the CodeGeneratorResponse output.
         res = CodeGeneratorResponse(
@@ -233,6 +234,10 @@ def _render_template(
         answer: Dict[str, CodeGeneratorResponse.File] = OrderedDict()
         skip_subpackages = False
 
+        # Very, very special case. This flag exists to gate this one file.
+        if not opts.metadata and template_name.endswith("gapic_metadata.json.j2"):
+            return answer
+
         # Sanity check: Rendering per service and per proto would be a
         # combinatorial explosion and is almost certainly not what anyone
         # ever wants. Error colorfully on it.

gapic/schema/api.py

@@ -28,8 +28,10 @@
 
 from google.api_core import exceptions  # type: ignore
 from google.api import resource_pb2  # type: ignore
+from google.gapic.metadata import gapic_metadata_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import descriptor_pb2
+from google.protobuf.json_format import MessageToJson
 
 import grpc  # type: ignore
 
@@ -392,6 +394,45 @@ def subpackages(self) -> Mapping[str, 'API']:
                                                       )
         return answer
 
+    def gapic_metadata(self, options: Options) -> gapic_metadata_pb2.GapicMetadata:
+        gm = gapic_metadata_pb2.GapicMetadata(
+            schema="1.0",
+            comment="This file maps proto services/RPCs to the corresponding library clients/methods",
+            language="python",
+            proto_package=self.naming.proto_package,
+            library_package=".".join(
+                self.naming.module_namespace +
+                    (self.naming.versioned_module_name,)
+            ),
+        )
+
+        for service in sorted(self.services.values(), key=lambda s: s.name):
+            service_desc = gm.services.get_or_create(service.name)
+
+            # At least one of "grpc" or "rest" is guaranteed to be present because
+            # of the way that Options instances are created.
+            # This assumes the options are generated by the class method factory.
+            transports = []
+            if "grpc" in options.transport:
+                transports.append(("grpc", service.client_name))
+                transports.append(("grpc-async", service.async_client_name))
+
+            if "rest" in options.transport:
+                transports.append(("rest", service.client_name))
+
+            methods = sorted(service.methods.values(), key=lambda m: m.name)
+            for tprt, client_name in transports:
+                transport = service_desc.clients.get_or_create(tprt)
+                transport.library_client = client_name
+                for method in methods:
+                    method_desc = transport.rpcs.get_or_create(method.name)
+                    method_desc.methods.append(to_snake_case(method.name))
+
+        return gm
+
+    def gapic_metadata_json(self, options: Options) -> str:
+        return MessageToJson(self.gapic_metadata(options), sort_keys=True)
+
     def requires_package(self, pkg: Tuple[str, ...]) -> bool:
         return any(
             message.ident.package == pkg

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

@@ -2,7 +2,7 @@
 
 {% block content %}
 {#  Import subpackages. -#}
-{% for subpackage in api.subpackages.keys() -%}
+{% for subpackage, _ in api.subpackages|dictsort -%}
 from . import {{ subpackage }}
 {% endfor -%}