docsig 0.36.0__tar.gz → 0.37.0__tar.gz

{docsig-0.36.0 → docsig-0.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.36.0
+Version: 0.37.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT

{docsig-0.36.0 → docsig-0.37.0}/docsig/_core.py

@@ -2,19 +2,30 @@
 docsig._core
 ============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
+import sys as _sys
+from os import environ as _e
 from pathlib import Path as _Path
 
 from ._display import Display as _Display
 from ._display import Failure as _Failure
 from ._display import Failures as _Failures
 from ._display import FuncStr as _FuncStr
+from ._display import color as _color
 from ._module import Modules as _Modules
 from ._module import Parent as _Parent
 from ._report import generate_report as _generate_report
 
 
+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}"
+        )
+
+
 def _run_check(  # pylint: disable=too-many-arguments
     parent: _Parent,
     check_class: bool,
@@ -25,11 +36,9 @@ def _run_check(  # pylint: disable=too-many-arguments
     ignore_no_params: bool,
     no_ansi: bool,
     targets: list[str],
-    disable: list[str],
 ) -> _Failures:
     failures = _Failures()
     for func in parent:
-        disable_func = list({*disable, *func.disabled})
         if not (func.isoverridden and not check_overridden) and (
             not (func.isprotected and not check_protected)
             and not (func.isinit and not check_class)
@@ -37,7 +46,7 @@ def _run_check(  # pylint: disable=too-many-arguments
             and not (func.docstring.bare and ignore_no_params)
         ):
             report = _generate_report(
-                func, targets, disable_func, check_property_returns
+                func, targets, func.disabled, check_property_returns
             )
             if report:
                 failures.append(
@@ -91,6 +100,7 @@ def docsig(  # pylint: disable=too-many-locals
     """
     modules = _Modules(
         *path,
+        disable=disable or [],
         string=string,
         ignore_args=ignore_args,
         ignore_kwargs=ignore_kwargs,
@@ -109,7 +119,6 @@ def docsig(  # pylint: disable=too-many-locals
                     ignore_no_params,
                     no_ansi,
                     targets or [],
-                    disable or [],
                 )
                 if failures:
                     display[top_level.path].append(failures)

{docsig-0.36.0 → docsig-0.37.0}/docsig/_disable.py

@@ -2,31 +2,33 @@
 docsig._disable
 ===============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 import tokenize as _tokenize
-import typing as t
+import typing as _t
 from io import StringIO as _StringIO
 
 from ._report import ERRORS as _ERRORS
 
 
-class Disabled(t.Dict[int, t.List[str]]):
+class Disabled(_t.Dict[int, _t.List[str]]):
     """Data for lines which are excluded from checks.
 
     :param text: Python code.
+    :param disable: List of checks to disable.
     """
 
-    def __init__(self, text: str) -> None:
+    def __init__(self, text: str, disable: list[str]) -> None:
         super().__init__()
         fin = _StringIO(text)
         module_is_disabled = False
         for line in _tokenize.generate_tokens(fin.readline):
             lineno = line.start[0]
             col = line.start[1]
+            self[lineno] = list(disable)
             if line.type == _tokenize.COMMENT:
-                if line.string.startswith(f"# {__package__}:"):
-                    string = line.string.split(": ")[1]
+                if line.string[1:].strip().startswith(f"{__package__}:"):
+                    string = line.string.split(":")[1].strip()
 
                     # module level comments
                     if col == 0:
@@ -37,11 +39,11 @@ class Disabled(t.Dict[int, t.List[str]]):
 
                     # otherwise, inline comments
                     elif string == "disable":
-                        self[lineno] = list(_ERRORS)
+                        self[lineno].extend(_ERRORS)
 
             # keep appending disabled lines as long as this is true
             if module_is_disabled:
-                self[lineno] = list(_ERRORS)
+                self[lineno].extend(_ERRORS)
 
     def __setitem__(self, key: int, value: list[str]) -> None:
         if key not in self:

{docsig-0.36.0 → docsig-0.37.0}/docsig/_display.py

@@ -2,7 +2,7 @@
 docsig._display
 ===============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 import typing as _t
 from collections import UserString as _UserString
@@ -20,7 +20,6 @@ from ._function import ARG as _ARG
 from ._function import KEY as _KEY
 from ._function import Function as _Function
 from ._function import Param as _Param
-from ._objects import MutableSequence as _MutableSequence
 from ._report import Report as _Report
 
 color = _Color()
@@ -205,7 +204,7 @@ class Failure(_t.NamedTuple):
     report: _Report
 
 
-class Failures(_MutableSequence[Failure]):
+class Failures(_t.List[Failure]):
     """Sequence of failed functions."""
 
 

{docsig-0.36.0 → docsig-0.37.0}/docsig/_function.py

@@ -2,7 +2,7 @@
 docsig._function
 ================
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 import re as _re
 import textwrap as _textwrap
@@ -75,7 +75,7 @@ class Param(_t.NamedTuple):
         return str(self.name).startswith("_")
 
 
-class _Matches(_MutableSequence[Param]):
+class _Matches(_t.List[Param]):
     _pattern = _re.compile(":(.*?):")
     _normalize = {KEYWORD: KEY}
 

{docsig-0.36.0 → docsig-0.37.0}/docsig/_main.py

@@ -6,6 +6,7 @@ Contains package entry point.
 """
 from ._config import Parser as _Parser
 from ._core import docsig as _docsig
+from ._core import pretty_print_error as _pretty_print_error
 
 
 def main() -> int:
@@ -16,6 +17,7 @@ def main() -> int:
     :return: Exit status for whether test failed or not.
     """
     parser = _Parser()
+    _pretty_print_error()
     return _docsig(
         *parser.args.path,
         string=parser.args.string,

{docsig-0.36.0 → docsig-0.37.0}/docsig/_module.py

@@ -2,21 +2,19 @@
 docsig._module
 ==============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
+import typing as _t
 from pathlib import Path as _Path
 
 import astroid as _ast
 
 from ._disable import Disabled as _Disabled
 from ._function import Function as _Function
-from ._objects import MutableSequence as _MutableSequence
 from ._utils import isprotected as _isprotected
 
 
-class Parent(  # pylint: disable=too-many-arguments
-    _MutableSequence[_Function]
-):
+class Parent(_t.List[_Function]):
     """Represents an object that contains functions or methods.
 
     :param node: Parent's abstract syntax tree.
@@ -26,7 +24,7 @@ class Parent(  # pylint: disable=too-many-arguments
     :param ignore_kwargs: Ignore kwargs prefixed with two asterisks.
     """
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         node: _ast.Module | _ast.ClassDef,
         disabled: _Disabled,
@@ -37,7 +35,6 @@ class Parent(  # pylint: disable=too-many-arguments
         super().__init__()
         self._name = node.name
         self._path = f"{path}:" if path is not None else ""
-        self._directives = disabled
         overloads = []
         returns = None
         for subnode in node.body:
@@ -54,11 +51,15 @@ class Parent(  # pylint: disable=too-many-arguments
                 else:
                     if func.name in overloads:
                         subnode.returns = returns
-                        func = _Function(
-                            subnode,
-                            disabled.get(subnode.lineno, []),
-                            ignore_args,
-                            ignore_kwargs,
+                        # noinspection PyProtectedMember
+                        func._signature._rettype = (
+                            returns
+                            if isinstance(returns, str)
+                            else func._signature._get_rettype(returns)
+                        )
+                        # noinspection PyProtectedMember
+                        func._signature._returns = (
+                            str(func._signature._rettype) != "None"
                         )
 
                     self.append(func)
@@ -74,17 +75,18 @@ class Parent(  # pylint: disable=too-many-arguments
         return _isprotected(self._name)
 
 
-class _Module(_MutableSequence[Parent]):
-    def __init__(
+class _Module(_t.List[Parent]):
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         string: str,
+        disable: list[str],
         path: _Path | None = None,
         ignore_args: bool = False,
         ignore_kwargs: bool = False,
     ) -> None:
         super().__init__()
         ast = _ast.parse(string)
-        disabled = _Disabled(string)
+        disabled = _Disabled(string, disable)
         self.append(Parent(ast, disabled, path, ignore_args, ignore_kwargs))
         for subnode in ast.body:
             if isinstance(subnode, _ast.ClassDef):
@@ -93,7 +95,7 @@ class _Module(_MutableSequence[Parent]):
                 )
 
 
-class Modules(_MutableSequence[_Module]):
+class Modules(_t.List[_Module]):
     """Sequence of ``Module`` objects parsed from Python modules or str.
 
     Recursively collect Python files from within all dirs that exist
@@ -102,6 +104,7 @@ class Modules(_MutableSequence[_Module]):
     If string is provided, ignore paths.
 
     :param paths: Path(s) to parse ``Module``(s) from.
+    :param disable: List of checks to disable.
     :param string: String to parse if provided.
     :param ignore_args: Ignore args prefixed with an asterisk.
     :param ignore_kwargs: Ignore kwargs prefixed with two asterisks.
@@ -110,17 +113,20 @@ class Modules(_MutableSequence[_Module]):
     def __init__(
         self,
         *paths: _Path,
+        disable: list[str],
         string: str | None = None,
         ignore_args: bool = False,
         ignore_kwargs: bool = False,
     ) -> None:
         super().__init__()
+        self._disable = disable
         self._ignore_args = ignore_args
         self._ignore_kwargs = ignore_kwargs
         if string is not None:
             self.append(
                 _Module(
                     string,
+                    disable,
                     ignore_args=ignore_args,
                     ignore_kwargs=ignore_kwargs,
                 )
@@ -130,10 +136,14 @@ class Modules(_MutableSequence[_Module]):
                 self._populate(path)
 
     def _populate(self, root: _Path) -> None:
+        if not root.exists():
+            raise FileNotFoundError(root)
+
         if root.is_file() and root.name.endswith(".py"):
             self.append(
                 _Module(
                     root.read_text(),
+                    self._disable,
                     root,
                     self._ignore_args,
                     self._ignore_kwargs,

{docsig-0.36.0 → docsig-0.37.0}/docsig/_objects.py

@@ -2,7 +2,7 @@
 docsig._objects
 ===============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 import typing as _t
 

{docsig-0.36.0 → docsig-0.37.0}/docsig/_report.py

@@ -2,7 +2,7 @@
 docsig._report
 ==============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 from . import messages as _messages
 from ._function import RETURN as _RETURN

{docsig-0.36.0 → docsig-0.37.0}/docsig/_utils.py

@@ -2,7 +2,7 @@
 docsig._utils
 =============
 """
-from __future__ import annotations
+from __future__ import annotations as _
 
 from difflib import SequenceMatcher as _SequenceMatcher
 

{docsig-0.36.0 → docsig-0.37.0}/docsig/_version.py

@@ -7,4 +7,4 @@ Contains the version of this package.
 Allows for access to the version internally without cyclic imports
 caused by accessing it through __init__.
 """
-__version__ = "0.36.0"
+__version__ = "0.37.0"

{docsig-0.36.0 → docsig-0.37.0}/pyproject.toml

@@ -70,7 +70,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.36.0"
+version = "0.37.0"
 
 [tool.poetry.dependencies]
 Pygments = "^2.13.0"