docsig 0.59.0__tar.gz → 0.59.2__tar.gz

{docsig-0.59.0 → docsig-0.59.2}/PKG-INFO

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

{docsig-0.59.0 → docsig-0.59.2}/README.rst

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

{docsig-0.59.0 → docsig-0.59.2}/docsig/_core.py

@@ -14,7 +14,6 @@ from . import _decorators
 from ._directives import Directives as _Directives
 from ._files import FILE_INFO as _FILE_INFO
 from ._files import Paths as _Paths
-from ._module import Ast as _Ast
 from ._module import Function as _Function
 from ._module import Parent as _Parent
 from ._report import Failure as _Failure
@@ -27,20 +26,20 @@ from .messages import Messages as _Messages
 
 _DEFAULT_EXCLUDES = """\
 (?x)^(
-    |\\.?venv
-    |\\.git
-    |\\.hg
-    |\\.idea
-    |\\.mypy_cache
-    |\\.nox
-    |\\.pytest_cache
-    |\\.svn
-    |\\.tox
-    |\\.vscode
-    |_?build
-    |__pycache__
-    |dist
-    |node_modules
+    |\\.?venv[\\\\/].*
+    |\\.git[\\\\/].*
+    |\\.hg[\\\\/].*
+    |\\.idea[\\\\/].*
+    |\\.mypy_cache[\\\\/].*
+    |\\.nox[\\\\/].*
+    |\\.pytest_cache[\\\\/].*
+    |\\.svn[\\\\/].*
+    |\\.tox[\\\\/].*
+    |\\.vscode[\\\\/].*
+    |_?build[\\\\/].*
+    |__pycache__[\\\\/].*
+    |dist[\\\\/].*
+    |node_modules[\\\\/].*
 )$
 """
 
@@ -119,6 +118,56 @@ def _run_check(  # pylint: disable=too-many-arguments,too-many-locals
             )
 
 
