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

repo_review/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.12.0'
-__version_tuple__ = version_tuple = (0, 12, 0)
+__version__ = version = '0.12.1'
+__version_tuple__ = version_tuple = (0, 12, 1)

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(
@@ -82,7 +79,7 @@ def to_html(
             if result.skip_reason:
                 description += (
                     f'<br/><span style="color:DarkKhaki;"><b>Skipped:</b> '
-                    f"<em>{md.render(result.skip_reason)}</em></span>"
+                    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>')
@@ -93,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
 
@@ -24,6 +25,12 @@ 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",
@@ -84,9 +91,22 @@ class Result:
     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):
     """

{repo_review-0.12.0.dist-info → repo_review-0.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repo_review
-Version: 0.12.0
+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

{repo_review-0.12.0.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=-4cUtsnRua2Cwl5ESuBEzXljxWUY2kaAj3kZCFAfwh4,14863
-repo_review/_version.py,sha256=HJyq47ePtlF3WPYAhFFp5LPsrHyF6oju_vSEfklwWro,413
+repo_review/_version.py,sha256=OSJc7-JxViAvW4SmGUZQQX05ZpGw9KopFINBSBZ_tHs,413
 repo_review/_version.pyi,sha256=j5kbzfm6lOn8BzASXWjGIA1yT0OlHTWqlbyZ8Si_o0E,118
 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=XGfWXNkYK4jQT3KiQRGC4wnhv-DLG-JKttSkqVr7uIM,3759
-repo_review/processor.py,sha256=-p70iGbqwy6Tw-FxxIAXUlgXQxk74fvLQXmojunqikU,8984
+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.12.0.dist-info/METADATA,sha256=duKtaL0RIK1pxVs5iH8HQZ3vivRwDjzCKdV4SWJPqH8,10613
-repo_review-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-repo_review-0.12.0.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
-repo_review-0.12.0.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
-repo_review-0.12.0.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,,