vcs-versioning/src/vcs_versioning/_version_inference.py - main - niceSOFT/python3-setuptools_scm

vcs-versioning/src/vcs_versioning/_version_inference.py

59 строк2 KB

Ronny Pfannschmidt

fix: ensure public APIs always attach VcsEnvironment to Configuration

22 июн 2026, 22:58

22 июн 2026, 22:58e7611c7

"""Core version inference functionality for build tool integrations."""

from __future__ import annotations

from typing import TYPE_CHECKING, Any

if TYPE_CHECKING:
    from ._environment import VcsEnvironment
    from ._pyproject_reading import PyProjectData


def infer_version_string(
    dist_name: str | None,
    pyproject_data: PyProjectData,
    overrides: dict[str, Any] | None = None,
    *,
    force_write_version_files: bool = False,
    env: VcsEnvironment | None = None,
) -> str:
    """
    Compute the inferred version string from the given inputs.

    This is a pure helper that avoids requiring build-tool specific
    distribution objects, making it easier to test and reuse across
    different build systems.

    Parameters:
        dist_name: Optional distribution name (used for overrides and env scoping)
        pyproject_data: Parsed PyProjectData (may be constructed via for_testing())
        overrides: Optional override configuration (same keys as [tool.setuptools_scm])
        force_write_version_files: When True, apply write_to/version_file effects
        env: Optional VcsEnvironment. If None, resolves from the active
             GlobalOverrides context or process environment.

    Returns:
        The computed version string.

    Raises:
        SystemExit: If version cannot be determined (via _version_missing)
    """
    from ._environment import resolve_runtime_env
    from ._get_version_impl import _get_version, _version_missing

    if env is None:
        env = resolve_runtime_env()

    config = env.build_config(
        dist_name=dist_name, pyproject_data=pyproject_data, **(overrides or {})
    )

    maybe_version = _get_version(
        config, force_write_version_files=force_write_version_files
    )
    if maybe_version is None:
        _version_missing(config)
    return maybe_version


__all__ = ["infer_version_string"]