+def _parse_ast(  # pylint: disable=too-many-arguments
+    messages: _Messages,
+    ignore_args: bool,
+    ignore_kwargs: bool,
+    check_class_constructor,
+    verbose: bool,
+    no_ansi: bool,
+    root: _Path | None = None,
+    string: str | None = None,
+) -> tuple[_Parent | None, int]:
+    parent = None
+    retcode = 0
+    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(string, messages),
+            root,
+            ignore_args,
+            ignore_kwargs,
+            check_class_constructor,
+        )
+        _vprint(
+            _FILE_INFO.format(
+                path=root or "stdin", msg="Parsing Python code successful"
+            ),
+            verbose,
+        )
+    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
+            print(root, file=_sys.stderr)
+            _pretty_print_error(type(err), msg, no_ansi=no_ansi)
+            retcode = 1
+
+        _vprint(
+            _FILE_INFO.format(path=root or "stdin", msg=msg),
+            verbose,
+        )
+
+    return parent, retcode
+
+
 def _get_failures(  # pylint: disable=too-many-locals,too-many-arguments
     module: _Parent,
     check_class: bool,
@@ -228,22 +277,16 @@ def runner(  # pylint: disable=too-many-locals,too-many-arguments
     :return: Exit status for whether test failed or not.
     """
     failures = _Failures()
-    path = _Path(file)
-    string = path.read_text(encoding="utf-8")
-    ast = _Ast.parse(string)
-    if ast.success:
-        _vprint(
-            _FILE_INFO.format(path=path, msg="Parsing Python code successful"),
-            verbose,
-        )
-        module = _Parent(
-            ast.module,
-            _Directives(string, disable or _Messages()),
-            path,
-            ignore_args,
-            ignore_kwargs,
-            check_class_constructor,
-        )
+    module, retcode = _parse_ast(
+        disable or _Messages(),
+        ignore_args,
+        ignore_kwargs,
+        check_class_constructor,
+        verbose,
+        no_ansi,
+        root=_Path(file),
+    )
+    if module:
         failures = _get_failures(
             module,
             check_class,
@@ -259,20 +302,8 @@ def runner(  # pylint: disable=too-many-locals,too-many-arguments
             no_ansi,
             target or _Messages(),
         )
-        return failures, 0
-
-    if path.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
-        print(path, file=_sys.stderr)
-        _pretty_print_error(type(ast.err), str(ast.err), no_ansi=no_ansi)
-        return failures, 1
 
-    _vprint(
-        _FILE_INFO.format(path=path, msg=str(ast.err)),
-        verbose,
-    )
-    return failures, 0
+    return failures, retcode
 
 
 @_decorators.parse_msgs
@@ -380,21 +411,16 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
 
         return retcode
 
-    ast = _Ast.parse(string)
-    if ast.success:
-        _vprint(
-            _FILE_INFO.format(
-                path="stdin", msg="Parsing Python code successful"
-            ),
-            verbose,
-        )
-        module = _Parent(
-            _ast.parse(string),
-            _Directives(string, messages=disable or _Messages()),
-            ignore_args=ignore_args,
-            ignore_kwargs=ignore_kwargs,
-            check_class_constructor=check_class_constructor,
-        )
+    module, retcode = _parse_ast(
+        disable or _Messages(),
+        ignore_args,
+        ignore_kwargs,
+        check_class_constructor,
+        verbose,
+        no_ansi,
+        string=string,
+    )
+    if module is not None:
         failures = _get_failures(
             module,
             check_class,
@@ -414,6 +440,4 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
             _report(failures, no_ansi=no_ansi)
             return 1
 
-        _vprint(_FILE_INFO.format(path="stdin", msg=str(ast.err)), verbose)
-
     return 0

{docsig-0.59.0 → docsig-0.59.2}/docsig/_files.py

@@ -88,21 +88,24 @@ class Paths(_t.List[_Path]):  # pylint: disable=too-many-instance-attributes
         for path in paths:
             self._populate(path)
 
+        for path in list(self):
+            if str(path) != "." and any(
+                _re.match(i, str(path)) for i in self._excludes
+            ):
+                _vprint(
+                    FILE_INFO.format(
+                        path=path, msg="in exclude list, skipping"
+                    ),
+                    self._verbose,
+                )
+                self.remove(path)
+
         self.sort()
 
     def _populate(self, root: _Path) -> None:
         if not root.exists():
             raise FileNotFoundError(root)
 
-        if str(root) != "." and any(
-            _re.match(i, root.name) for i in self._excludes
-        ):
-            _vprint(
-                FILE_INFO.format(path=root, msg="in exclude list, skipping"),
-                self._verbose,
-            )
-            return
-
         if not self._include_ignored and self._gitignore.match_file(root):
             _vprint(
                 FILE_INFO.format(path=root, msg="in gitignore, skipping"),

{docsig-0.59.0 → docsig-0.59.2}/docsig/_module.py

@@ -308,23 +308,3 @@ class Function(Parent):
         :param rettype: Return type of overloaded signature.
         """
         self._signature.overload(rettype)
-
-
-class Ast(_t.NamedTuple):
-    """Object resulting from parsing an AST."""
-
-    module: _ast.Module = _ast.Module("")
-    err: Exception = Exception()
-    success: bool = False
-
-    @classmethod
-    def parse(cls, string: str) -> Ast:
-        """Parse an AST.
-
-        :param string: String to parse.
-        :return: Constructed AST object, whether successful or not.
-        """
-        try:
-            return cls(module=_ast.parse(string), success=True)
-        except (_ast.AstroidSyntaxError, UnicodeDecodeError) as err:
-            return cls(err=err)

{docsig-0.59.0 → docsig-0.59.2}/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.59.0"
+__version__ = "0.59.2"

{docsig-0.59.0 → docsig-0.59.2}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.59.0"
+current_version = "0.59.2"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -132,7 +132,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.59.0"
+version = "0.59.2"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
@@ -144,7 +144,7 @@ python = "^3.8.1"
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
 bump-my-version = "^0.24.1"
-deptry = "^0.16.1"
+deptry = ">=0.16.1,<0.18.0"
 docformatter = "^1.7.5"
 flynt = "^1.0.1"
 gitpython = "^3.1.43"
@@ -160,6 +160,7 @@ vulture = "^2.11"
 
 [tool.poetry.group.docs.dependencies]
 furo = "^2024.4.27"
+incremental = "22.10.0"
 myst-parser = "^3.0.1"
 pytest = "^8.2.0"
 pyyaml = "^6.0.1"