repo-review 0.10.4__py3-none-any.whl → 0.10.6__py3-none-any.whl

repo_review/__init__.py

@@ -4,7 +4,6 @@ Copyright (c) 2022 Henry Schreiner. All rights reserved.
 Review repos with a set of checks defined by plugins.
 """
 
-
 from __future__ import annotations
 
 from ._version import version as __version__

repo_review/__main__.py

@@ -41,7 +41,9 @@ def __dir__() -> list[str]:
     return __all__
 
 
-rich.traceback.install(suppress=[click, rich, orig_click], show_locals=True, width=None)
+rich.traceback.install(
+    suppress=[click, rich, orig_click], show_locals=False, width=None
+)
 
 Status = Literal["empty", "passed", "skips", "errors"]
 Formats = Literal["rich", "json", "html", "svg"]

repo_review/_compat/importlib/resources/abc.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import sys
 
 if sys.version_info < (3, 11):
+    # pylint: disable-next=deprecated-class
     from importlib.abc import Traversable
 else:
     from importlib.resources.abc import Traversable

repo_review/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.10.4'
-__version_tuple__ = version_tuple = (0, 10, 4)
+__version__ = version = '0.10.6'
+__version_tuple__ = version_tuple = (0, 10, 6)

repo_review/checks.py

@@ -120,3 +120,26 @@ def get_check_description(name: str, check: Check) -> str:
     .. versionadded:: 0.8
     """
     return (check.__doc__ or "").format(self=check, name=name)
+
+
+def process_result_bool(
+    result: str | bool | None, check: Check, name: str
+) -> str | None:
+    """
+    This converts a bool into a string given a check and name. If the result is a string
+    or None, it is returned as is.
+
+    :param result: The result to process.
+    :param check: The check instance.
+    :param name: The name of the check.
+    :return: The final string or None.
+
+    .. versionadded:: 0.11
+    """
+    if isinstance(result, bool):
+        return (
+            ""
+            if result
+            else (check.check.__doc__ or "Check failed").format(name=name, self=check)
+        )
+    return result

repo_review/ghpath.py

@@ -76,12 +76,10 @@ class GHPath(Traversable):
         return (self.path or self.repo).split("/")[-1]
 
     @typing.overload  # type: ignore[override]
-    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO:
-        ...
+    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO: ...
 
     @typing.overload
