dycw-pre-commit-hooks 0.11.1__tar.gz → 0.11.2__tar.gz

{dycw_pre_commit_hooks-0.11.1 → dycw_pre_commit_hooks-0.11.2}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: dycw-pre-commit-hooks
-Version: 0.11.1
+Version: 0.11.2
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Python: >=3.12
 Requires-Dist: click<8.3,>=8.2.1
-Requires-Dist: dycw-utilities<0.126,>=0.125.10
+Requires-Dist: dycw-utilities<0.151,>=0.150.11
 Requires-Dist: libcst<1.9,>=1.8.2
 Requires-Dist: loguru<0.8,>=0.7.3
+Requires-Dist: packaging<25.1,>=25.0
 Requires-Dist: tomlkit<0.14,>=0.13.2
 Description-Content-Type: text/markdown
 

{dycw_pre_commit_hooks-0.11.1 → dycw_pre_commit_hooks-0.11.2}/pyproject.toml

@@ -9,7 +9,8 @@ requires = ["hatchling"]
 [dependency-groups]
 dev = [
   "dycw-utilities[test]",
-  "pyright[nodejs]>=1.1.401",
+  "pyright[nodejs]",
+  "rich",
 ]
 
 # project
@@ -17,17 +18,19 @@ dev = [
 authors = [{name = "Derek Wan", email = "d.wan@icloud.com"}]
 dependencies = [
   "click >= 8.2.1, < 8.3",
-  "dycw-utilities >= 0.125.10, < 0.126",
+  "dycw-utilities >= 0.150.11, < 0.151",
   "libcst >= 1.8.2, < 1.9",
   "loguru >= 0.7.3, < 0.8",
+  "packaging >= 25.0, < 25.1",
   "tomlkit >= 0.13.2, < 0.14",
 ]
 name = "dycw-pre-commit-hooks"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.11.1"
+version = "0.11.2"
 
 [project.scripts]
+format-requirements = "pre_commit_hooks.format_requirements:main"
 replace-sequence-str = "pre_commit_hooks.replace_sequence_str:main"
 run-bump-my-version = "pre_commit_hooks.run_bump_my_version:main"
 run-ruff-format = "pre_commit_hooks.run_ruff_format:main"
@@ -35,7 +38,7 @@ run-ruff-format = "pre_commit_hooks.run_ruff_format:main"
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.11.1"
+current_version = "0.11.2"
 
 [[tool.bumpversion.files]]
 filename = "src/pre_commit_hooks/__init__.py"
@@ -112,8 +115,10 @@ addopts = [
   "-vv",
   "--color=auto",
   "--strict-markers",
-  "--pdbcls=pudb.debugger:Debugger",
 ]
+asyncio_default_fixture_loop_scope = "function"
+asyncio_mode = "auto"
+collect_imported_tests = false
 filterwarnings = ["error"]
 minversion = "8.0"
 testpaths = ["src/tests"]
@@ -146,6 +151,7 @@ ignore = [
   "D107",  # undocumented-public-init
   "D203",  # one-blank-line-before-class
   "D213",  # multi-line-summary-second-line
+  "DOC",  # pydoclint
   "E501",  # line-too-long
   "PD",  # pandas-vet
   "PERF203",  # try-except-in-loop
@@ -155,6 +161,7 @@ ignore = [
   "PLR0913",  # too-many-arguments
   "PLR0915",  # too-many-statements
   "PLR2004",  # magic-value-comparison
+  "PT012",  # pytest-raises-with-multiple-statements
   "PT013",  # pytest-incorrect-pytest-import
   "S311",  # suspicious-non-cryptographic-random-usage
   "S603",  # subprocess-without-shell-equals-true
@@ -177,7 +184,11 @@ ignore = [
   "ISC001",  # single-line-implicit-string-concatenation
   "ISC002",  # multi-line-implicit-string-concatenation
 ]
-select = ["ALL"]
+preview = true
+select = [
+  "ALL",
+  "RUF022",  # unsorted-dunder-all
+]
 
 [tool.ruff.lint.extend-per-file-ignores]
 "*.ipynb" = [

{dycw_pre_commit_hooks-0.11.1 → dycw_pre_commit_hooks-0.11.2}/src/pre_commit_hooks/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.11.1"
+__version__ = "0.11.2"

{dycw_pre_commit_hooks-0.11.1 → dycw_pre_commit_hooks-0.11.2}/src/pre_commit_hooks/common.py

@@ -4,7 +4,7 @@ from dataclasses import dataclass
 
 from loguru import logger
 from tomlkit import TOMLDocument, parse
-from utilities.git import get_repo_root
+from utilities.pathlib import get_repo_root
 
 _ROOT = get_repo_root()
 PYPROJECT_TOML = _ROOT.joinpath("pyproject.toml")

dycw_pre_commit_hooks-0.11.2/src/pre_commit_hooks/format_requirements/__init__.py

@@ -0,0 +1,109 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, override
+
+from click import argument, command
+from packaging._tokenizer import ParserSyntaxError
+from packaging.requirements import (
+    InvalidRequirement,
+    Requirement,
+    _parse_requirement,  # pyright: ignore[reportPrivateImportUsage]
+)
+from packaging.specifiers import Specifier, SpecifierSet
+from tomlkit import array, dumps, loads, string
+from tomlkit.items import Array, Table
+from utilities.atomicwrites import writer
+from utilities.click import FilePath
+
+from pre_commit_hooks.common import PYPROJECT_TOML
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from pathlib import Path
+
+    from tomlkit.toml_document import TOMLDocument
+
+
+@command()
+@argument("paths", nargs=-1, type=FilePath)
+def main(*, paths: tuple[Path, ...]) -> bool:
+    """CLI for the `format_requirements` hook."""
+    results = list(map(_process, paths))
+    return all(results)
+
+
+def _process(path: Path, /) -> bool:
+    doc = loads(path.read_text())
+    expected = _format_path(path)
+    if doc == expected:
+        return True
+    with writer(path, overwrite=True) as temp:
+        _ = temp.write_text(dumps(expected))
+    return False
+
+
+def _format_path(path: Path, /) -> TOMLDocument:
+    doc = loads(path.read_text())
+    if isinstance(dep_grps := doc.get("dependency-groups"), Table):
+        for key, value in dep_grps.items():
+            if isinstance(value, Array):
+                dep_grps[key] = _format_array(value)
+    if isinstance(project := doc["project"], Table):
+        if isinstance(deps := project["dependencies"], Array):
+            project["dependencies"] = _format_array(deps)
+        if isinstance(optional := project.get("optional-dependencies"), Table):
+            for key, value in optional.items():
+                if isinstance(value, Array):
+                    optional[key] = _format_array(value)
+    return doc
+
+
+def _format_array(dependencies: Array, /) -> Array:
+    new = array().multiline(multiline=True)
+    new.extend(map(_format_item, dependencies))
+    return new
+
+
+def _format_item(item: Any, /) -> Any:
+    if not isinstance(item, str):
+        return item
+    return string(str(_CustomRequirement(item)))
+
+
+class _CustomRequirement(Requirement):
+    @override
+    def __init__(self, requirement_string: str) -> None:
+        super().__init__(requirement_string)
+        try:
+            parsed = _parse_requirement(requirement_string)
+        except ParserSyntaxError as e:
+            raise InvalidRequirement(str(e)) from e
+        self.specifier = _CustomSpecifierSet(parsed.specifier)
+
+    @override
+    def _iter_parts(self, name: str) -> Iterator[str]:
+        yield name
+        if self.extras:
+            formatted_extras = ",".join(sorted(self.extras))
+            yield f"[{formatted_extras}]"
+        if self.specifier:
+            yield f" {self.specifier}"
+        if self.url:
+            yield f"@ {self.url}"
+            if self.marker:
+                yield " "
+        if self.marker:
+            yield f"; {self.marker}"
+
+
+class _CustomSpecifierSet(SpecifierSet):
+    @override
+    def __str__(self) -> str:
+        specs = sorted(self._specs, key=self._key)
+        return ", ".join(map(str, specs))
+
+    def _key(self, spec: Specifier, /) -> int:
+        return [">=", "<"].index(spec.operator)
+
+
+__all__ = ["PYPROJECT_TOML", "main"]

dycw_pre_commit_hooks-0.11.2/src/pre_commit_hooks/format_requirements/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from pre_commit_hooks.format_requirements import main
+
+if __name__ == "__main__":
+    raise SystemExit(int(not main()))

dycw_pre_commit_hooks-0.11.2/src/tests/format_requirements/in.toml

@@ -0,0 +1,30 @@
+[dependency-groups]
+group = [
+  "unbounded",
+  "lower>=1.2.3",
+  "upper<1.3",
+  "lower-and-upper1>=1.2.3,<1.3",
+]
+
+[project]
+dependencies = [
+  "unbounded",
+  "lower1>=1.2.3",
+  "lower2  >=  1.2.3",
+  "upper1<1.3",
+  "upper2  <  1.3",
+  "lower-and-upper1>=1.2.3,<1.3",
+  "lower-and-upper2<1.3,>=1.2.3",
+  "lower-and-upper3  >=  1.2.3  ,  <1.3",
+  "with-extra[extra]",
+  "with-extra[extra]>=1.2.3",
+  "with-extra[extra]  >=  1.2.3",
+]
+
+[project.optional-dependencies]
+group = [
+  "unbounded",
+  "lower>=1.2.3",
+  "upper<1.3",
+  "lower-and-upper1>=1.2.3,<1.3",
+]

dycw_pre_commit_hooks-0.11.2/src/tests/format_requirements/out.toml

@@ -0,0 +1,30 @@
+[dependency-groups]
+group = [
+    "unbounded",
+    "lower >=1.2.3",
+    "upper <1.3",
+    "lower-and-upper1 >=1.2.3, <1.3",
+]
+
+[project]
+dependencies = [
+    "unbounded",
+    "lower1 >=1.2.3",
+    "lower2 >=1.2.3",
+    "upper1 <1.3",
+    "upper2 <1.3",
+    "lower-and-upper1 >=1.2.3, <1.3",
+    "lower-and-upper2 >=1.2.3, <1.3",
+    "lower-and-upper3 >=1.2.3, <1.3",
+    "with-extra[extra]",
+    "with-extra[extra] >=1.2.3",
+    "with-extra[extra] >=1.2.3",
+]
+
+[project.optional-dependencies]
+group = [
+    "unbounded",
+    "lower >=1.2.3",
+    "upper <1.3",
+    "lower-and-upper1 >=1.2.3, <1.3",
+]

dycw_pre_commit_hooks-0.11.2/src/tests/format_requirements/test_format_requirements.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from tomlkit import dumps
+
+from pre_commit_hooks.format_requirements import _format_path
+
+
+class TestFormatRequirements:
+    def test_basic(self) -> None:
+        root = Path(__file__).parent
+        result = dumps(_format_path(root.joinpath("in.toml")))
+        expected = root.joinpath("out.toml").read_text()
+        assert result == expected