docsig 0.57.0__tar.gz → 0.58.0__tar.gz

{docsig-0.57.0 → docsig-0.58.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.57.0
+Version: 0.58.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -19,7 +19,6 @@ Classifier: Programming Language :: Python :: 3.12
 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: click (>=8.1.7,<9.0.0)
 Requires-Dist: pathspec (>=0.12.1,<0.13.0)
 Project-URL: Documentation, https://docsig.readthedocs.io/en/latest
 Project-URL: Repository, https://github.com/jshwi/docsig
@@ -170,7 +169,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.57.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.58.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -253,11 +252,13 @@ pre-commit
 
 It can be added to your .pre-commit-config.yaml as follows:
 
+Standalone
+
 .. code-block:: yaml
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.57.0
+        rev: v0.58.0
         hooks:
           - id: docsig
             args:
@@ -266,3 +267,20 @@ It can be added to your .pre-commit-config.yaml as follows:
               - "--check-overridden"
               - "--check-protected"
 
+or integrated with ``flake8``
+
+.. code-block:: yaml
+
+    repos:
+      - repo: https://github.com/PyCQA/flake8
+        rev: "7.1.0"
+        hooks:
+          - id: flake8
+            additional_dependencies:
+              - docsig==0.58.0
+            args:
+              - "--sig-check-class"
+              - "--sig-check-dunders"
+              - "--sig-check-overridden"
+              - "--sig-check-protected"
+

{docsig-0.57.0 → docsig-0.58.0}/README.rst

@@ -143,7 +143,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.57.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.58.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -226,11 +226,13 @@ pre-commit
 
 It can be added to your .pre-commit-config.yaml as follows:
 
+Standalone
+
 .. code-block:: yaml
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.57.0
+        rev: v0.58.0
         hooks:
           - id: docsig
             args:
@@ -238,3 +240,20 @@ It can be added to your .pre-commit-config.yaml as follows:
               - "--check-dunders"
               - "--check-overridden"
               - "--check-protected"
+
+or integrated with ``flake8``
+
+.. code-block:: yaml
+
+    repos:
+      - repo: https://github.com/PyCQA/flake8
+        rev: "7.1.0"
+        hooks:
+          - id: flake8
+            additional_dependencies:
+              - docsig==0.58.0
+            args:
+              - "--sig-check-class"
+              - "--sig-check-dunders"
+              - "--sig-check-overridden"
+              - "--sig-check-protected"

{docsig-0.57.0 → docsig-0.58.0}/docsig/_core.py

@@ -5,6 +5,7 @@ docsig._core
 
 from __future__ import annotations as _
 
+import sys as _sys
 from pathlib import Path as _Path
 
 from . import _decorators
@@ -13,8 +14,8 @@ from ._module import Modules as _Modules
 from ._module import Parent as _Parent
 from ._report import Failure as _Failure
 from ._report import Failures as _Failures
-from ._report import Report as _Report
 from ._utils import print_checks as _print_checks
+from .messages import TEMPLATE as _TEMPLATE
 from .messages import Messages as _Messages
 
 _DEFAULT_EXCLUDES = """\
@@ -111,6 +112,70 @@ def _run_check(  # pylint: disable=too-many-arguments,too-many-locals
             )
 
 
+def _get_failures(  # pylint: disable=too-many-locals,too-many-arguments
+    module: _Parent,
+    check_class: bool,
+    check_class_constructor: bool,
+    check_dunders: bool,
+    check_nested: bool,
+    check_overridden: bool,
+    check_protected: bool,
+    check_property_returns: bool,
+    ignore_no_params: bool,
+    ignore_typechecker: bool,
+    check_protected_class_methods: bool,
+    no_ansi: bool,
+    target: _Messages,
+) -> _Failures:
+    failures = _Failures()
+    for top_level in module:
+        if (
+            not top_level.isprotected
+            or check_protected
+            or check_protected_class_methods
+        ):
+            _run_check(
+                top_level,
+                module,
+                check_class,
+                check_class_constructor,
+                check_dunders,
+                check_nested,
+                check_overridden,
+                check_protected,
+                check_property_returns,
+                ignore_no_params,
+                ignore_typechecker,
+                no_ansi,
+                target or _Messages(),
+                failures,
+            )
+
+    return failures
+
+
+def _report(
+    failures: _Failures, path: str | None = None, no_ansi: bool = False
+) -> None:
+    for failure in failures:
+        header = f"{path}{failure.lineno} in {failure.name}"
+        if not no_ansi and _sys.stdout.isatty():
+            header = f"\033[35m{header}\033[0m"
+
+        print(header)
+        for item in failure:
+            print(
+                "    "
+                + _TEMPLATE.format(
+                    ref=item.ref,
+                    description=item.description,
+                    symbolic=item.symbolic,
+                )
+            )
+            if item.hint:
+                print(f"    hint: {item.hint}")
+
+
 @_decorators.parse_msgs
 @_decorators.handle_deprecations
 @_decorators.validate_args
@@ -174,6 +239,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         checks.
     :return: Exit status for whether test failed or not.
     """
+    retcode = 0
     if list_checks:
         return int(bool(_print_checks()))  # type: ignore
 
@@ -193,33 +259,24 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         no_ansi=no_ansi,
         verbose=verbose,
     )
