repo-review 0.11.3__tar.gz → 0.12.0__tar.gz

{repo_review-0.11.3 → repo_review-0.12.0}/.github/workflows/cd.yml

@@ -6,6 +6,8 @@ on:
     types:
       - published
 
+permissions: {}
+
 jobs:
   dist:
     name: Distribution build
@@ -15,6 +17,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - uses: hynek/build-and-inspect-python-package@v2
 

{repo_review-0.11.3 → repo_review-0.12.0}/.github/workflows/ci.yml

@@ -17,12 +17,16 @@ concurrency:
 env:
   FORCE_COLOR: 3
 
+permissions: {}
+
 jobs:
   pre-commit:
     name: Format
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
@@ -42,6 +46,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - uses: actions/setup-python@v5
         with:
@@ -69,6 +74,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - uses: hynek/build-and-inspect-python-package@v2
 
@@ -79,6 +85,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - name: Setup uv
         uses: yezz123/setup-uv@v4
@@ -108,8 +115,9 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - name: Run repo-review action
         uses: ./
         with:
-          plugins: sp-repo-review==2024.08.19
+          plugins: sp-repo-review==2025.01.22

{repo_review-0.11.3 → repo_review-0.12.0}/.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
         additional_dependencies: [black==24.*]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.8.3"
+    rev: "v0.9.4"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
@@ -45,7 +45,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.14.1
     hooks:
       - id: mypy
         files: (src|web|tests)
@@ -60,7 +60,7 @@ repos:
           - types-PyYAML
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args: ["-Lhist,absense", "-w"]
@@ -79,12 +79,12 @@ repos:
         exclude: .pre-commit-config.yaml
 
   - repo: https://github.com/henryiii/validate-pyproject-schema-store
-    rev: 2024.11.25
+    rev: 2025.02.03
     hooks:
       - id: validate-pyproject
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.30.0
+    rev: 0.31.1
     hooks:
       - id: check-dependabot
       - id: check-github-workflows

{repo_review-0.11.3 → repo_review-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: repo_review
-Version: 0.11.3
+Version: 0.12.0
 Summary: Framework that can run checks on repos
 Project-URL: Changelog, https://github.com/scientific-python/repo-review/releases
 Project-URL: Demo, https://scientific-python.github.io/repo-review
@@ -8,6 +8,7 @@ Project-URL: Documentation, https://repo-review.readthedocs.io
 Project-URL: Homepage, https://repo-review.readthedocs.io
 Project-URL: Source, https://github.com/scientific-python/repo-review
 Author-email: Henry Schreiner <henryfs@princeton.edu>
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Environment :: WebAssembly :: Emscripten
@@ -101,8 +102,12 @@ select = ["A", "B", "C100"]
 ignore = ["A100"]
 ```
 
+The ignore list can also be a table, with reasons for values.
+
 If `--select` or `--ignore` are given on the command line, they will override
-the `pyproject.toml` config.
+the `pyproject.toml` config. You can use `--extend-select` and `--extend-ignore`
+on the command line to extend the `pyproject.toml` config. These CLI options
+are comma separated.
 
 ## Comparison to other frameworks
 

{repo_review-0.11.3 → repo_review-0.12.0}/README.md

@@ -64,8 +64,12 @@ select = ["A", "B", "C100"]
 ignore = ["A100"]
 ```
 
+The ignore list can also be a table, with reasons for values.
+
 If `--select` or `--ignore` are given on the command line, they will override
-the `pyproject.toml` config.
+the `pyproject.toml` config. You can use `--extend-select` and `--extend-ignore`
+on the command line to extend the `pyproject.toml` config. These CLI options
+are comma separated.
 
 ## Comparison to other frameworks
 

{repo_review-0.11.3 → repo_review-0.12.0}/docs/index.html

@@ -6,7 +6,7 @@
       content="initial-scale=1, width=device-width"
     />
     <script
-      src="https://cdn.jsdelivr.net/pyodide/v0.26.2/full/pyodide.js"
+      src="https://cdn.jsdelivr.net/pyodide/v0.27.1/full/pyodide.js"
       crossorigin
     ></script>
     <!-- Production -->
@@ -64,10 +64,10 @@
         <App
           header={true}
           deps={[
-            "repo-review~=0.11.0",
-            "sp-repo-review==2024.08.19",
-            "validate-pyproject-schema-store== 2024.08.19",
-            "validate-pyproject[all]~=0.19.0",
+            "repo-review~=0.11.3",
+            "sp-repo-review==2025.01.22",
+            "validate-pyproject-schema-store==2025.01.20",
+            "validate-pyproject[all]~=0.22.0",
           ]}
         />,
       );

