Merge pull request #904 from RonnyPfannschmidt/compat

prepare safer backward compatibility

Author: RonnyPfannschmidt

src/setuptools_scm/__init__.py

@@ -4,70 +4,20 @@
 """
 from __future__ import annotations
 
-from typing import Any
-from typing import Pattern
-
-from . import _config
-from . import _types as _t
 from ._config import Configuration
+from ._get_version_impl import _get_version  # soft deprecated
+from ._get_version_impl import get_version  # soft deprecated
+from ._integration.dump_version import dump_version  # soft deprecated
 from ._version_cls import NonNormalizedVersion
 from ._version_cls import Version
 from .version import ScmVersion
 
 
-def dump_version(
-    root: _t.PathT,
-    version: str,
-    write_to: _t.PathT,
-    template: str | None = None,
-    scm_version: ScmVersion | None = None,
-) -> None:
-    """soft deprecated helper to write the version file in the cwd
-
-    still used by hatch-vcs, will be removed after upstream uses the modern patterns
-    """
-    from ._integration.dump_version import dump_version as real
-
-    return real(root, version, write_to, template, scm_version)
-
-
-def get_version(
-    root: _t.PathT = ".",
-    version_scheme: _t.VERSION_SCHEME = _config.DEFAULT_VERSION_SCHEME,
-    local_scheme: _t.VERSION_SCHEME = _config.DEFAULT_LOCAL_SCHEME,
-    write_to: _t.PathT | None = None,
-    write_to_template: str | None = None,
-    version_file: _t.PathT | None = None,
-    version_file_template: str | None = None,
-    relative_to: _t.PathT | None = None,
-    tag_regex: str | Pattern[str] = _config.DEFAULT_TAG_REGEX,
-    parentdir_prefix_version: str | None = None,
-    fallback_version: str | None = None,
-    fallback_root: _t.PathT = ".",
-    parse: Any | None = None,
-    git_describe_command: _t.CMD_TYPE | None = None,
-    dist_name: str | None = None,
-    version_cls: Any | None = None,
-    normalize: bool = True,
-    search_parent_directories: bool = False,
-) -> str:
-    """
-    soft deprecated helper to obtain the vcs version
-    its misused at runtime in numerous projects and has to stay for now
-
-    a replacement supporting editable installation in hatch/setuptools is planned
-    """
-
-    params = {**locals()}
-    from ._get_version import get_version
-
-    return get_version(**params)
-
-
 # Public API
 __all__ = [
-    "get_version",
-    "dump_version",
+    "get_version",  # deprecated imported for backward compatibility
+    "_get_version",  # deprecated imported for backward compatibility
+    "dump_version",  # deprecated imported for backward compatibility
     "Configuration",
     "Version",
     "ScmVersion",

src/setuptools_scm/_cli.py

@@ -6,7 +6,7 @@
 
 from setuptools_scm import Configuration
 from setuptools_scm._file_finders import find_files
-from setuptools_scm._get_version import _get_version
+from setuptools_scm._get_version_impl import _get_version
 from setuptools_scm.discover import walk_potential_roots
 
 

src/setuptools_scm/_entrypoints.py

@@ -106,20 +106,29 @@ def _iter_version_schemes(
 
 @overload
 def _call_version_scheme(
-    version: version.ScmVersion, entrypoint: str, given_value: str, default: str
+    version: version.ScmVersion,
+    entrypoint: str,
+    given_value: _t.VERSION_SCHEMES,
+    default: str,
 ) -> str:
     ...
 
 
 @overload
 def _call_version_scheme(
-    version: version.ScmVersion, entrypoint: str, given_value: str, default: None
+    version: version.ScmVersion,
+    entrypoint: str,
+    given_value: _t.VERSION_SCHEMES,
+    default: None,
 ) -> str | None:
     ...
 
 
 def _call_version_scheme(
-    version: version.ScmVersion, entrypoint: str, given_value: str, default: str | None
+    version: version.ScmVersion,
+    entrypoint: str,
+    given_value: _t.VERSION_SCHEMES,
+    default: str | None,
 ) -> str | None:
     for scheme in _iter_version_schemes(entrypoint, given_value):
         result = scheme(version)

src/setuptools_scm/_get_version.py renamed to src/setuptools_scm/_get_version_impl.py

@@ -46,7 +46,7 @@ def parse_fallback_version(config: Configuration) -> ScmVersion | None:
     return _entrypoints.version_from_entrypoint(config, entrypoint, root)
 
 
-def _do_parse(config: Configuration) -> ScmVersion | None:
+def parse_version(config: Configuration) -> ScmVersion | None:
     return (
         _read_pretended_version_for(config)
         or parse_scm_version(config)
@@ -86,14 +86,10 @@ def write_version_files(
 def _get_version(
     config: Configuration, force_write_version_files: bool = False
 ) -> str | None:
-    parsed_version = _do_parse(config)
+    parsed_version = parse_version(config)
     if parsed_version is None:
         return None
-    version_string = _format_version(
-        parsed_version,
-        version_scheme=config.version_scheme,
-        local_scheme=config.local_scheme,
-    )
+    version_string = _format_version(parsed_version)
     if force_write_version_files:
         write_version_files(config, version=version_string, scm_version=parsed_version)
 

src/setuptools_scm/_integration/setuptools.py

@@ -48,7 +48,7 @@ def _warn_on_old_setuptools(_version: str = setuptools.__version__) -> None:
 def _assign_version(
     dist: setuptools.Distribution, config: _config.Configuration
 ) -> None:
-    from .._get_version import _get_version, _version_missing
+    from .._get_version_impl import _get_version, _version_missing
 
     # todo: build time plugin
     maybe_version = _get_version(config, force_write_version_files=True)

src/setuptools_scm/version.py

@@ -419,19 +419,19 @@ def postrelease_version(version: ScmVersion) -> str:
         return version.format_with("{tag}.post{distance}")
 
 
-def format_version(version: ScmVersion, **config: Any) -> str:
+def format_version(version: ScmVersion) -> str:
     log.debug("scm version %s", version)
-    log.debug("config %s", config)
+    log.debug("config %s", version.config)
     if version.preformatted:
         assert isinstance(version.tag, str)
         return version.tag
     main_version = _entrypoints._call_version_scheme(
-        version, "setuptools_scm.version_scheme", config["version_scheme"], None
+        version, "setuptools_scm.version_scheme", version.config.version_scheme, None
     )
     log.debug("version %s", main_version)
     assert main_version is not None
     local_version = _entrypoints._call_version_scheme(
-        version, "setuptools_scm.local_scheme", config["local_scheme"], "+unknown"
+        version, "setuptools_scm.local_scheme", version.config.local_scheme, "+unknown"
     )
     log.debug("local_version %s", local_version)
     return main_version + local_version

testing/test_basic_api.py

@@ -56,7 +56,7 @@ def assertion(config: Configuration) -> ScmVersion:
         assert config.absolute_root == expected_root
         return ScmVersion("1.0", config=config)
 
-    monkeypatch.setattr(setuptools_scm._get_version, "_do_parse", assertion)
+    monkeypatch.setattr(setuptools_scm._get_version_impl, "parse_version", assertion)
 
 
 def test_root_parameter_creation(monkeypatch: pytest.MonkeyPatch) -> None:

testing/test_functions.py

@@ -62,13 +62,16 @@ def test_next_tag(tag: str, expected: str) -> None:
 def test_format_version(
     version: str, version_scheme: str, local_scheme: str, expected: str
 ) -> None:
+    from dataclasses import replace
+
     scm_version = VERSIONS[version]
-    assert (
-        format_version(
-            scm_version, version_scheme=version_scheme, local_scheme=local_scheme
-        )
-        == expected
+    configured_version = replace(
+        scm_version,
+        config=replace(
+            scm_version.config, version_scheme=version_scheme, local_scheme=local_scheme
+        ),
     )
+    assert format_version(configured_version) == expected
 
 
 def test_dump_version_doesnt_bail_on_value_error(tmp_path: Path) -> None:

testing/test_git.py

@@ -547,15 +547,12 @@ def test_git_getdate_signed_commit(signed_commit_wd: WorkDir) -> None:
 )
 @pytest.mark.filterwarnings("ignore:git archive did not support describe output")
 def test_git_archival_to_version(expected: str, from_data: dict[str, str]) -> None:
-    config = Configuration()
+    config = Configuration(
+        version_scheme="guess-next-dev", local_scheme="node-and-date"
+    )
     version = archival_to_version(from_data, config=config)
     assert version is not None
-    assert (
-        format_version(
-            version, version_scheme="guess-next-dev", local_scheme="node-and-date"
-        )
-        == expected
-    )
+    assert format_version(version) == expected
 
 
 @pytest.mark.issue("https://github.com/pypa/setuptools_scm/issues/727")

testing/test_mercurial.py

@@ -43,14 +43,11 @@ def wd(wd: WorkDir) -> WorkDir:
 
 @pytest.mark.parametrize("expected,data", sorted(archival_mapping.items()))
 def test_archival_to_version(expected: str, data: dict[str, str]) -> None:
-    config = Configuration()
-    version = archival_to_version(data, config=config)
-    assert (
-        format_version(
-            version, version_scheme="guess-next-dev", local_scheme="node-and-date"
-        )
-        == expected
+    config = Configuration(
+        version_scheme="guess-next-dev", local_scheme="node-and-date"
     )
+    version = archival_to_version(data, config=config)
+    assert format_version(version) == expected
 
 
 def test_hg_gone(wd: WorkDir, monkeypatch: pytest.MonkeyPatch) -> None: