docsig 0.59.3__tar.gz → 0.60.1__tar.gz

{docsig-0.59.3 → docsig-0.60.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.59.3
+Version: 0.60.1
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -20,6 +20,7 @@ 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: pathspec (>=0.12.1,<0.13.0)
+Requires-Dist: wcmatch (>=8.5.2,<10.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
@@ -106,40 +107,42 @@ Commandline
 .. code-block:: console
 
     usage: docsig [-h] [-V] [-l] [-c | -C] [-D] [-m] [-N] [-o] [-p] [-P] [-i] [-a] [-k] [-T]
-                  [-I] [-n] [-v] [-s STR] [-d LIST] [-t LIST] [-e PATTERN]
+                  [-I] [-n] [-v] [-s STR] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
                   [path [path ...]]
 
     Check signature params for proper documentation
 
     positional arguments:
-      path                                 directories or files to check
+      path                                  directories or files to check
 
     optional arguments:
-      -h, --help                           show this help message and exit
-      -V, --version                        show program's version number and exit
-      -l, --list-checks                    display a list of all checks and their messages
-      -c, --check-class                    check class docstrings
-      -C, --check-class-constructor        check __init__ methods. Note: mutually incompatible
-                                           with -c
-      -D, --check-dunders                  check dunder methods
-      -m, --check-protected-class-methods  check public methods belonging to protected classes
-      -N, --check-nested                   check nested functions and classes
-      -o, --check-overridden               check overridden methods
-      -p, --check-protected                check protected functions and classes
-      -P, --check-property-returns         check property return values
-      -i, --ignore-no-params               ignore docstrings where parameters are not
-                                           documented
-      -a, --ignore-args                    ignore args prefixed with an asterisk
-      -k, --ignore-kwargs                  ignore kwargs prefixed with two asterisks
-      -T, --ignore-typechecker             ignore checking return values
-      -I, --include-ignored                check files even if they match a gitignore pattern
-      -n, --no-ansi                        disable ansi output
-      -v, --verbose                        increase output verbosity
-      -s STR, --string STR                 string to parse instead of files
-      -d LIST, --disable LIST              comma separated list of rules to disable
-      -t LIST, --target LIST               comma separated list of rules to target
-      -e PATTERN, --exclude PATTERN        regular expression of files or dirs to exclude from
-                                           checks
+      -h, --help                            show this help message and exit
+      -V, --version                         show program's version number and exit
+      -l, --list-checks                     display a list of all checks and their messages
+      -c, --check-class                     check class docstrings
+      -C, --check-class-constructor         check __init__ methods. Note: mutually incompatible
+                                            with -c
+      -D, --check-dunders                   check dunder methods
+      -m, --check-protected-class-methods   check public methods belonging to protected classes
+      -N, --check-nested                    check nested functions and classes
+      -o, --check-overridden                check overridden methods
+      -p, --check-protected                 check protected functions and classes
+      -P, --check-property-returns          check property return values
+      -i, --ignore-no-params                ignore docstrings where parameters are not
+                                            documented
+      -a, --ignore-args                     ignore args prefixed with an asterisk
+      -k, --ignore-kwargs                   ignore kwargs prefixed with two asterisks
+      -T, --ignore-typechecker              ignore checking return values
+      -I, --include-ignored                 check files even if they match a gitignore pattern
+      -n, --no-ansi                         disable ansi output
+      -v, --verbose                         increase output verbosity
+      -s STR, --string STR                  string to parse instead of files
+      -d LIST, --disable LIST               comma separated list of rules to disable
+      -t LIST, --target LIST                comma separated list of rules to target
+      -e PATTERN, --exclude PATTERN         regular expression of files or dirs to exclude from
+                                            checks
+      -E PATH [PATH ...], --excludes PATH [PATH ...]
+                                            path glob patterns to exclude from checks
 
 Options can also be configured with the pyproject.toml file
 
@@ -169,7 +172,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.59.3, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.60.1, 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 +261,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.59.3
+        rev: v0.60.1
         hooks:
           - id: docsig
             args:
@@ -277,7 +280,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.59.3
+              - docsig==0.60.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.59.3 → docsig-0.60.1}/README.rst

@@ -80,40 +80,42 @@ Commandline
 .. code-block:: console
 
     usage: docsig [-h] [-V] [-l] [-c | -C] [-D] [-m] [-N] [-o] [-p] [-P] [-i] [-a] [-k] [-T]
-                  [-I] [-n] [-v] [-s STR] [-d LIST] [-t LIST] [-e PATTERN]
+                  [-I] [-n] [-v] [-s STR] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
                   [path [path ...]]
 
     Check signature params for proper documentation
 
     positional arguments:
-      path                                 directories or files to check
+      path                                  directories or files to check
 
     optional arguments:
-      -h, --help                           show this help message and exit
-      -V, --version                        show program's version number and exit
-      -l, --list-checks                    display a list of all checks and their messages
-      -c, --check-class                    check class docstrings
-      -C, --check-class-constructor        check __init__ methods. Note: mutually incompatible
-                                           with -c
-      -D, --check-dunders                  check dunder methods
-      -m, --check-protected-class-methods  check public methods belonging to protected classes
-      -N, --check-nested                   check nested functions and classes
-      -o, --check-overridden               check overridden methods
-      -p, --check-protected                check protected functions and classes
-      -P, --check-property-returns         check property return values
-      -i, --ignore-no-params               ignore docstrings where parameters are not
-                                           documented
-      -a, --ignore-args                    ignore args prefixed with an asterisk
-      -k, --ignore-kwargs                  ignore kwargs prefixed with two asterisks
-      -T, --ignore-typechecker             ignore checking return values
-      -I, --include-ignored                check files even if they match a gitignore pattern
-      -n, --no-ansi                        disable ansi output
-      -v, --verbose                        increase output verbosity
-      -s STR, --string STR                 string to parse instead of files
-      -d LIST, --disable LIST              comma separated list of rules to disable
-      -t LIST, --target LIST               comma separated list of rules to target
-      -e PATTERN, --exclude PATTERN        regular expression of files or dirs to exclude from
-                                           checks
+      -h, --help                            show this help message and exit
+      -V, --version                         show program's version number and exit
+      -l, --list-checks                     display a list of all checks and their messages
+      -c, --check-class                     check class docstrings
+      -C, --check-class-constructor         check __init__ methods. Note: mutually incompatible
+                                            with -c
+      -D, --check-dunders                   check dunder methods
+      -m, --check-protected-class-methods   check public methods belonging to protected classes
+      -N, --check-nested                    check nested functions and classes
+      -o, --check-overridden                check overridden methods
+      -p, --check-protected                 check protected functions and classes
+      -P, --check-property-returns          check property return values
+      -i, --ignore-no-params                ignore docstrings where parameters are not
+                                            documented
+      -a, --ignore-args                     ignore args prefixed with an asterisk
+      -k, --ignore-kwargs                   ignore kwargs prefixed with two asterisks
+      -T, --ignore-typechecker              ignore checking return values
+      -I, --include-ignored                 check files even if they match a gitignore pattern
+      -n, --no-ansi                         disable ansi output
+      -v, --verbose                         increase output verbosity
+      -s STR, --string STR                  string to parse instead of files
+      -d LIST, --disable LIST               comma separated list of rules to disable
+      -t LIST, --target LIST                comma separated list of rules to target
+      -e PATTERN, --exclude PATTERN         regular expression of files or dirs to exclude from
+                                            checks
+      -E PATH [PATH ...], --excludes PATH [PATH ...]
+                                            path glob patterns to exclude from checks
 
 Options can also be configured with the pyproject.toml file
 
@@ -143,7 +145,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.59.3, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.60.1, 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 +234,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.59.3
+        rev: v0.60.1
         hooks:
           - id: docsig
             args:
@@ -251,7 +253,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.59.3
+              - docsig==0.60.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.59.3 → docsig-0.60.1}/docsig/_config.py

@@ -19,7 +19,7 @@ class Parser(_ArgumentParser):
         super().__init__(
             version=__version__,
             formatter_class=lambda prog: _HelpFormatter(
-                prog, max_help_position=45
+                prog, max_help_position=40
             ),
             description="Check signature params for proper documentation",
             version_short_form="-V",
@@ -157,6 +157,13 @@ class Parser(_ArgumentParser):
             metavar="PATTERN",
             help="regular expression of files or dirs to exclude from checks",
         )
+        self.add_argument(
+            "-E",
+            "--excludes",
+            nargs="+",
+            metavar="PATH",
+            help="path glob patterns to exclude from checks",
+        )
 
         # deprecated
         self.add_argument(

{docsig-0.59.3 → docsig-0.60.1}/docsig/_core.py

@@ -331,6 +331,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
     target: _Messages | None = None,
     disable: _Messages | None = None,
     exclude: str | None = None,
+    excludes: list[str] | None = None,
 ) -> int:
     """Package's core functionality.
 
@@ -367,20 +368,22 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
     :param disable: List of errors to disable.
     :param exclude: Regular expression of files and dirs to exclude from
         checks.
+    :param excludes: Files or dirs to exclude from checks.
     :return: Exit status for whether test failed or not.
     """
     if list_checks:
         return int(bool(_print_checks()))  # type: ignore
 
-    excludes = [_DEFAULT_EXCLUDES]
+    patterns = [_DEFAULT_EXCLUDES]
     if exclude is not None:
-        excludes.append(exclude)
+        patterns.append(exclude)
 
     if string is None:
         retcode = 0
         paths = _Paths(
             *tuple(_Path(i) for i in path),
-            excludes=excludes,
+            patterns=patterns,
+            excludes=excludes or [],
             include_ignored=include_ignored,
             verbose=verbose,
         )

{docsig-0.59.3 → docsig-0.60.1}/docsig/_files.py

@@ -12,6 +12,7 @@ from pathlib import Path as _Path
 
 from pathspec import PathSpec as _PathSpec
 from pathspec.patterns import GitWildMatchPattern as _GitWildMatchPattern
+from wcmatch.pathlib import Path as _WcPath
 
 from ._utils import vprint as _vprint
 
@@ -62,12 +63,18 @@ class _Gitignore(_PathSpec):
         super().__init__(map(_GitWildMatchPattern, patterns))
 
 
+def _glob(path: _Path, pattern: str) -> bool:
+    # pylint: disable=no-member
+    return _WcPath(str(path)).globmatch(pattern)  # type: ignore
+
+
 class Paths(_t.List[_Path]):  # pylint: disable=too-many-instance-attributes
     """Collect a list of valid paths.
 
     :param paths: Path(s) to parse ``Module``(s) from.
-    :param excludes: List pf regular expression of files and dirs to
+    :param patterns: List pf regular expression of files and dirs to
         exclude from checks.
+    :param excludes: Files or dirs to exclude from checks.
     :param include_ignored: Check files even if they match a gitignore
         pattern.
     :param verbose: increase output verbosity.
@@ -76,11 +83,13 @@ class Paths(_t.List[_Path]):  # pylint: disable=too-many-instance-attributes
     def __init__(  # pylint: disable=too-many-arguments
         self,
         *paths: _Path,
+        patterns: list[str],
         excludes: list[str],
         include_ignored: bool = False,
         verbose: bool = False,
     ) -> None:
         super().__init__()
+        self._patterns = patterns
         self._excludes = excludes
         self._include_ignored = include_ignored
         self._verbose = verbose
@@ -89,8 +98,9 @@ class Paths(_t.List[_Path]):  # pylint: disable=too-many-instance-attributes
             self._populate(path)
 
         for path in list(self):
-            if str(path) != "." and any(
-                _re.match(i, str(path)) for i in self._excludes
+            if str(path) != "." and (
+                any(_re.match(i, str(path)) for i in self._patterns)
+                or any(_glob(path, i) for i in self._excludes)
             ):
                 _vprint(
                     FILE_INFO.format(

{docsig-0.59.3 → docsig-0.60.1}/docsig/_main.py

@@ -44,4 +44,5 @@ def main() -> str | int:
         target=p.args.target,
         disable=p.args.disable,
         exclude=p.args.exclude,
+        excludes=p.args.excludes,
     )

{docsig-0.59.3 → docsig-0.60.1}/docsig/_stub.py

@@ -298,11 +298,14 @@ class Docstring(_Stub):
     def _indent_anomaly(string: str) -> bool:
         leading_spaces = []
         for line in string.splitlines():
-            match = _re.match(r"^\s*", line)
-            if match is not None:
-                spaces = len(match.group())
-                if spaces > 0:
-                    leading_spaces.append(spaces)
+            # only check params
+            # description or anything else is out of scope
+            if line.lstrip().startswith(":"):
+                match = _re.match(r"^\s*", line)
+                if match is not None:
+                    spaces = len(match.group())
+                    if spaces > 0:
+                        leading_spaces.append(spaces)
 
         # look for spaces in odd intervals
         return bool(any(i % 2 != 0 for i in leading_spaces))

{docsig-0.59.3 → docsig-0.60.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.59.3"
+__version__ = "0.60.1"

{docsig-0.59.3 → docsig-0.60.1}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.59.3"
+current_version = "0.60.1"
 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.3"
+version = "0.60.1"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
@@ -140,11 +140,12 @@ arcon = ">=0.4.0"
 astroid = "^3.0.1"
 pathspec = "^0.12.1"
 python = "^3.8.1"
+wcmatch = ">=8.5.2,<10.0.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
 bump-my-version = "^0.24.1"
-deptry = ">=0.16.1,<0.18.0"
+deptry = ">=0.16.1,<0.21.0"
 docformatter = "^1.7.5"
 flynt = "^1.0.1"
 gitpython = "^3.1.43"
@@ -160,7 +161,6 @@ 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"