Use vcs_version for Pants' version

3rdparty/python/pants_dev_requirements.txt

@@ -0,0 +1,4 @@
+# These requirements exist solely for the venv Pants runs in in this repo.
+debugpy==1.6.0
+pydevd-pycharm==203.5419.8
+setuptools_scm==8.0.4

3rdparty/python/requirements.txt

@@ -34,12 +34,6 @@ typing-extensions==4.3.0
 mypy-typing-asserts==0.1.1
 node-semver==0.9.0
 
-
-# These dependencies are only for debugging Pants itself (in VSCode/PyCharm respectively),
-# and should never be imported.
-debugpy==1.6.0
-pydevd-pycharm==203.5419.8
-
 # These dependencies must only be used from the explorer backend, and no code outside that backend
 # may import anything from it, so these libraries are not ending up as requirements of Pants itself.
 fastapi==0.78.0

build-support/pants_venv

@@ -9,6 +9,7 @@ source "${REPO_ROOT}/build-support/common.sh"
 
 REQUIREMENTS=(
   "${REPO_ROOT}/3rdparty/python/requirements.txt"
+  "${REPO_ROOT}/3rdparty/python/pants_dev_requirements.txt"
 )
 
 platform=$(uname -mps)

src/python/pants/BUILD

@@ -6,7 +6,7 @@ python_sources(
     overrides={
         # Enable `python -m pants ...` style execution ala `json.tool` or `venv`.
         "__main__.py": {"dependencies": ["src/python/pants/bin:pants_loader"]},
-        "version.py": {"dependencies": ["src/python/pants/_version:resources"]},
+        "version.py": {"dependencies": ["src/python/pants/_version:VERSION"]},
     },
 )
 

src/python/pants/_version/BUILD

@@ -3,4 +3,18 @@
 
 python_sources()
 
-resources(name="resources", sources=["VERSION"])
+vcs_version(
+    name="generated-version",
+    generate_to="pants/_version/VERSION",
+    # @TODO: This won't be as meaningful on `main`, as the dev number gets replaced with the "distance".
+    #   However, of all of the schemes the `-semver` ones are the only ones that allow for `.devN`
+    #   tags, and produce a valid version. "release-branch-semver" increments minor version which is
+    #   more misleading than "python-simplified-semver" which increments patch.
+    #   Use https://github.com/pypa/setuptools_scm/pull/1005 when we can.
+    version_scheme="python-simplified-semver",
+    local_scheme="no-local-version" if env("CI", "0") == "1" else None,
+    tag_regex=r"^release_(?P<version>[vV]?\d+(?:\.\d+){0,2}[^\+]*)$",
+    template="{version}",
+)
+
+experimental_wrap_as_resources(name="VERSION", inputs=[":generated-version"])

src/python/pants/backend/python/target_types.py

@@ -1674,11 +1674,33 @@ class VersionTemplateField(StringField):
     )
 
 
+class VersionVersionSchemeField(StringField):
+    alias = "version_scheme"
+    help = help_text(
+        """
+        The version scheme to configure `setuptools_scm` to use.
+        See https://setuptools-scm.readthedocs.io/en/latest/extending/#available-implementations
+        """
+    )
+
+
+class VersionLocalSchemeField(StringField):
+    alias = "local_scheme"
+    help = help_text(
+        """
+        The local scheme to configure `setuptools_scm` to use.
+        See https://setuptools-scm.readthedocs.io/en/latest/extending/#available-implementations_1
+        """
+    )
+
+
 class VCSVersion(Target):
     alias = "vcs_version"
     core_fields = (
         *COMMON_TARGET_FIELDS,
         VersionTagRegexField,
+        VersionVersionSchemeField,
+        VersionLocalSchemeField,
         VCSVersionDummySourceField,
         VersionGenerateToField,
         VersionTemplateField,

src/python/pants/backend/python/util_rules/vcs_versioning.py

@@ -22,9 +22,11 @@
     PythonSourceField,
     VCSVersion,
     VCSVersionDummySourceField,
+    VersionLocalSchemeField,
     VersionGenerateToField,
     VersionTagRegexField,
     VersionTemplateField,
+    VersionVersionSchemeField,
 )
 from pants.backend.python.util_rules.pex import PexRequest, VenvPex, VenvPexProcess
 from pants.core.util_rules.stripped_source_files import StrippedFileName, StrippedFileNameRequest
