feat: add autogenerated snippets

gapic/generator/generator.py

@@ -14,9 +14,10 @@
 
 import jinja2
 import yaml
+import itertools
 import re
 import os
-from typing import Any, DefaultDict, Dict, Mapping
+from typing import Any, DefaultDict, Dict, Generator, Mapping
 from hashlib import sha256
 from collections import OrderedDict, defaultdict
 from gapic.samplegen_utils.utils import coerce_response_name, is_valid_sample_cfg
@@ -106,25 +107,59 @@ def get_response(
             )
 
         sample_output = self._generate_samples_and_manifest(
-            api_schema,
-            self._env.get_template(sample_templates[0]),
-        ) if sample_templates else {}
-
+                api_schema, self._env.get_template(sample_templates[0]),
+                opts=opts,
+            )
         output_files.update(sample_output)
 
+
         # Return the CodeGeneratorResponse output.
         res = CodeGeneratorResponse(
             file=[i for i in output_files.values()])  # type: ignore
         res.supported_features |= CodeGeneratorResponse.Feature.FEATURE_PROTO3_OPTIONAL  # type: ignore
         return res
 
+
+    def _generate_sample_specs(self, api_schema: api.API, *, opts):
+        """Given an API, generate rudimentary sample specs."""
+
+        sample_specs = []
+
+        gapic_metadata = api_schema.gapic_metadata(opts)
+
+        # Loop through the method list
+        for service_name, service in gapic_metadata.services.items():
+            raise Exception(f"duplicate entries for {service.clients}")
+            for client_name, client in service.clients.items():
+
+                for rpc_name, method_list in client.rpcs.items():
+                    # generated_${api}_${apiVersion}_${serviceName}_${rpcName}_{sync|async}
+
+                    region_tag = f"generated_{api_schema.naming.versioned_module_name}_{service_name}_{rpc_name}_sync"
+                    spec = {
+                        "sample_type": "standalone",
+                        "rpc": rpc_name,
+                        "request": {},
+                        "response": {},
+                        "service": f"{api_schema.naming.proto_package}.{service_name}",
+                        "region_tag": region_tag,
+                        "description": f"Snippet for {utils.to_snake_case(rpc_name)}"
+                    }
+
+                    sample_specs.append(spec)
+
+        return sample_specs
+
+
+
     def _generate_samples_and_manifest(
-        self, api_schema: api.API, sample_template: jinja2.Template,
-    ) -> Dict[str, CodeGeneratorResponse.File]:
+        self, api_schema: api.API, sample_template: jinja2.Template, *, opts: Options) -> Dict:
         """Generate samples and samplegen manifest for the API.
 
         Arguments:
             api_schema (api.API): The schema for the API to which the samples belong.
+            sample_template (jinja2.Template): The template to use to generate samples.
+            opts (Options): Additional generator options.
 
         Returns:
             Dict[str, CodeGeneratorResponse.File]: A dict mapping filepath to rendered file.
@@ -135,12 +170,16 @@ def _generate_samples_and_manifest(
         id_to_hash_to_spec: DefaultDict[str,
                                         Dict[str, Any]] = defaultdict(dict)
 
+        spec_generator = ()
+
         STANDALONE_TYPE = "standalone"
+
+        # Process optional handwritten configs
         for config_fpath in self._sample_configs:
             with open(config_fpath) as f:
                 configs = yaml.safe_load_all(f.read())
 
-            spec_generator = (
+            spec_generator = itertools.chain(spec_generator, (
                 spec
                 for cfg in configs
                 if is_valid_sample_cfg(cfg)
@@ -149,41 +188,44 @@ def _generate_samples_and_manifest(
                 # If sample_types are specified, standalone samples must be
                 # explicitly enabled.
                 if STANDALONE_TYPE in spec.get("sample_type", [STANDALONE_TYPE])
-            )
+            ))
+
+        # Add autogenerated sample configs
+        generated_specs = self._generate_sample_specs(api_schema, opts=opts)
+        spec_generator = itertools.chain(spec_generator, generated_specs)
+
+        for spec in spec_generator:
+            # Every sample requires an ID. This may be provided
+            # by a samplegen config author.
+            # If no ID is provided, fall back to the region tag.
+            #
+            # Ideally the sample author should pick a descriptive, unique ID,
+            # but this may be impractical and can be error-prone.
+            spec_hash = sha256(str(spec).encode("utf8")).hexdigest()[:8]
+            sample_id = spec.get("id") or spec["region_tag"]
+            spec["id"] = sample_id
+
+            hash_to_spec = id_to_hash_to_spec[sample_id]
+
+            if spec_hash in hash_to_spec:
+                raise DuplicateSample(
+                    f"Duplicate samplegen spec found: {spec}")
+
+            hash_to_spec[spec_hash] = spec
 
-            for spec in spec_generator:
-                # Every sample requires an ID, preferably provided by the
-                # samplegen config author.
-                # If no ID is provided, fall back to the region tag.
-                # If there's no region tag, generate a unique ID.
-                #
-                # Ideally the sample author should pick a descriptive, unique ID,
-                # but this may be impractical and can be error-prone.
-                spec_hash = sha256(str(spec).encode("utf8")).hexdigest()[:8]
-                sample_id = spec.get("id") or spec.get(
-                    "region_tag") or spec_hash
-                spec["id"] = sample_id
-
-                hash_to_spec = id_to_hash_to_spec[sample_id]
-                if spec_hash in hash_to_spec:
-                    raise DuplicateSample(
-                        f"Duplicate samplegen spec found: {spec}")
-
-                hash_to_spec[spec_hash] = spec
-
-        out_dir = "samples"
+        out_dir = "samples/generated_samples"
         fpath_to_spec_and_rendered = {}
         for hash_to_spec in id_to_hash_to_spec.values():
             for spec_hash, spec in hash_to_spec.items():
                 id_is_unique = len(hash_to_spec) == 1
-                # The ID is used to generate the file name and by sample tester
-                # to link filenames to invoked samples. It must be globally unique.
+                # The ID is used to generate the file name. It must be globally unique.
                 if not id_is_unique:
                     spec["id"] += f"_{spec_hash}"
 
                 sample = samplegen.generate_sample(
                     spec, api_schema, sample_template,)
 
+                # TODO: Make the samples have snake_case names
                 fpath = spec["id"] + ".py"
                 fpath_to_spec_and_rendered[os.path.join(out_dir, fpath)] = (
                     spec,
@@ -197,7 +239,6 @@ def _generate_samples_and_manifest(
             for fname, (_, sample) in fpath_to_spec_and_rendered.items()
         }
 
-        # Only generate a manifest if we generated samples.
         if output_files:
             manifest_fname, manifest_doc = manifest.generate(
                 (

gapic/samplegen/samplegen.py

@@ -880,10 +880,7 @@ def generate_sample(
 
     return sample_template.render(
         sample=sample,
-        imports=[
-            "from google import auth",
-            "from google.auth import credentials",
-        ],
+        imports=[],
         calling_form=calling_form,
         calling_form_enum=types.CallingForm,
         api=api_schema,

gapic/templates/examples/feature_fragments.j2

@@ -27,10 +27,14 @@ There is a little, but not enough for it to be important because
 
 {% macro sample_header(sample, calling_form) %}
 
-# DO NOT EDIT! This is a generated sample ("{{ calling_form }}",  "{{ sample.id }}")
+# Generated code. DO NOT EDIT!
 #
+# Snippet for {{ sample.rpc }}
+# NOTE: This snippet has been automatically generated for illustrative purposes only.
+# It may require modifications to work in your environment.
+
 # To install the latest published package dependency, execute the following:
-#   pip3 install {{ sample.package_name }}
+#   python3 -m pip install {{ sample.package_name }}
 {% endmacro %}
 
 {% macro print_string_formatting(string_list) %}

gapic/templates/examples/sample.py.j2

@@ -1,18 +1,3 @@
-{#
- # Copyright (C) 2019  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.
-#}
 {% extends "_base.py.j2" %}
 
 {% block content %}
@@ -26,23 +11,24 @@
 {% for import_statement in imports %}
 {{ import_statement }}
 {% endfor %}
-from {{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + service.meta.address.subpackage)|join(".") }}.services.{{ service.name|snake_case }} import {{ service.client_name }}
+from {{ api.naming.module_namespace|join(".") }} import {{ api.naming.versioned_module_name }}
 
 {# also need calling form #}
 def sample_{{ frags.render_method_name(sample.rpc)|trim -}}({{ frags.print_input_params(sample.request)|trim -}}):
     """{{ sample.description }}"""
 
-    client = {{ service.client_name }}(
-        credentials=credentials.AnonymousCredentials(),
-        transport="grpc",
-    )
+    # Create client
+    client = {{ api.naming.versioned_module_name }}.{{ service.client_name }}()
 
-    {{ frags.render_request_setup(sample.request)|indent }} 
+    {# TODO: Enable detailed request setup #}
+    {# {{ frags.render_request_setup(sample.request)|indent }} #}
 {% with method_call = frags.render_method_call(sample, calling_form, calling_form_enum) %} 
+    # Make the request
     {{ frags.render_calling_form(method_call, calling_form, calling_form_enum, sample.response, )|indent -}} 
 {% endwith %} 
 
 # [END {{ sample.id }}]
 
-{{ frags.render_main_block(sample.rpc, sample.request) }} 
+{# TODO: Enable main block (or decide to remove main block from python sample) #}
+{# {{ frags.render_main_block(sample.rpc, sample.request) }} #} 
 {%- endblock %}

gapic/utils/options.py

@@ -138,8 +138,9 @@ def tweak_path(p):
             retry=retry_cfg,
             sample_configs=tuple(
                 cfg_path
-                for s in sample_paths
-                for cfg_path in samplegen_utils.generate_all_sample_fpaths(s)
+                for cfg_path in sample_paths
+                #for s in sample_paths
+                #for cfg_path in samplegen_utils.generate_all_sample_fpaths(s)
             ),
             templates=tuple(path.expanduser(i) for i in templates),
             lazy_import=bool(opts.pop('lazy-import', False)),