{repo_review-0.11.3 → repo_review-0.12.0}/docs/intro.md

@@ -51,10 +51,26 @@ You can explicitly list checks to select or skip in your `pyproject.toml`:
 
 ```toml
 [tool.repo-review]
-select = ["..."]
-ignore = ["..."]
+select = ["A", "B", "C100"]
+ignore = ["A100"]
 ```
 
+You can list the letter prefix or the exact check name. The ignore list can also
+be a table, with reasons for values. These will be shown explicitly in the report if
+a reason is given.
+
+```toml
+[tool.repo-review.ignore]
+A = "Skipping this whole family"
+B101 = "Skipping this specific check"
+C101 = ""  # Hidden from report, like a normal ignore
+```
+
+If `--select` or `--ignore` are given on the command line, they will override
+the `pyproject.toml` config. You can use `--extend-select` and `--extend-ignore`
+on the command line to extend the `pyproject.toml` config. These CLI options
+are comma separated.
+
 ## Pre-commit
 
 You can also use this from pre-commit:

{repo_review-0.11.3 → repo_review-0.12.0}/pyproject.toml

@@ -64,11 +64,15 @@ cli = [
 [dependency-groups]
 test = [
   "pytest >=7",
-  "sp-repo-review >=2024.08.19",
+  "sp-repo-review >=2025.01.22",
   "validate-pyproject >=0.14",
 ]
-dev = [
+cov = [
   { include-group = "test" },
+  "pytest-cov",
+]
+dev = [
+  { include-group = "cov" },
   "sp-repo-review[cli]",
   "validate-pyproject-schema-store[all]",
 ]
@@ -96,7 +100,7 @@ features = ["cli"]
 # duplicated since hatch doesn't support groups yet
 dependencies = [
   "pytest >=7",
-  "sp-repo-review >=2024.08.19",
+  "sp-repo-review >=2025.01.22",
   "validate-pyproject >=0.14",
 ]
 env-vars.PYTHONWARNDEFAULTENCODING = "1"
@@ -242,3 +246,12 @@ typing-modules = ["repo_review._compat.typing"]
 [tool.ruff.lint.per-file-ignores]
 "src/repo_review/_compat/**.py" = ["TID251"]
 "src/**/__main__.py" = ["T20"]
+
+[tool.coverage]
+report.exclude_also = [
+  "def __dir__()",
+  "if TYPE_CHECKING:",
+  '\.\.\.',
+]
+report.show_missing = true
+report.skip_empty = true

{repo_review-0.11.3 → repo_review-0.12.0}/src/repo_review/__main__.py

@@ -163,6 +163,13 @@ def rich_printer(
             msg.append(rich.text.Text.from_markup(description, style=style))
             if result.result is None:
                 msg.append(" [skipped]", style="yellow bold")
+                if result.skip_reason:
+                    sr_style = "yellow"
+                    msg.append(" (", style=sr_style)
+                    msg.append(
+                        rich.text.Text.from_markup(result.skip_reason, style=sr_style)
+                    )
+                    msg.append(")", style=sr_style)
                 tree.add(msg)
             elif result.result:
                 msg.append(rich.text.Text.from_markup(" :white_check_mark:"))
@@ -315,6 +322,16 @@ def _remote_path_processor(package: Path) -> Path | GHPath:
     help="Ignore a check or checks, comma separated.",
     default="",
 )
+@click.option(
+    "--extend-select",
+    help="Checks to run in addition to the ones selected.",
+    default="",
+)
+@click.option(
+    "--extend-ignore",
+    help="Checks to ignore in addition to the ones ignored.",
+    default="",
+)
 @click.option(
     "--package-dir",
     "-p",
@@ -327,6 +344,8 @@ def main(
     stderr_fmt: Formats | None,
     select: str,
     ignore: str,
+    extend_select: str,
+    extend_ignore: str,
     package_dir: str,
     show: Show,
 ) -> None:
@@ -351,6 +370,8 @@ def main(
             stderr_fmt,
             select,
             ignore,
+            extend_select,
+            extend_ignore,
             package_dir,
             add_header=len(packages) > 1,
             show=show,
@@ -378,6 +399,8 @@ def on_each(
     stderr_fmt: Literal["rich", "json", "html", "svg"] | None,
     select: str,
     ignore: str,
+    extend_select: str,
+    extend_ignore: str,
     package_dir: str,
     *,
     add_header: bool,
@@ -387,6 +410,8 @@ def on_each(
 
     ignore_list = {x.strip() for x in ignore.split(",") if x}
     select_list = {x.strip() for x in select.split(",") if x}
+    extend_ignore_list = {x.strip() for x in extend_ignore.split(",") if x}
+    extend_select_list = {x.strip() for x in extend_select.split(",") if x}
 
     collected = collect_all(package, subdir=package_dir)
     if len(collected.checks) == 0:
@@ -407,7 +432,12 @@ def on_each(
         header = package.name
 
     families, processed = process(
-        base_package, select=select_list, ignore=ignore_list, subdir=package_dir
+        base_package,
+        select=select_list,
+        ignore=ignore_list,
+        extend_select=extend_select_list,
+        extend_ignore=extend_ignore_list,
+        subdir=package_dir,
     )
 
     status: Status = "passed" if processed else "empty"

{repo_review-0.11.3 → repo_review-0.12.0}/src/repo_review/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.11.3'
-__version_tuple__ = version_tuple = (0, 11, 3)
+__version__ = version = '0.12.0'
+__version_tuple__ = version_tuple = (0, 12, 0)

{repo_review-0.11.3 → repo_review-0.12.0}/src/repo_review/checks.py

@@ -6,7 +6,7 @@ from typing import Any, Protocol
 
 from .fixtures import apply_fixtures
 
-__all__ = ["Check", "collect_checks", "get_check_url", "is_allowed"]
+__all__ = ["Check", "collect_checks", "get_check_url", "is_allowed", "name_matches"]
 
 
 def __dir__() -> list[str]:
@@ -70,6 +70,25 @@ def collect_checks(fixtures: Mapping[str, Any]) -> dict[str, Check]:
     }
 
 
+def name_matches(name: str, selectors: Set[str]) -> str:
+    """
+    Checks if the name is contained in the matchers. The selectors can be the
+    exact name or just the non-number prefix. Returns the selector that matched,
+    or an empty string if no match.
+
+    :param name: The name to check.
+    :param expr: The expression to check against.
+
+    :return: The matched selector if the name matches a selector, or an empty string if no match.
+    """
+    if name in selectors:
+        return name
+    short_name = name.rstrip("0123456789")
+    if short_name in selectors:
+        return short_name
+    return ""
+
+
 def is_allowed(select: Set[str], ignore: Set[str], name: str) -> bool:
     """
     Skips the check if the name is in the ignore list or if the name without the
@@ -82,15 +101,10 @@ def is_allowed(select: Set[str], ignore: Set[str], name: str) -> bool:
 
     :return: True if this check is allowed, False otherwise.
     """
-    if (
-        select
-        and name not in select
-        and name.rstrip("0123456789") not in select
-        and "*" not in select
-    ):
+    if select and not name_matches(name, select) and "*" not in select:
         return False
 
-    return name not in ignore and name.rstrip("0123456789") not in ignore
+    return not name_matches(name, ignore)
 
 
 def get_check_url(name: str, check: Check) -> str:

{repo_review-0.11.3 → repo_review-0.12.0}/src/repo_review/html.py

@@ -61,7 +61,7 @@ def to_html(
                 else "red"
             )
             icon = (
-                "⚠️"
+                ("🔷" if result.skip_reason else "⚠️")
                 if result.result is None
                 else "✅"
                 if result.result
@@ -79,6 +79,11 @@ def to_html(
                 if result.url
                 else result.description
             )
+            if result.skip_reason:
+                description += (
+                    f'<br/><span style="color:DarkKhaki;"><b>Skipped:</b> '
+                    f"<em>{md.render(result.skip_reason)}</em></span>"
+                )
             print(f'<tr style="color: {color};">')
             print(f'<td><span role="img" aria-label="{result_txt}">{icon}</span></td>')
             print(f'<td nowrap="nowrap">{result.name}</td>')

{repo_review-0.11.3 → repo_review-0.12.0}/src/repo_review/processor.py

@@ -17,6 +17,7 @@ from .checks import (
     collect_checks,
     get_check_url,
     is_allowed,
+    name_matches,
     process_result_bool,
 )
 from .families import Family, collect_families
@@ -63,6 +64,7 @@ class ResultDict(typing.TypedDict):
     result: bool | None  #: The result, None means skip
     err_msg: str  #: The error message if the result is false, in markdown format
     url: str  #: An optional URL (empty string if missing)
+    skip_reason: str  #: The reason for the skip, if given (empty string if not)
 
 
 @dataclasses.dataclass(frozen=True, kw_only=True)
@@ -75,6 +77,7 @@ class Result:
     name: str  #: The name of the check
     description: str  #: The short description of what the check looks for
     result: bool | None  #: The result, None means skip
+    skip_reason: str = ""  #: The reason for the skip, if given
     err_msg: str = ""  #: The error message if the result is false, in markdown format
     url: str = ""  #: An optional URL (empty string if missing)
 
@@ -179,6 +182,8 @@ def process(
     *,
     select: Set[str] = frozenset(),
     ignore: Set[str] = frozenset(),
+    extend_select: Set[str] = frozenset(),
+    extend_ignore: Set[str] = frozenset(),
     subdir: str = "",
 ) -> ProcessReturn:
     """
@@ -199,8 +204,12 @@ def process(
 
     # Collect our own config
     config = pyproject(package).get("tool", {}).get("repo-review", {})
-    select_checks = select if select else frozenset(config.get("select", ()))
-    skip_checks = ignore if ignore else frozenset(config.get("ignore", ()))
+    ignore_pyproject: list[str] | dict[str, str] = config.get("ignore", [])
+    select_checks = (
+        select if select else frozenset(config.get("select", ()))
+    ) | extend_select
+    skip_checks = (ignore if ignore else frozenset(ignore_pyproject)) | extend_ignore
+    skip_reasons = ignore_pyproject if isinstance(ignore_pyproject, dict) else {}
 
     # Make a graph of the check's interdependencies
     graph: dict[str, Set[str]] = {
@@ -234,9 +243,14 @@ def process(
         result = None if completed[task_name] is None else not completed[task_name]
         doc = check.__doc__ or ""
         err_msg = completed[task_name] or ""
+        skip_reason = ""
 
         if not is_allowed(select_checks, skip_checks, task_name):
-            continue
+            key = name_matches(task_name, skip_reasons.keys())
+            if not key or not skip_reasons.get(key, ""):
+                continue
+            result = None
+            skip_reason = skip_reasons[key]
 
         result_list.append(
             Result(
@@ -246,6 +260,7 @@ def process(
                 result=result,
                 err_msg=textwrap.dedent(err_msg),
                 url=get_check_url(task_name, check),
+                skip_reason=skip_reason,
             )
         )
 

{repo_review-0.11.3 → repo_review-0.12.0}/tests/test_self.py

@@ -11,7 +11,9 @@ def patch_entry_points(local_entry_points: object) -> None:
 
 
 def test_pyproject() -> None:
-    families, results = repo_review.processor.process(Path())
+    families, results = repo_review.processor.process(
+        Path(), extend_ignore={"X", "PP303"}
+    )
 
     assert families == {
         "general": {},
@@ -26,7 +28,9 @@ def test_pyproject() -> None:
 
 
 def test_no_pyproject() -> None:
-    families, results = repo_review.processor.process(Path("tests"))
+    families, results = repo_review.processor.process(
+        Path("tests"), extend_ignore={"X", "PP303"}
+    )
 
     assert families == {
         "general": {},
@@ -58,12 +62,13 @@ def test_empty_pyproject() -> None:
             "description": "Has flit_core.buildapi backend",
             "name": "PyProject",
         },
+        "skipped": {},
     }
-    assert len(results) == 9
+    assert len(results) == 12
 
     assert (
         sum(result.result is None for result in results if result.family == "pyproject")
-        == 1
+        == 2
     )
     assert (
         sum(result.result for result in results if isinstance(result.result, bool)) == 6
@@ -72,3 +77,6 @@ def test_empty_pyproject() -> None:
         sum(result.result is None for result in results if result.family == "general")
         == 0
     )
+    assert sum(1 for result in results if result.skip_reason) == 3
+    assert sum(1 for result in results if result.skip_reason == "One skip") == 1
+    assert sum(1 for result in results if result.skip_reason == "Group skip") == 2

{repo_review-0.11.3 → repo_review-0.12.0}/tests/test_utilities/pyproject.py

@@ -142,10 +142,51 @@ class PP302(PyProject):
         return "minversion" in options and float(options["minversion"]) >= 6
 
 
-def repo_review_checks() -> dict[str, PyProject | General]:
-    return {p.__name__: p() for p in PyProject.__subclasses__()} | {
+class PP999(PyProject):
+    "Skipped check (single)"
+
+    @staticmethod
+    def check() -> bool:
+        "Not used"
+        return False
+
+
+class X101:
+    "Skipped check (multi)"
+
+    family = "skipped"
+
+    @staticmethod
+    def check() -> bool:
+        "Not used"
+        return False
+
+
+class X102:
+    "Skipped check (multi)"
+
+    family = "skipped"
+
+    @staticmethod
+    def check() -> bool:
+        "Not used"
+        return False
+
+
+def repo_review_checks(
+    pyproject: dict[str, Any],
+) -> dict[str, PyProject | General | X101 | X102]:
+    ret = {p.__name__: p() for p in PyProject.__subclasses__()} | {
         p.__name__: p() for p in General.__subclasses__()
     }
+    extra_checks = (
+        pyproject.get("tool", {}).get("repo-review-local", {}).get("extra", False)
+    )
+    return (
+        (ret | {"X101": X101()} | {"X102": X102()})
+        if extra_checks
+        else {k: v for k, v in ret.items() if k != "PP999"}
+    )
 
 
 def repo_review_families(pyproject: dict[str, Any]) -> dict[str, dict[str, str]]:

{repo_review-0.11.3 → repo_review-0.12.0}/tests/test_utilities/pyproject.toml

@@ -16,3 +16,11 @@ pyproject = "pyproject:repo_review_checks"
 pyproject = "pyproject:repo_review_families"
 
 [tool.example]
+
+
+[tool.repo-review.ignore]
+"PP999" = "One skip"
+"X" = "Group skip"
+
+[tool.repo-review-local]
+extra = true