repo-review 0.11.3__py3-none-any.whl → 0.12.1__py3-none-any.whl

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/_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.1'
+__version_tuple__ = version_tuple = (0, 12, 1)

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/html.py

@@ -6,10 +6,8 @@ import io
 import typing
 from collections.abc import Mapping, Sequence
 
-import markdown_it
-
 from .families import Family, get_family_description, get_family_name
-from .processor import Result
+from .processor import Result, md_as_html
 
 if typing.TYPE_CHECKING:
     from .__main__ import Status
@@ -37,16 +35,15 @@ def to_html(
     """
     out = io.StringIO()
     print = functools.partial(builtins.print, file=out)
-    md = markdown_it.MarkdownIt()
 
     for family in families:
         family_name = get_family_name(families, family)
         family_description = get_family_description(families, family)
-        family_results = [r for r in processed if r.family == family]
+        family_results = [r.md_as_html() for r in processed if r.family == family]
         if family_results or family_description:
             print(f"<h3>{family_name}</h3>")
         if family_description:
-            print(md.render(family_description).strip())
+            print("<p>", md_as_html(family_description), "</p>")
         if family_results:
             print("<table>")
             print(
@@ -61,7 +58,7 @@ def to_html(
                 else "red"
             )
             icon = (
-                "&#9888;&#65039;"
+                ("&#128311;" if result.skip_reason else "&#9888;&#65039;")
                 if result.result is None
                 else "&#9989;"
                 if result.result
@@ -79,6 +76,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>{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>')
@@ -88,7 +90,7 @@ def to_html(
                 print("<td>")
                 print(description)
                 print("<br/>")
-                print(md.render(result.err_msg))
+                print(result.err_msg)
                 print("</td>")
             print("</tr>")
         if family_results:

repo_review/processor.py

@@ -3,11 +3,12 @@ from __future__ import annotations
 import copy
 import dataclasses
 import graphlib
+import sys
 import textwrap
 import typing
 import warnings
 from collections.abc import Mapping, Set
-from typing import Any, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar
 
 import markdown_it
 
@@ -17,12 +18,19 @@ from .checks import (
     collect_checks,
     get_check_url,
     is_allowed,
+    name_matches,
     process_result_bool,
 )
 from .families import Family, collect_families
 from .fixtures import apply_fixtures, collect_fixtures, compute_fixtures, pyproject
 from .ghpath import EmptyTraversable
 
+if TYPE_CHECKING:
+    if sys.version_info >= (3, 11):
+        from typing import Self
+    else:
+        from typing_extensions import Self
+
 __all__ = [
     "CollectionReturn",
     "ProcessReturn",
@@ -63,6 +71,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,15 +84,29 @@ 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)
 
     def err_as_html(self) -> str:
         """
         Produces HTML from the error message, assuming it is in markdown.
+        Deprecated, use :meth:`md_as_html` directly instead.
         """
         return md_as_html(self.err_msg)
 
+    def md_as_html(self) -> Self:
+        """
+        Process fields that are assumed to be markdown.
+
+        .. versionadded:: 0.12.1
+        """
+        return dataclasses.replace(
+            self,
+            err_msg=md_as_html(self.err_msg),
+            skip_reason=md_as_html(self.skip_reason),
+        )
+
 
 class ProcessReturn(typing.NamedTuple):
     """
@@ -179,6 +202,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 +224,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 +263,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 +280,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.dist-info → repo_review-0.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: repo_review
-Version: 0.11.3
+Version: 0.12.1
 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.dist-info → repo_review-0.12.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 repo_review/__init__.py,sha256=U03wTpj7PjSsIROp8O4VRG_NVG-plkx14d_MvqpmJ_w,229
-repo_review/__main__.py,sha256=dXejLf8wJ6spTr_RdL-o_EqdZEQ0CfEteA7PB7m2b-M,13893
-repo_review/_version.py,sha256=OkAeaAqw1G6xdcg59fk8Mamyqb2RLX_cARtBOHOICIM,413
+repo_review/__main__.py,sha256=-4cUtsnRua2Cwl5ESuBEzXljxWUY2kaAj3kZCFAfwh4,14863
+repo_review/_version.py,sha256=OSJc7-JxViAvW4SmGUZQQX05ZpGw9KopFINBSBZ_tHs,413
 repo_review/_version.pyi,sha256=j5kbzfm6lOn8BzASXWjGIA1yT0OlHTWqlbyZ8Si_o0E,118
-repo_review/checks.py,sha256=U1MyA_esE-AjzMfjzSZd0C0XHDZ1UtLXQXebXnaUers,4316
+repo_review/checks.py,sha256=Iz5T1d0wDfBIyaO3f5waHEqhmfP_4-9eNOngJpRnpGo,4845
 repo_review/families.py,sha256=TEMQY3whMj8b3iVlWyVsTa0CAZexXRCFXq5uPIkV6bs,2389
 repo_review/fixtures.py,sha256=ypeEj-Ae3_3bUWUE0n-wuOrKlEVFU6rp7zK-UoC_t6E,3607
 repo_review/ghpath.py,sha256=fkzUD1G_kuzCmVhTH2yAJoJxxYwjAXfjnBwtaj6nqg0,6123
-repo_review/html.py,sha256=LwoZUqiWC84qSuhwbzqQtwhWDhE8JiPWWTI4nKXF3nA,3485
-repo_review/processor.py,sha256=pPAj2kdUFoXAMB3Hqe9VbNlwCs20OK0ODJrE1VaMyaI,8275
+repo_review/html.py,sha256=Mazyng90X31DTOk23ZKtIMwyN-LeHnwG7StwdySwMAA,3716
+repo_review/processor.py,sha256=Cfw65EGfFQosLh6g1jeghWR0xTIg0HRpXXJVsCpiqX0,9524
 repo_review/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/schema.py,sha256=U_iox0khN1oEHCCB5ILffjRvZLG7BR-aaip9QEpMkJk,593
 repo_review/testing.py,sha256=tA0c-baQ2-0UQMKnY59NgBuLmBqsVcFUBP4uYsL3n6Q,1915
@@ -19,8 +19,8 @@ repo_review/_compat/importlib/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5J
 repo_review/_compat/importlib/resources/abc.py,sha256=KLv7AqUaY-ezZ32lA5yVcZLfMqY6VEo8Q-1jyWpGRbk,300
 repo_review/resources/__init__.py,sha256=RBBaUp-hQrIYBqbAT0MytCXEjDmqVsCjiEgdK_K3dN4,138
 repo_review/resources/repo-review.schema.json,sha256=jAc7ZQV-Hc16ENrNFZm7nlIjiRQGTanq8EjBICkJKpE,791
-repo_review-0.11.3.dist-info/METADATA,sha256=svwJcOBrhYYwZmdGKGI1rFcLKKRApKPlSCaJW5sE9wk,10378
-repo_review-0.11.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-repo_review-0.11.3.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
-repo_review-0.11.3.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
-repo_review-0.11.3.dist-info/RECORD,,
+repo_review-0.12.1.dist-info/METADATA,sha256=usuR22S6tkCFLYZ04RoX0v4WaXXgFVCdHUBNi_sS4ho,10613
+repo_review-0.12.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+repo_review-0.12.1.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
+repo_review-0.12.1.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
+repo_review-0.12.1.dist-info/RECORD,,

{repo_review-0.11.3.dist-info → repo_review-0.12.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any