setuptools-git-versioning 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

setuptools_git_versioning/defaults.py

@@ -13,6 +13,7 @@ DEFAULT_CONFIG = {
     "version_callback": None,
     "version_file": None,
     "count_commits_from_version_file": False,
+    "prefer_tag": False,
     "tag_formatter": None,
     "branch_formatter": None,
     "tag_filter": None,

setuptools_git_versioning/dynamic_metadata.py

@@ -0,0 +1,51 @@
+"""Version provider for the dynamic-metadata protocol."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+
+from setuptools_git_versioning.defaults import set_default_options
+from setuptools_git_versioning.setup import read_toml
+from setuptools_git_versioning.version import version_from_git
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+__all__ = ["dynamic_metadata"]
+
+
+def dynamic_metadata(
+    settings: Mapping[str, Any],
+    project: Mapping[str, Any],
+) -> dict[str, str]:
+    if settings:
+        msg = (
+            "Inline configuration under [[tool.dynamic-metadata]] is not supported. "
+            "Configure setuptools-git-versioning under [tool.setuptools-git-versioning] instead."
+        )
+        raise ValueError(msg)
+
+    root = Path.cwd()
+
+    config = read_toml(root=root)
+    if not config:
+        msg = (
+            "Missing [tool.setuptools-git-versioning] section in pyproject.toml. "
+            "Add it (with at minimum 'enabled = true') to use this provider."
+        )
+        raise ValueError(msg)
+
+    if not config.pop("enabled", True):
+        msg = (
+            "[tool.setuptools-git-versioning] has 'enabled = false' but the "
+            "metadata provider for setuptools-git-versioning was selected. "
+            "Either remove the provider or set 'enabled = true'."
+        )
+        raise ValueError(msg)
+
+    set_default_options(config)
+
+    name = project.get("name")
+    package_name = name if isinstance(name, str) else None
+    return {"version": str(version_from_git(package_name, **config, root=root))}

setuptools_git_versioning/scikit_metadata.py

@@ -1,19 +1,26 @@
-"""Dynamic metadata provider for the scikit-build-core build backend."""
+"""Deprecated version provider for the classic scikit-build-core protocol."""
 
 from __future__ import annotations
 
+import warnings
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
-from setuptools_git_versioning.defaults import set_default_options
-from setuptools_git_versioning.setup import read_toml
-from setuptools_git_versioning.version import version_from_git
+from setuptools_git_versioning.dynamic_metadata import dynamic_metadata as _dynamic_metadata
 
 if TYPE_CHECKING:
     from collections.abc import Mapping
 
 __all__ = ["dynamic_metadata", "get_requires_for_dynamic_metadata"]
 
+warnings.warn(
+    "setuptools_git_versioning.scikit_metadata is deprecated; "
+    "migrate to [[tool.dynamic-metadata]] with provider = 'setuptools_git_versioning.dynamic_metadata' "
+    "on a backend supporting dynamic-metadata such as scikit-build-core>=1.0.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 
 def dynamic_metadata(
     field: str,
@@ -30,29 +37,7 @@ def dynamic_metadata(
         )
         raise ValueError(msg)
 
-    root = Path.cwd()
-
-    config = read_toml(root=root)
-    if not config:
-        msg = (
-            "Missing [tool.setuptools-git-versioning] section in pyproject.toml. "
-            "Add it (with at minimum 'enabled = true') to use this provider."
-        )
-        raise ValueError(msg)
-
-    if not config.pop("enabled", True):
-        msg = (
-            "[tool.setuptools-git-versioning] has 'enabled = false' but the scikit-build-core "
-            "metadata provider for setuptools-git-versioning was selected. "
-            "Either remove the provider or set 'enabled = true'."
-        )
-        raise ValueError(msg)
-
-    set_default_options(config)
-
-    package_name = _read_project_name(root)
-
-    return str(version_from_git(package_name, **config, root=root))
+    return _dynamic_metadata({}, {"name": _read_project_name(Path.cwd())})["version"]
 
 
 def _read_project_name(root: Path) -> str | None:

setuptools_git_versioning/version.py

@@ -5,7 +5,7 @@ import logging
 import os  # noqa: TC003
 import re
 from pathlib import Path
-from typing import Callable
+from typing import Callable, cast
 
 # avoid importing 'packaging' because setuptools-git-versioning can be installed using sdist
 # where 'packaging' is not installed yet
@@ -96,6 +96,7 @@ def version_from_git(  # noqa: PLR0915, PLR0912, PLR0913, C901
     version_callback: str | Callable[[], str] | None = None,
     version_file: str | os.PathLike | None = None,
     count_commits_from_version_file: bool = False,
+    prefer_tag: bool = False,
     tag_formatter: Callable[[str], str] | str | None = None,
     branch_formatter: Callable[[str], str] | str | None = None,
     tag_filter: Callable[[str], str | None] | str | None = None,
@@ -134,6 +135,9 @@ def version_from_git(  # noqa: PLR0915, PLR0912, PLR0913, C901
             raise ValueError(msg)
         return get_version_from_callback(version_callback, package_name, root=root)
 
+    ccount: int | None = 0
+    on_tag = False
+    tag_sha = None
     head_sha = get_sha(root=root)
     log.log(INFO, "HEAD SHA-256: %r", head_sha)
 
@@ -146,15 +150,21 @@ def version_from_git(  # noqa: PLR0915, PLR0912, PLR0913, C901
     tag = get_tag(sort_by=sort_by, root=root, filter_callback=filter_callback)
     if not tag:
         log.log(INFO, "No tags found")
-        tag_sha = None
-        on_tag = False
     else:
-        tag_sha = get_sha(tag, root=root)
+        tag_sha = cast("str", get_sha(tag, root=root))
         log.log(INFO, "Tag SHA-256: %r", tag_sha)
 
         on_tag = head_sha is not None and head_sha == tag_sha
         log.log(INFO, "HEAD is tagged: %r", on_tag)
 
+        ccount = count_since(tag_sha, root=root)
+        log.log(INFO, "Commits count between HEAD and last tag: %r", ccount)
+
+        if tag_formatter is not None:
+            tag_format_callback = create_tag_formatter(tag_formatter, package_name=package_name, root=root)
+            tag = tag_format_callback(tag)
+            log.log(DEBUG, "Tag after formatting: %r", tag)
+
     if version_file:
         log.log(INFO, "Checking for 'version_file'")
 
@@ -166,35 +176,44 @@ def version_from_git(  # noqa: PLR0915, PLR0912, PLR0913, C901
                 version_file_path,
                 starting_version,
             )
-            tag = None
+            file_tag = None
         else:
             log.log(INFO, "Reading version_file '%s' content", version_file)
-            tag = version_file_path.read_text().strip() or None
+            file_tag = version_file_path.read_text().strip() or None
 
-            if not tag:
+            if not file_tag:
                 log.log(INFO, "File %r is empty", version_file)
             else:
-                log.log(DEBUG, "File content: %r", tag)
-                if not count_commits_from_version_file:
-                    return sanitize_version(tag)
+                log.log(DEBUG, "File content: %r", file_tag)
+
+        if prefer_tag and file_tag and tag:
+            log.log(
+                INFO,
+                "Both 'version_file' and a Git tag (%r) are present, and 'prefer_tag' is enabled: using the tag",
+                tag,
+            )
+            if file_tag and sanitize_version(file_tag) != sanitize_version(tag):
+                log.warning(
+                    "Git tag %r and 'version_file' content %r are different: using the tag. "
+                    "Update the version file to silence this warning",
+                    tag,
+                    file_tag,
+                )
 
-                file_sha = get_latest_file_commit(version_file, root=root)
-                log.log(DEBUG, "File SHA-256: %r", file_sha)
+        elif file_tag:
+            tag = file_tag
 
-                ccount = count_since(file_sha, root=root) if file_sha else None
-                log.log(INFO, "Commits count between HEAD and last version file change: %r", ccount)
+            if not count_commits_from_version_file:
+                return sanitize_version(tag)
 
-    elif not head_sha:
-        log.log(INFO, "Not a git repo, or repo without any branch")
+            file_sha = get_latest_file_commit(version_file, root=root)
+            log.log(DEBUG, "File SHA-256: %r", file_sha)
 
-    elif tag_sha:
-        ccount = count_since(tag_sha, root=root)
-        log.log(INFO, "Commits count between HEAD and last tag: %r", ccount)
+            ccount = count_since(file_sha, root=root) if file_sha else None
+            log.log(INFO, "Commits count between HEAD and last version file change: %r", ccount)
 
-        if tag_formatter is not None:
-            tag_format_callback = create_tag_formatter(tag_formatter, package_name=package_name, root=root)
-            tag = tag_format_callback(tag)
-            log.log(DEBUG, "Tag after formatting: %r", tag)
+    elif not head_sha:
+        log.log(INFO, "Not a git repo, or repo without any branch")
 
     if not tag:
         log.log(INFO, "No source for version, return starting_version %r", starting_version)

{setuptools_git_versioning-3.1.0.dist-info → setuptools_git_versioning-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setuptools-git-versioning
-Version: 3.1.0
+Version: 3.2.0
 Summary: Use git repo data for building a version number according to PEP-440
 Author-email: dolfinus <martinov.m.s.8@gmail.com>
 License: MIT
@@ -82,8 +82,8 @@ between ``setuptools-git-versioning`` and other tools.
 
 - Only Git v2 is supported
 
-- Setuptools and `scikit-build-core <https://scikit-build-core.readthedocs.io>`_ build backends are
-  supported (no Poetry & others)
+- Setuptools and build backends supporting `dynamic-metadata <https://dynamic-metadata.readthedocs.io>`_
+  (e.g. `scikit-build-core <https://scikit-build-core.readthedocs.io>`_ 1.0+) are supported.
 
 - Currently does not support automatic exporting of package version to a file for runtime use
   (but you can use ``setuptools-git-versioning > file`` redirect instead)
@@ -176,30 +176,29 @@ and then add new argument ``setuptools_git_versioning`` with config options:
 
 Commands are the same as above, plus ``python -m setup.py`` returns the same version.
 
-``scikit-build-core``
-~~~~~~~~~~~~~~~~~~~~~
+``dynamic-metadata``
+~~~~~~~~~~~~~~~~~~~~
 
-If your project uses the `scikit-build-core <https://scikit-build-core.readthedocs.io>`_ build backend,
-add ``setuptools-git-versioning`` to ``build-system.requires``,
-mark the ``version`` field as dynamic,
-register the dynamic-metadata provider,
-and configure options under the usual ``[tool.setuptools-git-versioning]`` section:
+For build backends supporting `dynamic-metadata <https://dynamic-metadata.readthedocs.io>`_ 0.4+,
+select the registered provider in ``[[tool.dynamic-metadata]]``. For example, with
+`scikit-build-core <https://scikit-build-core.readthedocs.io>`_ 1.0+:
 
 .. code:: toml
 
     [build-system]
-    requires = [ "scikit-build-core", "setuptools-git-versioning>=3.0,<4", ]
+    requires = [ "scikit-build-core>=1.0", "dynamic-metadata>=0.4", "setuptools-git-versioning>=3.2,<4", ]
     build-backend = "scikit_build_core.build"
 
     [project]
     name = "mypackage"
     dynamic = ["version"]
 
-    [tool.scikit-build.metadata.version]
-    provider = "setuptools_git_versioning.scikit_metadata"
+    [[tool.dynamic-metadata]]
+    provider = "setuptools_git_versioning.dynamic_metadata"
 
     [tool.setuptools-git-versioning]
     enabled = true
 
-All options under ``[tool.setuptools-git-versioning]`` work exactly as the for ``setuptools`` backend.
-Inline configuration under ``[tool.scikit-build.metadata.version]`` is not supported.
+The provider sets only ``version`` and reads options from ``[tool.setuptools-git-versioning]``.
+Inline settings in ``[[tool.dynamic-metadata]]`` are not supported.
+The provider itself has no runtime dependency on ``dynamic-metadata``.

{setuptools_git_versioning-3.1.0.dist-info → setuptools_git_versioning-3.2.0.dist-info}/RECORD

@@ -2,17 +2,18 @@ setuptools_git_versioning/__init__.py,sha256=HBPrkDXm4rugE32DxfzvPZwFkZodvB9d1Pt
 setuptools_git_versioning/__main__.py,sha256=6mSX6LsqmyKDEmobvZRfrxXO0kDuZH3aENzvxbunOtA,55
 setuptools_git_versioning/archival.py,sha256=A9udXlJFsLHv2Vk7U6CP_jyv816NwPD6hie_fkloLY8,7524
 setuptools_git_versioning/cli.py,sha256=DQ6_OFbKXUM30dnP0wWWJbAVjt5RIjxFxUw3sfdBtFs,1132
-setuptools_git_versioning/defaults.py,sha256=PVsZd2w7pGi8jMIpnpkdlBoacDYypiG3bQK2Lh6FPBA,797
+setuptools_git_versioning/defaults.py,sha256=b6v4LbK8Js_WQmsqzSouP2eTgc1TAttkM6sD1i1gFCI,822
+setuptools_git_versioning/dynamic_metadata.py,sha256=IUNeuWpKmmjVDvB7yNY_8bTdCDaIw2DZM_Maty4twXM,1618
 setuptools_git_versioning/factories.py,sha256=tGJpYVJeGJC2vE5mFvuoogl3sG0H3xJbkqpPApGZXjs,4462
 setuptools_git_versioning/git.py,sha256=qjh-zQOx_nngl3HmlypG5kXb2vCjw75HC9IxKEUSqDY,3529
 setuptools_git_versioning/log.py,sha256=R4VPodnnRkuybYc5L2CKENyTtESXedTyz3CvqxJCJPA,515
-setuptools_git_versioning/scikit_metadata.py,sha256=_ycINP51xNodoo8rgmseweNlUc9OiCECml3-CYHBn8A,2385
+setuptools_git_versioning/scikit_metadata.py,sha256=9XeDmR163oBoEM8NtHpHNYmhT5EigC1VNlneEfV9MVU,1934
 setuptools_git_versioning/setup.py,sha256=bQGeT96GFodgmemaOo19uuwyRiNIySleGDB1T46FQOY,5357
 setuptools_git_versioning/subst.py,sha256=thLbkXUmUvsZR84o1S7D5uXsYmK4xSldGGPBGQdwccM,2174
-setuptools_git_versioning/version.py,sha256=Rya-Z_wWmVCzStPQ1OgI09umMmz4xVQS6DQiv5-G4Y0,8776
-setuptools_git_versioning-3.1.0.dist-info/licenses/LICENSE,sha256=YP7W0rZutEgY8ypJZeFLuZDSYsaZC-P6YxGZDjiFuL4,1060
-setuptools_git_versioning-3.1.0.dist-info/METADATA,sha256=2VFBJ4vTR9OqhFl55dNboeGmexu0Z_ivplmIZJZQ9UM,7017
-setuptools_git_versioning-3.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-setuptools_git_versioning-3.1.0.dist-info/entry_points.txt,sha256=FU3QTN1qtkjTNeRGVcJZgo9jwV2z7syLEy3Fj9YUR9M,288
-setuptools_git_versioning-3.1.0.dist-info/top_level.txt,sha256=aP9te4bjCBVXzZRQhwrT_IdcSxOe1Dd8Mb_oFCeNyEI,26
-setuptools_git_versioning-3.1.0.dist-info/RECORD,,
+setuptools_git_versioning/version.py,sha256=ZQtW-QolkWhc066V4wSwQ0tOhSRFb53xamzjs7uZMwg,9459
+setuptools_git_versioning-3.2.0.dist-info/licenses/LICENSE,sha256=YP7W0rZutEgY8ypJZeFLuZDSYsaZC-P6YxGZDjiFuL4,1060
+setuptools_git_versioning-3.2.0.dist-info/METADATA,sha256=pc4-IlDYGjHiIWXyZZy3hXoen9I8J1uF6RpkAAMc2n8,7066
+setuptools_git_versioning-3.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+setuptools_git_versioning-3.2.0.dist-info/entry_points.txt,sha256=e-Eyt_a42w9hc-6tjRpitRnP4TxvlLwelNPI5k-jdEA,405
+setuptools_git_versioning-3.2.0.dist-info/top_level.txt,sha256=aP9te4bjCBVXzZRQhwrT_IdcSxOe1Dd8Mb_oFCeNyEI,26
+setuptools_git_versioning-3.2.0.dist-info/RECORD,,

{setuptools_git_versioning-3.1.0.dist-info → setuptools_git_versioning-3.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{setuptools_git_versioning-3.1.0.dist-info → setuptools_git_versioning-3.2.0.dist-info}/entry_points.txt

@@ -4,5 +4,8 @@ setuptools-git-versioning = setuptools_git_versioning.cli:main
 [distutils.setup_keywords]
 setuptools_git_versioning = setuptools_git_versioning:parse_config
 
+[dynamic_metadata.provider]
+setuptools_git_versioning.dynamic_metadata = setuptools_git_versioning.dynamic_metadata
+
 [setuptools.finalize_distribution_options]
 setuptools_git_versioning = setuptools_git_versioning:infer_version