feat: add gapic-version generator option (#2440)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: parthea

gapic/samplegen_utils/snippet_index.py

@@ -119,9 +119,7 @@ def __init__(self, api_schema: api.API):
         )
         self.metadata_index.client_library.language = snippet_metadata_pb2.Language.PYTHON  # type: ignore
 
-        # This is just a placeholder.  release-please is responsible for
-        # updating the metadata file to the correct library version.
-        self.metadata_index.client_library.version = "0.1.0"
+        self.metadata_index.client_library.version = api_schema.gapic_version
 
         self.metadata_index.client_library.apis.append(
             snippet_metadata_pb2.Api(  # type: ignore

gapic/schema/api.py

@@ -378,6 +378,7 @@ class API:
     all_protos: Mapping[str, Proto]
     service_yaml_config: service_pb2.Service
     subpackage_view: Tuple[str, ...] = dataclasses.field(default_factory=tuple)
+    gapic_version: str = "0.0.0"
 
     @classmethod
     def build(
@@ -493,12 +494,16 @@ def disambiguate_keyword_sanitize_fname(
         ParseDict(
             opts.service_yaml_config, service_yaml_config, ignore_unknown_fields=True
         )
+        gapic_version = opts.gapic_version
 
         # Third pass for various selective GAPIC settings; these require
         # settings in the service.yaml and so we build the API object
         # before doing another pass.
         api = cls(
-            naming=naming, all_protos=protos, service_yaml_config=service_yaml_config
+            naming=naming,
+            all_protos=protos,
+            service_yaml_config=service_yaml_config,
+            gapic_version=gapic_version,
         )
 
         if package in api.all_library_settings:

gapic/templates/%namespace/%name/gapic_version.py.j2

@@ -1,5 +1,5 @@
 {% extends '_base.py.j2' %}
 {% block content %}
 
-__version__ = "0.0.0"  # {x-release-please-version}
+__version__ = "{{ api.gapic_version }}"  # {x-release-please-version}
 {% endblock %}

gapic/templates/%namespace/%name_%version/gapic_version.py.j2

@@ -1,5 +1,5 @@
 {% extends '_base.py.j2' %}
 {% block content %}
 
-__version__ = "0.0.0"  # {x-release-please-version}
+__version__ = "{{ api.gapic_version }}"  # {x-release-please-version}
 {% endblock %}

gapic/utils/options.py

@@ -50,6 +50,7 @@ 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=("",))
+    gapic_version: str = "0.0.0"
 
     # Class constants
     PYTHON_GAPIC_PREFIX: str = "python-gapic-"
@@ -71,6 +72,7 @@ class Options:
             # proto plus dependencies delineated by '+'
             # For example, 'google.cloud.api.v1+google.cloud.anotherapi.v2'
             "proto-plus-deps",
+            "gapic-version",  # A version string following https://peps.python.org/pep-0440
         )
     )
 
@@ -197,6 +199,7 @@ def tweak_path(p):
             service_yaml_config=service_yaml_config,
             rest_numeric_enums=bool(opts.pop("rest-numeric-enums", False)),
             proto_plus_deps=proto_plus_deps,
+            gapic_version=opts.pop("gapic-version", ["0.0.0"]).pop(),
         )
 
         # Note: if we ever need to recursively check directories for sample

tests/integration/BUILD.bazel

@@ -55,6 +55,7 @@ py_gapic_library(
     grpc_service_config = "cloudasset_grpc_service_config.json",
     opt_args = [
         "autogen-snippets",
+        "gapic-version=1.2.99",
     ],
     service_yaml = "cloudasset_v1.yaml",
     transport = "grpc+rest",

tests/integration/goldens/asset/google/cloud/asset/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.0.0"  # {x-release-please-version}
+__version__ = "1.2.99"  # {x-release-please-version}

tests/integration/goldens/asset/google/cloud/asset_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.0.0"  # {x-release-please-version}
+__version__ = "1.2.99"  # {x-release-please-version}

tests/integration/goldens/asset/samples/generated_samples/snippet_metadata_google.cloud.asset.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-asset",
-    "version": "0.1.0"
+    "version": "1.2.99"
   },
   "snippets": [
     {

tests/integration/goldens/credentials/samples/generated_samples/snippet_metadata_google.iam.credentials.v1.json

@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-iam-credentials",
-    "version": "0.1.0"
+    "version": "0.0.0"
   },
   "snippets": [
     {