-    report = _Report()
     for module in modules:
-        for top_level in module:
-            if (
-                not top_level.isprotected
-                or check_protected
-                or check_protected_class_methods
-            ):
-                failures = _Failures()
-                _run_check(
-                    top_level,
-                    module,
-                    check_class,
-                    check_class_constructor,
-                    check_dunders,
-                    check_nested,
-                    check_overridden,
-                    check_protected,
-                    check_property_returns,
-                    ignore_no_params,
-                    ignore_typechecker,
-                    no_ansi,
-                    target or _Messages(),
-                    failures,
-                )
-                if failures:
-                    report[top_level.path].append(failures)
+        failures = _get_failures(
+            module,
+            check_class,
+            check_class_constructor,
+            check_dunders,
+            check_nested,
+            check_overridden,
+            check_protected,
+            check_property_returns,
+            ignore_no_params,
+            ignore_typechecker,
+            check_protected_class_methods,
+            no_ansi,
+            target or _Messages(),
+        )
+        if failures:
+            _report(failures, module.path, no_ansi=no_ansi)
+            retcode = 1
 
-    report.print(no_ansi)
-    return max(int(bool(report)), modules.retcode)
+    return max(retcode, modules.retcode)

{docsig-0.57.0 → docsig-0.58.0}/docsig/_module.py

@@ -12,8 +12,6 @@ import typing as _t
 from pathlib import Path as _Path
 
 import astroid as _ast
-import click as _click
-from astroid import AstroidSyntaxError as _AstroidSyntaxError
 from pathspec import PathSpec as _PathSpec
 from pathspec.patterns import GitWildMatchPattern as _GitWildMatchPattern
 
@@ -427,13 +425,13 @@ class Modules(_t.List[Parent]):  # pylint: disable=too-many-instance-attributes
                 ),
                 self._verbose,
             )
-        except (_AstroidSyntaxError, UnicodeDecodeError) as err:
+        except (_ast.AstroidSyntaxError, UnicodeDecodeError) as err:
             msg = str(err).replace("\n", " ")
             if root is not None and root.name.endswith(".py"):
                 # pass by silently for files that do not end with .py,
                 # may result in a 123 syntax error exit status in the
                 # future
-                _click.echo(root, file=_sys.stderr)
+                print(root, file=_sys.stderr)
                 _pretty_print_error(type(err), msg, no_ansi=self._no_ansi)
                 self._retcode = 1
 

{docsig-0.57.0 → docsig-0.58.0}/docsig/_report.py

@@ -5,11 +5,8 @@ docsig._report
 
 from __future__ import annotations as _
 
-import sys as _sys
 import typing as _t
 
-import click as _click
-
 from ._module import Function as _Function
 from ._stub import UNNAMED as _UNNAMED
 from ._stub import VALID_DESCRIPTION as _VALID_DESCRIPTION
@@ -17,7 +14,6 @@ from ._stub import Param as _Param
 from ._stub import RetType as _RetType
 from ._utils import almost_equal as _almost_equal
 from ._utils import has_bad_return as _has_bad_return
