feat: add PEP 751 version provider with pylock.toml support

Introduce Pep751Provider that extends Pep621Provider to update
version strings in pylock*.toml lock files alongside pyproject.toml.

Author: josix

commitizen/providers/__init__.py

@@ -10,6 +10,7 @@
 from commitizen.providers.composer_provider import ComposerProvider
 from commitizen.providers.npm_provider import NpmProvider
 from commitizen.providers.pep621_provider import Pep621Provider
+from commitizen.providers.pep751_provider import Pep751Provider
 from commitizen.providers.poetry_provider import PoetryProvider
 from commitizen.providers.scm_provider import ScmProvider
 from commitizen.providers.uv_provider import UvProvider
@@ -24,6 +25,7 @@
     "ComposerProvider",
     "NpmProvider",
     "Pep621Provider",
+    "Pep751Provider",
     "PoetryProvider",
     "ScmProvider",
     "UvProvider",

commitizen/providers/pep751_provider.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import tomlkit
+from packaging.utils import canonicalize_name
+
+from commitizen.providers.pep621_provider import Pep621Provider
+
+
+class Pep751Provider(Pep621Provider):
+    """
+    PEP 621 + PEP 751 lockfile awareness
+
+    Updates pyproject.toml (via Pep621Provider) and any pylock*.toml
+    lock files that contain a matching local directory package entry.
+    """
+
+    lock_patterns: tuple[str, ...] = ("pylock.toml", "pylock.*.toml")
+
+    def set_version(self, version: str) -> None:
+        doc = tomlkit.parse(self.file.read_text())
+        project_name = canonicalize_name(doc["project"]["name"])  # type: ignore[index,arg-type]
+
+        super().set_version(version)
+
+        for pattern in self.lock_patterns:
+            for lock_file in Path().glob(pattern):
+                lock_doc = tomlkit.parse(lock_file.read_text())
+                updated = False
+                for pkg in lock_doc.get("packages", []):
+                    if (
+                        canonicalize_name(pkg.get("name", "")) == project_name
+                        and "directory" in pkg
+                    ):
+                        pkg["version"] = version
+                        updated = True
+                if updated:
+                    lock_file.write_text(tomlkit.dumps(lock_doc))

pyproject.toml

@@ -76,6 +76,7 @@ commitizen = "commitizen.providers:CommitizenProvider"
 composer = "commitizen.providers:ComposerProvider"
 npm = "commitizen.providers:NpmProvider"
 pep621 = "commitizen.providers:Pep621Provider"
+pep751 = "commitizen.providers:Pep751Provider"
 poetry = "commitizen.providers:PoetryProvider"
 scm = "commitizen.providers:ScmProvider"
 uv = "commitizen.providers:UvProvider"

tests/providers/test_pep751_provider.py

