docsig 0.63.0__tar.gz → 0.64.0__tar.gz

{docsig-0.63.0 → docsig-0.64.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.63.0
+Version: 0.64.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -180,7 +180,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.63.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.64.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
 
@@ -269,7 +269,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.63.0
+        rev: v0.64.0
         hooks:
           - id: docsig
             args:
@@ -288,7 +288,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.63.0
+              - docsig==0.64.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.63.0 → docsig-0.64.0}/README.rst

@@ -153,7 +153,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.63.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.64.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
 
@@ -242,7 +242,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.63.0
+        rev: v0.64.0
         hooks:
           - id: docsig
             args:
@@ -261,7 +261,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.63.0
+              - docsig==0.64.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.63.0 → docsig-0.64.0}/docsig/_core.py

@@ -133,23 +133,44 @@ def _run_check(  # pylint: disable=too-many-arguments,too-many-locals
             )
 
 
-def _parse_ast(  # pylint: disable=too-many-arguments
+def _from_file(
+    root: _Path,
+    messages: _Messages,
+    ignore_args: bool,
+    ignore_kwargs: bool,
+    check_class_constructor,
+) -> _Parent:
+    try:
+        string = root.read_text(encoding="utf-8")
+        parent = _from_str(
+            messages=messages,
+            string=string,
+            root=root,
+            ignore_args=ignore_args,
+            ignore_kwargs=ignore_kwargs,
+            check_class_constructor=check_class_constructor,
+        )
+    except UnicodeDecodeError as err:
+        logger = _logging.getLogger(__package__)
+        logger.debug(_FILE_INFO, root, str(err).replace("\n", " "))
+        parent = _Parent(error=_Error.UNICODE)
+
+    if parent.error is not None and not root.name.endswith(".py"):
+        parent = _Parent()
+
+    return parent
+
+
+def _from_str(  # pylint: disable=too-many-arguments
+    string: str,
     messages: _Messages,
     ignore_args: bool,
     ignore_kwargs: bool,
     check_class_constructor,
     root: _Path | None = None,
-    string: str | None = None,
 ) -> _Parent:
     logger = _logging.getLogger(__package__)
-    parent = _Parent()
     try:
-        if root is not None:
-            string = root.read_text(encoding="utf-8")
-
-        # empty string won't happen but keeps the
-        # typechecker happy
-        string = string or ""
         parent = _Parent(
             _ast.parse(string),
             _Directives.from_text(string, messages),
@@ -161,13 +182,9 @@ def _parse_ast(  # pylint: disable=too-many-arguments
         logger.debug(
             _FILE_INFO, root or "stdin", "Parsing Python code successful"
         )
-        return parent
-    except (_ast.AstroidSyntaxError, UnicodeDecodeError) as err:
-        msg = str(err).replace("\n", " ")
-        if root is not None and root.name.endswith(".py"):
-            parent = _Parent(error=_Error.SYNTAX)
-
-        logger.debug(_FILE_INFO, root or "stdin", msg)
+    except _ast.AstroidSyntaxError as err:
+        logger.debug(_FILE_INFO, root or "stdin", str(err).replace("\n", " "))
+        parent = _Parent(error=_Error.SYNTAX)
 
     return parent
 
@@ -217,7 +234,7 @@ def _get_failures(  # pylint: disable=too-many-arguments
 def _report(
     failures: _Failures, path: str | None = None, no_ansi: bool = False
 ) -> int:
-    retcodes = []
+    retcodes = [0]
     for failure in failures:
         retcodes.append(failure.retcode)
         module = f"{path}:" if path is not None else ""
@@ -282,32 +299,28 @@ def runner(  # pylint: disable=too-many-locals,too-many-arguments
     :param target: List of errors to target.
     :return: Exit status for whether test failed or not.
     """
-    failures = _Failures()
-    module = _parse_ast(
+    module = _from_file(
+        _Path(file),
         disable or _Messages(),
         ignore_args,
         ignore_kwargs,
         check_class_constructor,
-        root=_Path(file),
     )
-    if module or module.error is not None:
-        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(),
-        )
-
-    return failures
+    return _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(),
+    )
 
 
 @_decorators.parse_msgs
@@ -386,7 +399,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
     if string is None:
         retcodes = [0]
         paths = _Paths(
-            *tuple(_Path(i) for i in path),
+            *path,
             patterns=patterns,
             excludes=excludes or [],
             include_ignored=include_ignored,
@@ -410,35 +423,30 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
                 no_ansi,
                 target,
             )
-            if failures:
-                retcodes.append(_report(failures, str(file), no_ansi))
+            retcodes.append(_report(failures, str(file), no_ansi))
 
         return max(retcodes)
 
-    module = _parse_ast(
+    module = _from_str(
+        string,
         disable or _Messages(),
         ignore_args,
         ignore_kwargs,
         check_class_constructor,
-        string=string,
     )
-    if module or module.error is not None:
-        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:
-            return _report(failures, no_ansi=no_ansi)
-
-    return 0
+    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(),
+    )
+    return _report(failures, no_ansi=no_ansi)

{docsig-0.63.0 → docsig-0.64.0}/docsig/_files.py

@@ -80,19 +80,19 @@ class Paths(_t.List[_Path]):
 
     def __init__(
         self,
-        *paths: _Path,
+        *paths: _Path | str,
         patterns: list[str],
         excludes: list[str],
         include_ignored: bool = False,
     ) -> None:
         super().__init__()
         self._patterns = patterns
-        self._excludes = excludes
+        self._excludes = excludes or []
         self._include_ignored = include_ignored
         self._gitignore = _Gitignore()
         self._logger = _logging.getLogger(__package__)
         for path in paths:
-            self._populate(path)
+            self._populate(_Path(path))
 
         for path in list(self):
             if str(path) != "." and (

{docsig-0.63.0 → docsig-0.64.0}/docsig/_module.py

@@ -24,6 +24,7 @@ class Error(_Enum):
     """Represents an unrecoverable error."""
 
     SYNTAX = 1
+    UNICODE = 2
 
 
 class _Imports(_t.Dict[str, str]):
@@ -72,11 +73,6 @@ class Parent(_t.List["Parent"]):
             self._imports = imports or _Imports()
             self._parse_ast(node, directives or _Directives(), path)
 
-    def _parse_imports(self, names: list[tuple[str, str | None]]) -> None:
-        for name in names:
-            original, alias = name
-            self._imports[original] = alias or original
-
     def _parse_ast(
         self,
         node: _ast.Module | _ast.ClassDef | _ast.FunctionDef | _ast.NodeNG,
@@ -97,7 +93,9 @@ class Parent(_t.List["Parent"]):
                 comments.extend(parent_comments)
                 disabled.extend(parent_disabled)
                 if isinstance(subnode, (_ast.Import, _ast.ImportFrom)):
-                    self._parse_imports(subnode.names)
+                    for name in subnode.names:
+                        original, alias = name
+                        self._imports[original] = alias or original
                 elif isinstance(subnode, _ast.FunctionDef):
                     func = Function(
                         subnode,

{docsig-0.63.0 → docsig-0.64.0}/docsig/_report.py

@@ -239,6 +239,8 @@ class Failure(_t.List[Failed]):
         if self._func.error == _Error.SYNTAX:
             self._add(_E[901])
             self._retcode = 123
+        if self._func.error == _Error.UNICODE:
+            self._add(_E[902])
 
     @property
     def name(self) -> str:

{docsig-0.63.0 → docsig-0.64.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.63.0"
+__version__ = "0.64.0"

{docsig-0.63.0 → docsig-0.64.0}/docsig/messages.py

@@ -254,5 +254,11 @@ E = MessageMap(
             "parsing python code failed",
             "invalid-syntax",
         ),
+        902: Message(
+            "SIG902",
+            "SIG902",
+            "failed to read file",
+            "unicode-decode-error",
+        ),
     }
 )

{docsig-0.63.0 → docsig-0.64.0}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.63.0"
+current_version = "0.64.0"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -131,7 +131,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.63.0"
+version = "0.64.0"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"