-from .messages import TEMPLATE as _TEMPLATE
 from .messages import E as _E
 from .messages import Message as _Message
 from .messages import Messages as _Messages
@@ -26,7 +22,18 @@ _MIN_MATCH = 0.8
 _MAX_MATCH = 1.0
 
 
-class Failure(_t.List[str]):
+class Failed(_t.NamedTuple):
+    """Report info object."""
+
+    name: str
+    ref: str
+    description: str
+    symbolic: str
+    lineno: int
+    hint: str | None = None
+
+
+class Failure(_t.List[Failed]):
     """Compile and produce report.
 
     :param func: Function object.
@@ -47,7 +54,10 @@ class Failure(_t.List[str]):
         if target:
             self._func.messages.extend(i for i in _E.all if i not in target)
 
-        self._func = func
+        self._name = self._func.name
+        if self._func.parent.name:
+            self._name = f"{self._func.parent.name}.{self._func.name}"
+
         self._check_property_returns = check_property_returns
         self._sig0xx_config()
         if self._func.docstring.string is None:
@@ -65,15 +75,16 @@ class Failure(_t.List[str]):
         self.sort()
 
     def _add(self, value: _Message, hint: bool = False, **kwargs) -> None:
-        message = value.fstring(_TEMPLATE)
-        if kwargs:
-            message = message.format(**kwargs)
-
-        if hint:
-            message += f"\n    hint: {value.hint}"
-
-        if value not in self._func.messages and message not in self:
-            super().append(message)
+        failed = Failed(
+            self._name,
+            value.ref,
+            value.description.format(**kwargs),
+            value.symbolic,
+            self._func.lineno,
+            value.hint if hint else None,
+        )
+        if value not in self._func.messages and failed not in self:
+            super().append(failed)
 
     def _sig0xx_config(self) -> None:
         for comment in self._func.comments:
@@ -171,7 +182,7 @@ class Failure(_t.List[str]):
         elif doc != sig:
             if (
                 sig.name in self._func.docstring.args.names
-                or doc.name in self.func.signature.args.names
+                or doc.name in self._func.signature.args.names
             ):
                 # params-out-of-order
                 self._add(_E[402])
@@ -218,42 +229,15 @@ class Failure(_t.List[str]):
                 self._add(_E[505], hint=True)
 
     @property
-    def func(self) -> _Function:
-        """Function this failure belongs to."""
-        return self._func
+    def name(self) -> str:
+        """Function name."""
+        return self._name
+
+    @property
+    def lineno(self) -> int:
+        """Function line number."""
+        return self._func.lineno
 
 
 class Failures(_t.List[Failure]):
     """Sequence of failed functions."""
-
-
-class Report(_t.Dict[str, _t.List[Failures]]):
-    """Collect and display report."""
-
-    def __getitem__(self, key: str) -> list[Failures]:
-        if key not in super().__iter__():
-            super().__setitem__(key, [])
-
-        return super().__getitem__(key)
-
-    def print(self, no_ansi: bool) -> None:
-        """Display report summary if any checks have failed.
-
-        :param no_ansi: Disable ANSI output.
-        """
-        for key, value in self.items():
-            for failures in value:
-                for failure in failures:
-                    header = f"{key}{failure.func.lineno}"
-                    function = failure.func.name
-                    if failure.func.parent.name:
-                        function = f"{failure.func.parent.name}.{function}"
-
-                    header += f" in {function}"
-                    _click.echo(
-                        "{}\n    {}".format(
-                            _click.style(header, fg="magenta"),
-                            "\n    ".join(failure),
-                        ),
-                        color=not no_ansi and _sys.stdout.isatty(),
-                    )

{docsig-0.57.0 → docsig-0.58.0}/docsig/_stub.py

@@ -21,37 +21,6 @@ UNNAMED = -1000
 VALID_DESCRIPTION = " A valid description."
 
 
-# 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__(
-            cls,
-            _textwrap.dedent("\n".join(string.splitlines()[1:])).replace(
-                "*", ""
-            ),
-        )
-
-
-# noinspection PyTypeChecker
-class _RawDocstring(str):
-    def __new__(cls, string: str) -> _RawDocstring:
-        return super().__new__(
-            cls, _NumpyDocstring(_GoogleDocstring(_DocFmt(string)))
-        )
-
-
 class RetType(_Enum):
     """Defines the possible types of a return annotation."""
 
@@ -356,6 +325,22 @@ class Docstring(_Stub):
         # description
         return any(i.endswith(":") for i in new.splitlines())
 
+    @staticmethod
+    def _normalize_docstring(string: str) -> str:
+        # convert google and numpy style docstrings to parse docstrings
+        # as restructured text
+        return str(
+            _s.NumpyDocstring(
+                str(
+                    _s.GoogleDocstring(
+                        _textwrap.dedent(
+                            "\n".join(string.splitlines()[1:])
+                        ).replace("*", "")
+                    )
+                )
+            )
+        )
+
     def __init__(
         self,
         node: _ast.Const | None = None,
@@ -365,7 +350,7 @@ class Docstring(_Stub):
         super().__init__(ignore_args, ignore_kwargs)
         self._string = None
         if node is not None:
-            self._string = _RawDocstring(node.value)
+            self._string = self._normalize_docstring(node.value)
             for i in _Matches(
                 self._string,
                 self._indent_anomaly(node.value),
@@ -378,7 +363,7 @@ class Docstring(_Stub):
         )
 
     @property
-    def string(self) -> _RawDocstring | None:
+    def string(self) -> str | None:
         """The raw documentation string, if it exists, else None."""
         return self._string
 

{docsig-0.57.0 → docsig-0.58.0}/docsig/_utils.py

@@ -9,8 +9,6 @@ import sys as _sys
 import typing as _t
 from difflib import SequenceMatcher as _SequenceMatcher
 
-import click as _click
-
 from .messages import TEMPLATE as _TEMPLATE
 from .messages import E as _E
 
@@ -35,7 +33,7 @@ def vprint(msg: str, verbose: bool = False) -> None:
     :param verbose: Whether verbose mode is enabled.
     """
     if verbose:
