Merge pull request #1286 from effigies/scm_version_sentinel

RonnyPfannschmidt · web-flow · commit 8c23c5b87885 · 2026-03-27T16:03:01.000+01:00
fix: Use missing-argument sentinel for dump_version argument
diff --git a/setuptools-scm/changelog.d/1286.bugfix.md b/setuptools-scm/changelog.d/1286.bugfix.md
@@ -0,0 +1 @@
+Allow `dump_version()` deprecation warning to be silenced by passing `scm_version=None`.
diff --git a/setuptools-scm/testing_scm/test_functions.py b/setuptools-scm/testing_scm/test_functions.py
@@ -125,15 +125,14 @@ def test_write_version_to_path_deprecation_warning_none(tmp_path: Path) -> None:
 
     target_file = tmp_path / "version.py"
 
-    # This should raise a deprecation warning when scm_version=None is explicitly passed
+    # This should raise a deprecation warning when scm_version=None is not explicitly passed
     with pytest.warns(
         DeprecationWarning, match="write_version_to_path called without scm_version"
     ):
         write_version_to_path(
             target=target_file,
             template=None,  # Use default template
             version="1.2.3",
-            scm_version=None,  # Explicitly passing None should warn
         )
 
     # Verify the file was created and contains the expected content
diff --git a/vcs-versioning/src/vcs_versioning/_dump_version.py b/vcs-versioning/src/vcs_versioning/_dump_version.py
@@ -16,6 +16,17 @@
 log = logging.getLogger(__name__)
 
 
+class MISSING:
+    def __repr__(self) -> str:
+        return "<MISSING>"
+
+    def __bool__(self) -> bool:
+        return False
+
+
+MISSING_VAL = MISSING()
+
+
 DEFAULT_TEMPLATES = {
     ".py": """\
 # file generated by vcs-versioning
@@ -89,7 +100,7 @@ def write_version_to_path(
     target: Path,
     template: str | None,
     version: str,
-    scm_version: ScmVersion | None = None,
+    scm_version: ScmVersion | MISSING | None = MISSING_VAL,
 ) -> None:
     """Write version information to a file using a template.
 
@@ -102,7 +113,7 @@ def write_version_to_path(
     final_template = _validate_template(target, template)
     log.debug("dump %s into %s", version, target)
     version_tuple = _version_as_tuple(version)
-    if scm_version is None:
+    if scm_version is MISSING_VAL:
         warnings.warn(
             "write_version_to_path called without scm_version parameter. "
             "This will be required in a future version. "
@@ -125,7 +136,7 @@ def dump_version(
     version: str,
     write_to: _t.PathT,
     template: str | None = None,
-    scm_version: ScmVersion | None = None,
+    scm_version: ScmVersion | MISSING | None = MISSING_VAL,
 ) -> None:
     """Write version information to a file relative to root.
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Allow `dump_version()` deprecation warning to be silenced by passing `scm_version=None`.