-    def open(self, mode: Literal["rb"]) -> io.BytesIO:
-        ...
+    def open(self, mode: Literal["rb"]) -> io.BytesIO: ...
 
     def open(
         self, mode: Literal["r", "rb"] = "r", encoding: str | None = "utf-8"
@@ -164,12 +162,10 @@ class EmptyTraversable(Traversable):
         return self._fake_name
 
     @typing.overload  # type: ignore[override]
-    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO:
-        ...
+    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO: ...
 
     @typing.overload
-    def open(self, mode: Literal["rb"]) -> io.BytesIO:
-        ...
+    def open(self, mode: Literal["rb"]) -> io.BytesIO: ...
 
     def open(
         self, mode: Literal["r", "rb"] = "r", encoding: str | None = "utf-8"

repo_review/processor.py

@@ -10,7 +10,13 @@ from typing import Any, TypeVar
 import markdown_it
 
 from ._compat.importlib.resources.abc import Traversable
-from .checks import Check, collect_checks, get_check_url, is_allowed
+from .checks import (
+    Check,
+    collect_checks,
+    get_check_url,
+    is_allowed,
+    process_result_bool,
+)
 from .families import Family, collect_families
 from .fixtures import apply_fixtures, collect_fixtures, compute_fixtures, pyproject
 from .ghpath import EmptyTraversable
@@ -108,8 +114,7 @@ class HasFamily(typing.Protocol):
     """
 
     @property
-    def family(self) -> str:
-        ...
+    def family(self) -> str: ...
 
 
 T = TypeVar("T", bound=HasFamily)
@@ -212,16 +217,7 @@ def process(
     for name in ts.static_order():
         if all(completed.get(n, "") == "" for n in graph[name]):
             result = apply_fixtures({"name": name, **fixtures}, tasks[name].check)
-            if isinstance(result, bool):
-                completed[name] = (
-                    ""
-                    if result
-                    else (tasks[name].check.__doc__ or "Check failed").format(
-                        name=name, self=tasks[name]
-                    )
-                )
-            else:
-                completed[name] = result
+            completed[name] = process_result_bool(result, tasks[name], name)
         else:
             completed[name] = None
 

repo_review/testing.py

@@ -0,0 +1,70 @@
+"""
+Helpers for testing repo-review plugins.
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+import textwrap
+from typing import Any
+
+from ._compat import tomllib
+from .checks import Check, get_check_url, process_result_bool
+from .fixtures import apply_fixtures
+from .processor import Result
+
+__all__ = ["toml_loads", "compute_check"]
+
+
+def __dir__() -> list[str]:
+    return __all__
+
+
+def toml_loads(contents: str, /) -> Any:
+    """
+    A helper function to quickly load a TOML string for Python 3.10+.
+
+    :param contents: The TOML string to load.
+    :return: The loaded TOML.
+
+    .. versionadded:: 0.10.6
+    """
+    return tomllib.loads(contents)
+
+
+def compute_check(name: str, /, **fixtures: Any) -> Result:
+    """
+    A helper function to compute a check given fixtures, intended for testing.
+    Currently, all fixtures are required to be passed in as keyword arguments,
+    transitive fixtures are not supported.
+
+    :param name: The name of the check to compute.
+    :param fixtures: The fixtures to use when computing the check.
+    :return: The computed result.
+
+    .. versionadded:: 0.10.5
+    """
+
+    check_functions = (
+        ep.load() for ep in importlib.metadata.entry_points(group="repo_review.checks")
+    )
+    checks = {
+        k: v
+        for func in check_functions
+        for k, v in apply_fixtures(fixtures, func).items()
+    }
+    check: Check = checks[name]
+    completed_raw = apply_fixtures({"name": name, **fixtures}, check.check)
+    completed = process_result_bool(completed_raw, check, name)
+    result = None if completed is None else not completed
+    doc = check.__doc__ or ""
+    err_msg = completed or ""
+
+    return Result(
+        family=check.family,
+        name=name,
+        description=doc.format(self=check, name=name).strip(),
+        result=result,
+        err_msg=textwrap.dedent(err_msg),
+        url=get_check_url(name, check),
+    )

{repo_review-0.10.4.dist-info → repo_review-0.10.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: repo_review
-Version: 0.10.4
+Version: 0.10.6
 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
@@ -34,11 +34,18 @@ Requires-Dist: click>=8; extra == 'cli'
 Requires-Dist: rich-click; extra == 'cli'
 Requires-Dist: rich>=12.2; extra == 'cli'
 Provides-Extra: dev
-Requires-Dist: repo-review[cli,test]; extra == 'dev'
+Requires-Dist: click>=8; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: rich-click; extra == 'dev'
+Requires-Dist: rich>=12.2; extra == 'dev'
+Requires-Dist: sp-repo-review>=2023.12.21; extra == 'dev'
+Requires-Dist: validate-pyproject>=0.14; extra == 'dev'
 Provides-Extra: docs
+Requires-Dist: click>=8; extra == 'docs'
 Requires-Dist: furo; extra == 'docs'
 Requires-Dist: myst-parser>=0.13; extra == 'docs'
-Requires-Dist: repo-review[cli]; extra == 'docs'
+Requires-Dist: rich-click; extra == 'docs'
+Requires-Dist: rich>=12.2; extra == 'docs'
 Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
 Requires-Dist: sphinx-copybutton; extra == 'docs'
 Requires-Dist: sphinx-github-changelog; extra == 'docs'
@@ -57,6 +64,7 @@ Description-Content-Type: text/markdown
 [![Documentation Status][docs-badge]][docs-link]
 
 [![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
 [![PyPI platforms][pypi-platforms]][pypi-link]
 
 <!-- SPHINX-START -->
@@ -212,6 +220,8 @@ This was developed for [Scikit-HEP][] before moving to Scientific-Python.
 [sp-repo-review]: https://pypi.org/project/sp-repo-review
 [validate-pyproject]: https://validate-pyproject.readthedocs.io
 [validate-pyproject-schema-store]: https://github.com/henryiii/validate-pyproject-schema-store
+[conda-badge]: https://img.shields.io/conda/vn/conda-forge/repo-review
+[conda-link]: https://github.com/conda-forge/repo-review-feedstock
 
 [intro-pre-commit]: https://repo-review.readthedocs.io/en/latest/intro.html#pre-commit
 [intro-github-actions]: https://repo-review.readthedocs.io/en/latest/intro.html#github-actions

{repo_review-0.10.4.dist-info → repo_review-0.10.6.dist-info}/RECORD

@@ -1,25 +1,26 @@
-repo_review/__init__.py,sha256=Mwl2Lp046LmlrYhaYX-_krbiWhPG5VLFHVrDvSTtnq8,230
-repo_review/__main__.py,sha256=rMUZxsN6NwCiibEQZ_8B04nK8qfzXpl2j2ueCxTZTlM,12255
-repo_review/_version.py,sha256=HXKqJR44DhKjW27JxX9-utoVrog1s0wcE7R-Ggh4Ats,413
+repo_review/__init__.py,sha256=U03wTpj7PjSsIROp8O4VRG_NVG-plkx14d_MvqpmJ_w,229
+repo_review/__main__.py,sha256=YG78gWDM5ExHNTEhdtMNGvJBV44JU_IkR5mc_3a5fqs,12262
+repo_review/_version.py,sha256=0ek8_w_jF04UB6FpW1K7d1RgH0zQMd77H5TbKzdthjI,413
 repo_review/_version.pyi,sha256=j5kbzfm6lOn8BzASXWjGIA1yT0OlHTWqlbyZ8Si_o0E,118
-repo_review/checks.py,sha256=TH6a7_Kbwig6yme8sRv-dKi4RoeaJ1w9WMO6lSTi4-M,3711
+repo_review/checks.py,sha256=hIwQARm0JESf0yMCfjR5jaI-AdnCO7ePTY28eQ2iOy4,4340
 repo_review/families.py,sha256=TEMQY3whMj8b3iVlWyVsTa0CAZexXRCFXq5uPIkV6bs,2389
 repo_review/fixtures.py,sha256=AHdUhDU--SOrlhWSymiyECp5LmaCGYNRcZHuPpzFUts,3709
-repo_review/ghpath.py,sha256=CArlWT4yNgIIoDZ4pVNxucmAdUUMkJSkkROtk35q5qc,6010
+repo_review/ghpath.py,sha256=s83SiaSyfINvtuLn3wpNPQeiU3FipulgTQJObQ9m7tg,5978
 repo_review/html.py,sha256=LwoZUqiWC84qSuhwbzqQtwhWDhE8JiPWWTI4nKXF3nA,3485
-repo_review/processor.py,sha256=qVju2d1DUSFBHnHb1S7obICMBqIIjSj1stQSe9H7P1Q,8196
+repo_review/processor.py,sha256=2NSbuC7jt_eMjIB9VpY0c5-TtKr9GWzA8Gr6Pvj2SqU,7951
 repo_review/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/schema.py,sha256=U_iox0khN1oEHCCB5ILffjRvZLG7BR-aaip9QEpMkJk,593
+repo_review/testing.py,sha256=qbjevlG_DQbL4-l-7wTM9rqoLvRaxf7GF66D8i723OY,1915
 repo_review/_compat/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/_compat/tomllib.py,sha256=caR8Mj-hSBLE2zqdLLjzwOdCBOfikVqS8pWkc4K5vgc,233
 repo_review/_compat/typing.py,sha256=vXfYiJHUaqMShRMbJi0VUg2V59UV-oxceZKSBZ3tfts,246
 repo_review/_compat/importlib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/_compat/importlib/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-repo_review/_compat/importlib/resources/abc.py,sha256=0DXPlrQLCeUNTmY2ex5FlR8_T3FfNllfvVF8n2-ta9w,256
+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=Ljna-BRuoKihOnJ5_78Fgs0ZrYHlgohmtS6x37TJbDg,556
-repo_review-0.10.4.dist-info/METADATA,sha256=B2ia_pyjrOFQbJssMf4XwaxjjO6VAMM2hky3telxiqU,10886
-repo_review-0.10.4.dist-info/WHEEL,sha256=mRYSEL3Ih6g5a_CVMIcwiF__0Ae4_gLYh01YFNwiq1k,87
-repo_review-0.10.4.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
-repo_review-0.10.4.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
-repo_review-0.10.4.dist-info/RECORD,,
+repo_review-0.10.6.dist-info/METADATA,sha256=AQbYlfGOEwgyws3DLqvTdWNoZesRfZZYUmsNF-7bG5A,11370
+repo_review-0.10.6.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+repo_review-0.10.6.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
+repo_review-0.10.6.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
+repo_review-0.10.6.dist-info/RECORD,,

{repo_review-0.10.4.dist-info → repo_review-0.10.6.dist-info}/WHEEL

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