-        _click.echo(msg)
+        print(msg)
 
 
 def pretty_print_error(
@@ -47,17 +45,17 @@ def pretty_print_error(
     :param msg: The exception message.
     :param no_ansi: Whether to in ANSI escape codes.
     """
-    _click.echo(
-        f"{_click.style(exception_type.__name__, fg='red', bold=True)}: {msg}",
-        file=_sys.stderr,
-        color=not no_ansi and _sys.stderr.isatty(),
-    )
+    exception_type_name = exception_type.__name__
+    if not no_ansi and _sys.stdout.isatty():
+        exception_type_name = f"\033[1;31m{exception_type_name}\033[0m"
+
+    print(f"{exception_type_name}: {msg}", file=_sys.stderr)
 
 
 def print_checks() -> None:
     """Print all available checks."""
     for msg in _E.values():
-        _click.echo(msg.fstring(_TEMPLATE))
+        print(msg.fstring(_TEMPLATE))
 
 
 def has_bad_return(string: str) -> bool:

{docsig-0.57.0 → docsig-0.58.0}/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.57.0"
+__version__ = "0.58.0"

{docsig-0.57.0 → docsig-0.58.0}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.57.0"
+current_version = "0.58.0"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -42,6 +42,11 @@ filename = "README.rst"
 replace = "docsig: {new_version}"
 search = "docsig: {current_version}"
 
+[[tool.bumpversion.files]]
+filename = "README.rst"
+replace = "- docsig=={new_version}"
+search = "- docsig=={current_version}"
+
 [[tool.bumpversion.files]]
 filename = "SECURITY.md"
 
@@ -127,13 +132,12 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.57.0"
+version = "0.58.0"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
 arcon = ">=0.4.0"
 astroid = "^3.0.1"
-click = "^8.1.7"
 pathspec = "^0.12.1"
 python = "^3.8.1"
 
@@ -170,6 +174,7 @@ flake8 = "^7.1.0"
 pytest = "^8.2.0"
 pytest-benchmark = "^4.0.0"
 pytest-cov = "^5.0.0"
+pytest-gitignore = "^1.3"
 pytest-randomly = "^3.15.0"
 pytest-sugar = "^1.0.0"
 pytest-xdist = "^3.6.1"