docsig 0.48.0__tar.gz → 0.49.1__tar.gz

{docsig-0.48.0 → docsig-0.49.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.48.0
+Version: 0.49.1
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -21,7 +21,7 @@ Requires-Dist: Pygments (>=2.13.0,<3.0.0)
 Requires-Dist: Sphinx (>=7.0.0,<8.0.0)
 Requires-Dist: arcon (>=0.4.0)
 Requires-Dist: astroid (>=3.0.1,<4.0.0)
-Requires-Dist: object-colors (>=2.1.0,<3.0.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
 Project-URL: Documentation, https://docsig.readthedocs.io/en/latest
 Project-URL: Repository, https://github.com/jshwi/docsig
 Description-Content-Type: text/x-rst
@@ -181,7 +181,7 @@ API
     ...     :param param3: About param3.
     ...     '''
     ...     """
-    >>> docsig(string=string, no_ansi=True)
+    >>> docsig(string=string, summary=True, no_ansi=True)
     0
 
 .. code-block:: python
@@ -195,18 +195,9 @@ API
     ...     :param param3: About param3.
     ...     '''
     ... """
-    >>> docsig(string=string, no_ansi=True)
-    2
-    -
-    def function(✓param1, ✓param2, ✖None) -> ✓None:
-        """
-        :param param1: ✓
-        :param param2: ✓
-        :param param3: ✖
-        """
-    <BLANKLINE>
-    E102: includes parameters that do not exist (params-do-not-exist)
-    <BLANKLINE>
+    >>> docsig(string=string, summary=True, no_ansi=True)
+    2 in function
+        E102: includes parameters that do not exist (params-do-not-exist)
     1
 
 A full list of checks can be found `here <https://docsig.readthedocs.io/en/latest/docsig.html#docsig-messages>`__
@@ -232,7 +223,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.48.0
+        rev: v0.49.1
         hooks:
           - id: docsig
             args:

{docsig-0.48.0 → docsig-0.49.1}/README.rst

@@ -153,7 +153,7 @@ API
     ...     :param param3: About param3.
     ...     '''
     ...     """
-    >>> docsig(string=string, no_ansi=True)
+    >>> docsig(string=string, summary=True, no_ansi=True)
     0
 
 .. code-block:: python
@@ -167,18 +167,9 @@ API
     ...     :param param3: About param3.
     ...     '''
     ... """
-    >>> docsig(string=string, no_ansi=True)
-    2
-    -
-    def function(✓param1, ✓param2, ✖None) -> ✓None:
-        """
-        :param param1: ✓
-        :param param2: ✓
-        :param param3: ✖
-        """
-    <BLANKLINE>
-    E102: includes parameters that do not exist (params-do-not-exist)
-    <BLANKLINE>
+    >>> docsig(string=string, summary=True, no_ansi=True)
+    2 in function
+        E102: includes parameters that do not exist (params-do-not-exist)
     1
 
 A full list of checks can be found `here <https://docsig.readthedocs.io/en/latest/docsig.html#docsig-messages>`__
@@ -204,7 +195,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.48.0
+        rev: v0.49.1
         hooks:
           - id: docsig
             args:

{docsig-0.48.0 → docsig-0.49.1}/docsig/_config.py

@@ -6,9 +6,9 @@ docsig._config
 from argparse import HelpFormatter as _HelpFormatter
 from pathlib import Path as _Path
 
+import click as _click
 from arcon import ArgumentParser as _ArgumentParser
 
-from ._display import color as _color
 from ._version import __version__
 
 
@@ -18,7 +18,7 @@ class Parser(_ArgumentParser):
     def __init__(self) -> None:
         super().__init__(
             version=__version__,
-            prog=_color.cyan.get(__package__),
+            prog=_click.style(__package__, fg="cyan"),
             formatter_class=lambda prog: _HelpFormatter(
                 prog, max_help_position=45
             ),

{docsig-0.48.0 → docsig-0.49.1}/docsig/_core.py

@@ -7,6 +7,8 @@ from __future__ import annotations as _
 
 from pathlib import Path as _Path
 
+import click as _click
+
 from . import _decorators
 from ._display import Display as _Display
 from ._display import Failure as _Failure
@@ -42,7 +44,7 @@ _DEFAULT_EXCLUDES = """\
 
 def _print_checks() -> None:
     for msg in _E.values():
-        print(msg.fstring(_TEMPLATE))
+        _click.echo(msg.fstring(_TEMPLATE))
 
 
 def _run_check(  # pylint: disable=too-many-arguments
@@ -77,9 +79,7 @@ def _run_check(  # pylint: disable=too-many-arguments
                 child, targets, child.disabled, check_property_returns
             )
             if report:
-                failures.append(
-                    _Failure(child, _FuncStr(child, no_ansi), report)
-                )
+                failures.append(_Failure(child, _FuncStr(child), report))
 
         if check_nested:
             for func in child:

{docsig-0.48.0 → docsig-0.49.1}/docsig/_display.py

@@ -5,10 +5,11 @@ docsig._display
 
 from __future__ import annotations as _
 
+import sys as _sys
 import typing as _t
 from collections import UserString as _UserString
 
-from object_colors import Color as _Color
+import click as _click
 from pygments import highlight as _highlight
 from pygments.formatters.terminal256 import (
     Terminal256Formatter as _Terminal256Formatter,
@@ -23,39 +24,18 @@ from ._stub import ARG as _ARG
 from ._stub import KEY as _KEY
 from ._stub import Param as _Param
 
-color = _Color()
-
-color.populate_colors()
-
 TAB = "    "
 
 
-class _ANSI:
-    def __init__(self, no_ansi: bool = False) -> None:
-        self._no_ansi = no_ansi
-
-    def color(self, obj: _t.Any, color_obj: _Color) -> str:
-        """Get string with selected color.
-
-        :param obj: Any object, represented as ``__str__``.
-        :param color_obj: Instantiated ``Color`` object.
-        :return: Colored string or string as was supplied.
-        """
-        return str(obj) if self._no_ansi else color_obj.get(obj)
-
-    def syntax(self, obj: _t.Any) -> str:
-        """Get code representation with syntax highlighting.
+def syntax(obj: _t.Any) -> str:
+    """Get code representation with syntax highlighting.
 
-        :param obj: Any object, represented as ``__str__``.
-        :return: Colored string or string as was supplied.
-        """
-        return (
-            str(obj)
-            if self._no_ansi
-            else _highlight(
-                obj, _PythonLexer(), _Terminal256Formatter(style="monokai")
-            ).strip()
-        )
+    :param obj: Any object, represented as ``__str__``.
+    :return: Colored string or string as was supplied.
+    """
+    return _highlight(
+        obj, _PythonLexer(), _Terminal256Formatter(style="monokai")
+    ).strip()
 
 
 class FuncStr(_UserString):
@@ -63,16 +43,14 @@ class FuncStr(_UserString):
 
     :param func: Represents a function with signature and docstring
         parameters.
-    :param no_ansi: Disable ANSI output.
     """
 
     CHECK = "\u2713"
     CROSS = "\u2716"
     TRIPLE_QUOTES = '"""'
 
-    def __init__(self, func: _Function, no_ansi: bool = False) -> None:
+    def __init__(self, func: _Function) -> None:
         super().__init__(func.name)
-        self._ansi = _ANSI(no_ansi)
         self._parent_name = func.parent.name
         self._isinit = func.isinit
         self.data = ""
@@ -80,13 +58,13 @@ class FuncStr(_UserString):
         if self._isinit:
             self.data += TAB
 
-        self.data += self._ansi.syntax(f"def {func.name}(")
+        self.data += syntax(f"def {func.name}(")
         if self._is_string:
-            self._docstring = self._ansi.syntax(f"{TAB}{self.TRIPLE_QUOTES}")
+            self._docstring = syntax(f"{TAB}{self.TRIPLE_QUOTES}")
         else:
-            self._docstring = f"{TAB}{self._ansi.color('...', color.red)}\n"
+            self._docstring = f"{TAB}{_click.style('...', fg='red')}\n"
 
-        self._mark = self._ansi.color(self.CHECK, color.green)
+        self._mark = _click.style(self.CHECK, fg="green")
         for index in range(len(func)):
             arg = func.signature.args.get(index)
             doc = func.docstring.args.get(index)
@@ -119,9 +97,9 @@ class FuncStr(_UserString):
         :param failed: Boolean to test that check failed.
         """
         self._mark = (
-            self._ansi.color(self.CROSS, color.red)
+            _click.style(self.CROSS, fg="red")
             if failed
-            else self._ansi.color(self.CHECK, color.green)
+            else _click.style(self.CHECK, fg="green")
         )
 
     def add_param(
@@ -162,34 +140,27 @@ class FuncStr(_UserString):
         :param arg: Signature argument.
         """
         if arg is not None:
-            self.data += "{}{}{}{}".format(
-                self._ansi.syntax(") -> "),
-                self._mark,
-                arg,
-                self._ansi.syntax(":"),
-            )
+            self.data += f"{syntax(') -> ')}{self._mark}{arg}{syntax(':')}"
         else:
             self.data += "{}{}{}".format(
-                self._ansi.syntax(")"),
-                self._ansi.color("?", color.red),
-                self._ansi.syntax(":"),
+                syntax(")"),
+                _click.style("?", fg="red"),
+                syntax(":"),
             )
 
     def add_comma(self) -> None:
         """Add comma between parenthesis."""
-        self.data += self._ansi.syntax(", ")
+        self.data += syntax(", ")
 
     def close_docstring(self) -> None:
         """Close docstring."""
-        self._cat_docstring(
-            f"\n{TAB}{self._ansi.syntax(self.TRIPLE_QUOTES)}\n"
-        )
+        self._cat_docstring(f"\n{TAB}{syntax(self.TRIPLE_QUOTES)}\n")
 
     def render(self) -> None:
         """Render final string by adding docstring to function."""
         if self._isinit:
             self.data = (
-                self._ansi.syntax(f"class {self._parent_name}:")
+                syntax(f"class {self._parent_name}:")
                 + f"\n{self._docstring}"
                 + f"\n{self.data}\n"
             )
@@ -217,7 +188,7 @@ class Display(_t.Dict[str, _t.List[Failures]]):
 
     def __init__(self, no_ansi: bool = False) -> None:
         super().__init__()
-        self._ansi = _ANSI(no_ansi)
+        self._ansi = not no_ansi and _sys.stdout.isatty()
 
     def __getitem__(self, key: str) -> list[Failures]:
         if key not in super().__iter__():
@@ -234,10 +205,12 @@ class Display(_t.Dict[str, _t.List[Failures]]):
                     if failure.func.parent.name:
                         header += f" in {failure.func.parent.name}"
 
-                    print(self._ansi.color(header, color.magenta))
-                    print(len(header) * "-")
-                    print(failure.func_str)
-                    print(failure.report.get_report())
+                    _click.echo(
+                        _click.style(header, fg="magenta"), color=self._ansi
+                    )
+                    _click.echo(len(header) * "-", color=self._ansi)
+                    _click.echo(failure.func_str, color=self._ansi)
+                    _click.echo(failure.report.get_report(), color=self._ansi)
 
     def summarise(self) -> None:
         """Display report summary if any checks have failed."""
@@ -250,9 +223,10 @@ class Display(_t.Dict[str, _t.List[Failures]]):
                         function = f"{failure.func.parent.name}.{function}"
 
                     header += f" in {function}"
-                    print(
+                    _click.echo(
                         "{}\n    {}".format(
-                            self._ansi.color(header, color.magenta),
+                            _click.style(header, fg="magenta"),
                             failure.report.get_report("    ").strip(),
-                        )
+                        ),
+                        color=self._ansi,
                     )

docsig-0.49.1/docsig/_hooks.py

@@ -0,0 +1,22 @@
+"""
+docsig._hooks
+=============
+"""
+
+import sys as _sys
+from os import environ as _e
+
+import click as _click
+
+
+def pretty_print_error(no_ansi: bool = False) -> None:
+    """Print user friendly commandline error if debug not enabled.
+
+    :param no_ansi: Disable ANSI output.
+    """
+    if _e.get("DOCSIG_DEBUG", None) != "1":
+        _sys.excepthook = lambda x, y, _: _click.echo(
+            f"{_click.style(x.__name__, fg='red', bold=True)}: {y}",
+            file=_sys.stderr,
+            color=not no_ansi and _sys.stderr.isatty(),
+        )

{docsig-0.48.0 → docsig-0.49.1}/docsig/_main.py

@@ -20,7 +20,7 @@ def main() -> str | int:
     :return: Exit status for whether test failed or not.
     """
     p = _Parser()
-    _pretty_print_error()
+    _pretty_print_error(p.args.no_ansi)
     return _docsig(
         *p.args.path,
         string=p.args.string,

{docsig-0.48.0 → docsig-0.49.1}/docsig/_stub.py

@@ -20,16 +20,19 @@ RETURN = "return"
 ARG = "arg"
 
 
+# noinspection PyTypeChecker
 class _GoogleDocstring(str):
     def __new__(cls, string: str) -> _GoogleDocstring:
         return super().__new__(cls, str(_s.GoogleDocstring(string)))
 
 
+# noinspection PyTypeChecker
 class _NumpyDocstring(str):
     def __new__(cls, string: str) -> _NumpyDocstring:
         return super().__new__(cls, str(_s.NumpyDocstring(string)))
 
 
+# noinspection PyTypeChecker
 class _DocFmt(str):
     def __new__(cls, string: str) -> _DocFmt:
         return super().__new__(
@@ -40,6 +43,7 @@ class _DocFmt(str):
         )
 
 
+# noinspection PyTypeChecker
 class _RawDocstring(str):
     def __new__(cls, string: str) -> _RawDocstring:
         return super().__new__(

{docsig-0.48.0 → docsig-0.49.1}/docsig/_utils.py

@@ -7,6 +7,8 @@ from __future__ import annotations as _
 
 from difflib import SequenceMatcher as _SequenceMatcher
 
+import click as _click
+
 
 def almost_equal(str1: str, str2: str, mini: float, maxi: float) -> bool:
     """Show result for more than the minimum but less than the maximum.
@@ -28,4 +30,4 @@ def vprint(msg: str, verbose: bool = False) -> None:
     :param verbose: Whether verbose mode is enabled.
     """
     if verbose:
-        print(msg)
+        _click.echo(msg)

{docsig-0.48.0 → docsig-0.49.1}/docsig/_version.py

@@ -8,4 +8,4 @@ Allows for access to the version internally without cyclic imports
 caused by accessing it through __init__.
 """
 
-__version__ = "0.48.0"
+__version__ = "0.49.1"

{docsig-0.48.0 → docsig-0.49.1}/pyproject.toml

@@ -19,6 +19,7 @@ line-length = 79
 [tool.constcheck]
 ignore_strings = [
   "disable",
+  "red",
   "store",
   "store_true",
   "targets",
@@ -72,14 +73,14 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.48.0"
+version = "0.49.1"
 
 [tool.poetry.dependencies]
 Pygments = "^2.13.0"
 Sphinx = "^7.0.0"
 arcon = ">=0.4.0"
 astroid = "^3.0.1"
-object-colors = "^2.1.0"
+click = "^8.1.7"
 python = "^3.8"
 
 [tool.poetry.dev-dependencies]

docsig-0.48.0/docsig/_hooks.py

@@ -1,17 +0,0 @@
-"""
-docsig._hooks
-=============
-"""
-
-import sys as _sys
-from os import environ as _e
-
-from ._display import color as _color
-
-
-def pretty_print_error() -> None:
-    """Print user friendly commandline error if debug not enabled."""
-    if _e.get("DOCSIG_DEBUG", None) != "1":
-        _sys.excepthook = lambda x, y, _: print(
-            f"{_color.red.bold.get(x.__name__)}: {y}"
-        )