@@ -78,9 +80,12 @@ async def generate_python_from_setuptools_scm(
     # directory" and "where should I write output to".
     config: dict[str, dict[str, dict[str, str]]] = {}
     tool_config = config.setdefault("tool", {}).setdefault("setuptools_scm", {})
-    tag_regex = request.protocol_target[VersionTagRegexField].value
-    if tag_regex:
+    if tag_regex := request.protocol_target[VersionTagRegexField].value:
         tool_config["tag_regex"] = tag_regex
+    if version_scheme := request.protocol_target[VersionVersionSchemeField].value:
+        tool_config["version_scheme"] = version_scheme
+    if local_scheme := request.protocol_target[VersionLocalSchemeField].value:
+        tool_config["local_scheme"] = local_scheme
     config_path = "pyproject.synthetic.toml"
 
     input_digest_get = Get(

src/python/pants/bin/pants_runner.py

@@ -59,11 +59,11 @@ def _should_run_with_pantsd(self, global_bootstrap_options: OptionValueContainer
     def scrub_pythonpath() -> None:
         # Do not propagate any PYTHONPATH that happens to have been set in our environment
         # to our subprocesses.
-        # Note that don't warn (but still scrub) if RUNNING_PANTS_FROM_SOURCES is set. This allows
-        # scripts that run pants directly from sources, and therefore must set PYTHONPATH, to mute
+        # Note that don't warn if RUNNING_PANTS_FROM_SOURCES is set. This allows scripts that
+        # run pants directly from sources, and therefore must set PYTHONPATH, to mute
         # this warning.
         pythonpath = os.environ.pop("PYTHONPATH", None)
-        if pythonpath and not os.environ.pop("RUNNING_PANTS_FROM_SOURCES", None):
+        if pythonpath and not os.environ.get("RUNNING_PANTS_FROM_SOURCES", "0") == "1":
             logger.debug(f"Scrubbed PYTHONPATH={pythonpath} from the environment.")
 
     def run(self, start_time: float) -> ExitCode:

src/python/pants/version.py

@@ -56,11 +56,32 @@ def __ge__(self, other: Any):
 _PANTS_VERSION_OVERRIDE = "_PANTS_VERSION_OVERRIDE"
 
 
+# @TODO: Use https://github.com/pypa/setuptools_scm/pull/1005 when we can
+def _determine_version_from_pants_source():
+    from setuptools_scm import get_version  # pants: no-infer-dep
+
+    def version_scheme(version):
+        return version.format_with("{tag}")
+
+    val = get_version(
+        version_scheme=version_scheme,
+        tag_regex=r"^release_(?P<version>[vV]?\d+(?:\.\d+){0,2}[^\+]*)$",
+    )
+    return val
+
+
 VERSION: str = (
     # Do not remove/change this env var without coordinating with `pantsbuild/scie-pants` as it is
     # being used when bootstrapping Pants with a released version.
     os.environ.get(_PANTS_VERSION_OVERRIDE)
     or
+    # NB: This is only relevant for the Pants repo itself
+    (
+        _determine_version_from_pants_source()
+        if os.environ.get("RUNNING_PANTS_FROM_SOURCES", "0") == "1"
+        else None
+    )
+    or
     # NB: We expect VERSION to always have an entry and want a runtime failure if this is false.
     # NB: Since "pants" is the namespace for multiple packages, we need to put VERSION underneath
     # the tree that only the `pantsbuild.pants` package owns. Hence `pants._version`.

src/rust/engine/BUILD

@@ -6,7 +6,6 @@ files(
     sources=[
         "Cargo.lock",
         "build.rs",
-        "VERSION",
         "**/Cargo.toml",
         "**/*.rs",
         "!**/*tests.rs",

src/rust/engine/pantsd/src/lib.rs

@@ -338,7 +338,7 @@ pub fn fingerprinted_options(build_root: &BuildRoot) -> Result<Vec<Fingerprinted
         FingerprintedOption::new(option_id!("ignore", "warnings"), vec![]),
         FingerprintedOption::new(
             option_id!("pants", "version"),
-            include_str!("../../VERSION"),
+            "",  // @TODO: change
         ),
         FingerprintedOption::new(
             option_id!("pants", "workdir"),