@@ -0,0 +1,190 @@
+from __future__ import annotations
+
+from textwrap import dedent
+from typing import TYPE_CHECKING
+
+import pytest
+
+from commitizen.providers import get_provider
+from commitizen.providers.pep751_provider import Pep751Provider
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from commitizen.config.base_config import BaseConfig
+
+PYPROJECT_TOML = """\
+[project]
+name = "my-package"
+version = "0.1.0"
+"""
+
+PYPROJECT_TOML_EXPECTED = """\
+[project]
+name = "my-package"
+version = "42.1"
+"""
+
+PYLOCK_TOML_WITH_DIRECTORY = """\
+lock-version = "1.0"
+created-by = "test"
+
+[[packages]]
+name = "my-package"
+version = "0.1.0"
+
+[packages.directory]
+path = "."
+editable = true
+
+[[packages]]
+name = "some-dep"
+version = "1.2.3"
+"""
+
+PYLOCK_TOML_WITH_DIRECTORY_EXPECTED = """\
+lock-version = "1.0"
+created-by = "test"
+
+[[packages]]
+name = "my-package"
+version = "42.1"
+
+[packages.directory]
+path = "."
+editable = true
+
+[[packages]]
+name = "some-dep"
+version = "1.2.3"
+"""
+
+PYLOCK_TOML_NON_MATCHING_NAME = """\
+lock-version = "1.0"
+created-by = "test"
+
+[[packages]]
+name = "other-package"
+version = "0.1.0"
+
+[packages.directory]
+path = "."
+editable = true
+"""
+
+PYLOCK_TOML_NON_DIRECTORY = """\
+lock-version = "1.0"
+created-by = "test"
+
+[[packages]]
+name = "my-package"
+version = "0.1.0"
+"""
+
+
+@pytest.fixture
+def pyproject(chdir: Path) -> Path:
+    file = chdir / "pyproject.toml"
+    file.write_text(dedent(PYPROJECT_TOML))
+    return file
+
+
+def test_get_version(config: BaseConfig, pyproject: Path):
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+    assert isinstance(provider, Pep751Provider)
+    assert provider.get_version() == "0.1.0"
+
+
+def test_set_version_without_lock_files(
+    config: BaseConfig, pyproject: Path, chdir: Path
+):
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    # No pylock*.toml files should exist
+    assert list(chdir.glob("pylock*.toml")) == []
+
+
+def test_set_version_with_pylock_toml(config: BaseConfig, pyproject: Path, chdir: Path):
+    lock_file = chdir / "pylock.toml"
+    lock_file.write_text(dedent(PYLOCK_TOML_WITH_DIRECTORY))
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    assert lock_file.read_text() == dedent(PYLOCK_TOML_WITH_DIRECTORY_EXPECTED)
+
+
+def test_set_version_with_named_lock_file(
+    config: BaseConfig, pyproject: Path, chdir: Path
+):
+    lock_file = chdir / "pylock.dev.toml"
+    lock_file.write_text(dedent(PYLOCK_TOML_WITH_DIRECTORY))
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    assert lock_file.read_text() == dedent(PYLOCK_TOML_WITH_DIRECTORY_EXPECTED)
+
+
+def test_set_version_non_matching_package_not_updated(
+    config: BaseConfig, pyproject: Path, chdir: Path
+):
+    lock_file = chdir / "pylock.toml"
+    lock_file.write_text(dedent(PYLOCK_TOML_NON_MATCHING_NAME))
+    original_lock_content = lock_file.read_text()
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    # Lock file should be unchanged since no matching package name
+    assert lock_file.read_text() == original_lock_content
+
+
+def test_set_version_non_directory_source_not_updated(
+    config: BaseConfig, pyproject: Path, chdir: Path
+):
+    lock_file = chdir / "pylock.toml"
+    lock_file.write_text(dedent(PYLOCK_TOML_NON_DIRECTORY))
+    original_lock_content = lock_file.read_text()
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    # Lock file should be unchanged since package has no directory source
+    assert lock_file.read_text() == original_lock_content
+
+
+def test_set_version_multiple_lock_files(
+    config: BaseConfig, pyproject: Path, chdir: Path
+):
+    lock_file1 = chdir / "pylock.toml"
+    lock_file1.write_text(dedent(PYLOCK_TOML_WITH_DIRECTORY))
+    lock_file2 = chdir / "pylock.dev.toml"
+    lock_file2.write_text(dedent(PYLOCK_TOML_WITH_DIRECTORY))
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+
+    provider.set_version("42.1")
+
+    assert pyproject.read_text() == dedent(PYPROJECT_TOML_EXPECTED)
+    assert lock_file1.read_text() == dedent(PYLOCK_TOML_WITH_DIRECTORY_EXPECTED)
+    assert lock_file2.read_text() == dedent(PYLOCK_TOML_WITH_DIRECTORY_EXPECTED)
+
+
+def test_provider_registration(config: BaseConfig, pyproject: Path):
+    config.settings["version_provider"] = "pep751"
+    provider = get_provider(config)
+    assert isinstance(provider, Pep751Provider)