wip

Author: parthea

gapic/generator/generator.py

@@ -269,11 +269,19 @@ def _render_template(
         # library. This means that the module names will need to be versioned in
         # import statements. For example `import google.cloud.library_v2` instead
         # of `import google.cloud.library`.
+        # If default version is specified, and doesn't match the current version being generated or
+        # `python_settings.experimental_features.unversioned_package_disabled` is set
         if (
-            template_name.startswith("%namespace/%name/")
-            and api_schema.all_library_settings[
-                api_schema.naming.proto_package
-            ].python_settings.experimental_features.unversioned_package_disabled
+            (
+                template_name.startswith("%namespace/%name/")
+                and api_schema.all_library_settings[
+                    api_schema.naming.proto_package
+                ].python_settings.experimental_features.unversioned_package_disabled
+             ) or
+             (
+                 len(opts.default_version) > 0 and
+                 opts.default_version != api_schema.naming.version
+             )
         ):
             return answer
 

gapic/schema/naming.py

@@ -45,7 +45,9 @@ class Naming(abc.ABC):
     proto_package: str = ""
     _warehouse_package_name: str = ""
     proto_plus_deps: Tuple[str, ...] = dataclasses.field(default_factory=tuple)
+    non_default_versions: Tuple[str, ...] = dataclasses.field(default_factory=tuple)
     api_description: str = ""
+    default_version: str = ""
     _documentation_name: str = ""
     documentation_uri: str = ""
     release_level: str = ""
@@ -160,11 +162,21 @@ def build(
                 package_info, _warehouse_package_name=opts.warehouse_package_name
             )
 
+        if opts.non_default_versions:
+            package_info = dataclasses.replace(
+                package_info, non_default_versions=opts.non_default_versions
+            )
+
         if opts.api_description:
             package_info = dataclasses.replace(
                 package_info, api_description=opts.api_description
             )
 
+        if opts.default_version:
+            package_info = dataclasses.replace(
+                package_info, default_version=opts.default_version
+            )
+
         if opts.documentation_name:
             package_info = dataclasses.replace(
                 package_info, _documentation_name=opts.documentation_name

gapic/templates/docs/index.rst.j2

@@ -10,7 +10,15 @@ API Reference
 
     {{ api.naming.versioned_module_name }}/services_
     {{ api.naming.versioned_module_name }}/types_
-
+{% for api_version in api.naming.non_default_versions %}
+API Reference
+-------------
+.. toctree::
+    :maxdepth: 2
+    
+    {{ api_version }}/services_
+    {{ api_version }}/types_
+{% endfor %}
 
 Changelog
 ---------

gapic/utils/options.py

@@ -50,7 +50,9 @@ class Options:
     service_yaml_config: Dict[str, Any] = dataclasses.field(default_factory=dict)
     rest_numeric_enums: bool = False
     proto_plus_deps: Tuple[str, ...] = dataclasses.field(default=("",))
+    non_default_versions: Tuple[str, ...] = dataclasses.field(default=("",))
     api_description: str = ""
+    default_version: str = ""
     documentation_name: str = ""
     documentation_uri: str = ""
     release_level: str = ""
@@ -75,6 +77,7 @@ class Options:
             "rest-numeric-enums",
             # proto plus dependencies delineated by '+'
             # For example, 'google.cloud.api.v1+google.cloud.anotherapi.v2'
+            "non-default-versions",
             "proto-plus-deps",
             "release-level",  # One of ["preview", "stable"]
             "documentation-name",
@@ -187,6 +190,10 @@ def tweak_path(p):
         if old_naming:
             autogen_snippets = False
 
+        non_default_versions = tuple(opts.pop("non-default-versions", ""))
+        if len(non_default_versions):
+            non_default_versions = tuple(non_default_versions[0].split("+"))
+
         proto_plus_deps = tuple(opts.pop("proto-plus-deps", ""))
         if len(proto_plus_deps):
             proto_plus_deps = tuple(proto_plus_deps[0].split("+"))
@@ -211,14 +218,16 @@ def tweak_path(p):
             transport=opts.pop("transport", ["grpc"])[0].split("+"),
             service_yaml_config=service_yaml_config,
             rest_numeric_enums=bool(opts.pop("rest-numeric-enums", False)),
-            title=service_yaml_config.get("title", ""),
+            non_default_versions=non_default_versions,
+            default_version=opts.pop("default-version", [""]).pop(),
             documentation_name=opts.pop("documentation-name", [""]).pop(),
             documentation_uri=documentation_uri,
             api_description=api_description,
             proto_plus_deps=proto_plus_deps,
             release_level=opts.pop(
                 "release-level", ["preview"]
             ).pop(),  # Default to "preview" unless explicitly set to "stable"
+            title=service_yaml_config.get("title", ""),
         )
 
         # Note: if we ever need to recursively check directories for sample

tests/unit/generator/test_options.py

@@ -225,6 +225,35 @@ def test_options_autogen_snippets_false_for_old_naming():
     assert not options.autogen_snippets
 
 
+def test_options_non_default_versions():
+    opts = Options.build("non-default-versions=")
+    assert opts.non_default_versions == ("",)
+
+    opts = Options.build("non-default-versions=google.apps.script.type.calendar")
+    assert opts.non_default_versions == ("google.apps.script.type.calendar",)
+
+    opts = Options.build(
+        "non-default-versions=\
+google.apps.script.type.calendar+\
+google.apps.script.type.docs+\
+google.apps.script.type.drive+\
+google.apps.script.type.gmail+\
+google.apps.script.type.sheets+\
+google.apps.script.type.slides+\
+google.apps.script.type"
+    )
+
+    assert opts.non_default_versions == (
+        "google.apps.script.type.calendar",
+        "google.apps.script.type.docs",
+        "google.apps.script.type.drive",
+        "google.apps.script.type.gmail",
+        "google.apps.script.type.sheets",
+        "google.apps.script.type.slides",
+        "google.apps.script.type",
+    )
+
+
 def test_options_proto_plus_deps():
     opts = Options.build("proto-plus-deps=")
     assert opts.proto_plus_deps == ("",)

tests/unit/schema/test_naming.py

@@ -298,6 +298,17 @@ def test_cli_override_documentation_uri():
     assert n.documentation_uri == "https://cloud.google.com/testoverride"
 
 
+def test_cli_override_default_version():
+    FileDesc = descriptor_pb2.FileDescriptorProto
+    proto1 = FileDesc(package="google.translation.v1")
+    n = naming.Naming.build(
+        proto1,
+        opts=Options(default_version="v1"),
+    )
+    assert n.default_version == "v1"
+
+
+
 def test_build_factory():
     proto = descriptor_pb2.FileDescriptorProto(package="google.mollusc.v1alpha1")
     old = naming.Naming.build(proto, opts=Options(old_naming=True))