docsig 0.85.2__tar.gz → 0.86.1__tar.gz

{docsig-0.85.2 → docsig-0.86.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.85.2
+Version: 0.86.1
 Summary: Check signature params for proper documentation
 License: MIT
 License-File: LICENSE
@@ -195,7 +195,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.85.2, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.86.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -212,9 +212,9 @@ avoid any potential conflicts with other plugins
 .. code-block:: ini
 
     [flake8]
-    sig-check-dunders = True
-    sig-check-overridden = True
-    sig-check-protected = True
+    sig-check-dunders = true
+    sig-check-overridden = true
+    sig-check-protected = true
 
 ..
    end flake8
@@ -281,7 +281,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.85.2
+        rev: v0.86.1
         hooks:
           - id: docsig
             args:
@@ -300,7 +300,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.85.2
+              - docsig==0.86.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.85.2 → docsig-0.86.1}/README.rst

@@ -166,7 +166,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.85.2, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.86.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -183,9 +183,9 @@ avoid any potential conflicts with other plugins
 .. code-block:: ini
 
     [flake8]
-    sig-check-dunders = True
-    sig-check-overridden = True
-    sig-check-protected = True
+    sig-check-dunders = true
+    sig-check-overridden = true
+    sig-check-protected = true
 
 ..
    end flake8
@@ -252,7 +252,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.85.2
+        rev: v0.86.1
         hooks:
           - id: docsig
             args:
@@ -271,7 +271,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.85.2
+              - docsig==0.86.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.85.2 → docsig-0.86.1}/docsig/_config.py

@@ -147,17 +147,10 @@ def build_parser() -> _ArgumentParser:
         help="check class docstrings",
         dest="check_class",
     )
-    group.add_argument(
-        "-C",
-        action="store_true",
-        help=_argparse.SUPPRESS,
-        dest="check_class_constructor",
-    )
     group.add_argument(
         "--check-class-constructor",
         action="store_true",
         help="check __init__ methods",
-        dest="check_class_constructor",
     )
     parser.add_argument(
         "-D",
@@ -343,6 +336,23 @@ class Ignore:
     kwargs: bool = False
 
 
+@_dataclass
+# pylint: disable-next=too-few-public-methods
+class Filters:
+    """Configuration for which paths to filter.
+
+    :param exclude: 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.
+    """
+
+    exclude: list[str] = _field(default_factory=list)
+    excludes: list[str] = _field(default_factory=list)
+    include_ignored: bool = False
+
+
 @_dataclass(frozen=True)
 # pylint: disable-next=too-many-instance-attributes,too-few-public-methods
 class Config:
@@ -354,11 +364,9 @@ class Config:
 
     check: Check = _field(default_factory=Check)
     ignore: Ignore = _field(default_factory=Ignore)
+    filters: Filters = _field(default_factory=Filters)
     target: _Messages = _field(default_factory=_Messages)
     disable: _Messages = _field(default_factory=_Messages)
-    exclude: list[str] = _field(default_factory=list)
-    excludes: list[str] = _field(default_factory=list)
     list_checks: bool = False
-    include_ignored: bool = False
     no_ansi: bool = False
     verbose: bool = False

{docsig-0.85.2 → docsig-0.86.1}/docsig/_core.py

@@ -15,6 +15,7 @@ from . import _decorators
 from ._check import run_checks as _run_checks
 from ._config import Check as _Check
 from ._config import Config as _Config
+from ._config import Filters as _Filters
 from ._config import Ignore as _Ignore
 from ._files import Files as _Files
 from ._parsers import parse_from_file as _parse_from_file
@@ -191,17 +192,20 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         args=ignore_args,
         kwargs=ignore_kwargs,
     )
+    filters = _Filters(
+        include_ignored=include_ignored,
+        exclude=exclude_,
+        excludes=excludes or [],
+    )
     config = _Config(
         list_checks=list_checks,
-        include_ignored=include_ignored,
         check=check,
         ignore=ignore,
+        filters=filters,
         no_ansi=no_ansi,
         verbose=verbose,
         target=target or _Messages(),
         disable=disable,
-        exclude=exclude_,
-        excludes=excludes or [],
     )
     setup_logger(config.verbose)
     logger = _logging.getLogger(__package__)
@@ -215,7 +219,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         return _report(failures, config)
 
     retcodes = [0]
-    files = _Files(path, config)
+    files = _Files(path, config.filters)
     for file in files:
         failures = runner(file, config)
         retcode = _report(failures, config, str(file))

{docsig-0.85.2 → docsig-0.86.1}/docsig/_decorators.py

@@ -11,7 +11,7 @@ from pathlib import Path as _Path
 from .messages import E as _E
 
 _FuncType = _t.Callable[..., int]
-_WrappedFuncType = _t.Callable[..., str | int]
+_WrappedFuncType = _t.Callable[..., int]
 
 
 def parse_msgs(func: _WrappedFuncType) -> _WrappedFuncType:
@@ -25,7 +25,7 @@ def parse_msgs(func: _WrappedFuncType) -> _WrappedFuncType:
     """
 
     @_functools.wraps(func)
-    def _wrapper(*args: str | _Path, **kwargs: _t.Any) -> str | int:
+    def _wrapper(*args: str | _Path, **kwargs: _t.Any) -> int:
         disable = _E.from_codes(kwargs.get("disable", [])) or None
         target = _E.from_codes(kwargs.get("target", [])) or None
         kwargs["disable"] = disable
@@ -50,7 +50,7 @@ def validate_args(func: _FuncType) -> _WrappedFuncType:
     """
 
     @_functools.wraps(func)
-    def _wrapper(*args: str | _Path, **kwargs: _t.Any) -> str | int:
+    def _wrapper(*args: str | _Path, **kwargs: _t.Any) -> int:
         stderr = []
         if not kwargs.get("list_checks", False):
             if not args and not kwargs.get("string"):
@@ -88,6 +88,10 @@ def validate_args(func: _FuncType) -> _WrappedFuncType:
                         "please check your pyproject.toml configuration",
                     )
 
-        return "\n".join(stderr) if stderr else func(*args, **kwargs)
+        if stderr:
+            print("\n".join(stderr), file=_sys.stderr)
+            return 2
+
+        return func(*args, **kwargs)
 
     return _wrapper

{docsig-0.85.2 → docsig-0.86.1}/docsig/_files.py

@@ -14,7 +14,7 @@ from pathspec import PathSpec as _PathSpec
 from pathspec.patterns import GitWildMatchPattern as _GitWildMatchPattern
 from wcmatch.pathlib import Path as _WcPath
 
-from ._config import Config as _Config
+from ._config import Filters as _Filters
 
 FILE_INFO = "%s: %s"
 
@@ -72,16 +72,16 @@ class Files(list[_Path]):
     """Collect paths to check (gitignore and exclude applied).
 
     :param paths: Path(s) to collect (files or directories).
-    :param config: Configuration object.
+    :param filters: Filters object.
     """
 
     def __init__(
         self,
         paths: tuple[str | _Path, ...],
-        config: _Config,
+        filters: _Filters,
     ) -> None:
         super().__init__()
-        self._include_ignored = config.include_ignored
+        self._include_ignored = filters.include_ignored
         self._gitignore = _Gitignore()
         logger = _logging.getLogger(__package__)
         for path in paths:
@@ -89,8 +89,8 @@ class Files(list[_Path]):
 
         for path in list(self):
             if str(path) != "." and (
-                any(_re.match(i, str(path)) for i in config.exclude)
-                or any(_glob(path, i) for i in config.excludes)
+                any(_re.match(i, str(path)) for i in filters.exclude)
+                or any(_glob(path, i) for i in filters.excludes)
             ):
                 logger.debug(FILE_INFO, path, "in exclude list, skipping")
                 self.remove(path)

{docsig-0.85.2 → docsig-0.86.1}/docsig/_main.py

@@ -16,7 +16,6 @@ from ._hooks import excepthook as _excepthook
 def _warn_on_deprecated_short_flags() -> None:
     deprecated_short_flags = {
         "-c": "--check-class",
-        "-C": "--check-class-constructor",
         "-D": "--check-dunders",
         "-o": "--check-overridden",
         "-p": "--check-protected",

{docsig-0.85.2 → docsig-0.86.1}/docsig/_report.py

@@ -61,7 +61,7 @@ class Failure(list[Failed]):
 
     def __init__(self, func: _Function, config: _Config) -> None:
         super().__init__()
-        self._retcode = 0
+        self._retcode = [0]
         self._func = func
         if config.target:
             self._func.messages.extend(
@@ -77,6 +77,7 @@ class Failure(list[Failed]):
             self._name = f"{self._func.parent.name}.{self._name}"
 
         if self._func.error is not None:
+            self._retcode.append(2)
             self._sig9xx_error()
         else:
             self._sig0xx_config()
@@ -100,7 +101,7 @@ class Failure(list[Failed]):
         hint: bool = False,
         **kwargs: _t.Any,
     ) -> None:
-        self._retcode = int(not value.new)
+        self._retcode.append(int(not value.new))
         failed = Failed(
             self._name,
             value.ref,
@@ -321,7 +322,7 @@ class Failure(list[Failed]):
         # invalid-syntax
         if self._func.error is _ast.AstroidSyntaxError:
             self._add(_E[901])
-            self._retcode = 123
+            self._retcode.append(123)
         # unicode-decode-error
         if self._func.error is UnicodeDecodeError:
             self._add(_E[902])
@@ -345,7 +346,7 @@ class Failure(list[Failed]):
     @property
     def retcode(self) -> int:
         """Exit code (non-zero if any check failed)."""
-        return self._retcode
+        return max(self._retcode)
 
 
 def report(
@@ -364,6 +365,7 @@ def report(
     :return: Exit code (non-zero if any check failed).
     """
     retcodes = [0]
+    output = []
     for failure in failures:
         retcodes.append(failure.retcode)
         path_prefix = f"{file}:" if file is not None else ""
@@ -371,7 +373,7 @@ def report(
         if not config.no_ansi and _sys.stdout.isatty():
             header = f"\033[35m{header}\033[0m"
 
-        print(header)
+        output.append(header)
         for item in failure:
             extra = None
             if item.hint:
@@ -381,15 +383,16 @@ def report(
                 extra = "warning: please remember to fix this or disable it"
                 _warn(_NEW.format(ref=item.ref), FutureWarning, stacklevel=3)
 
-            print(
-                "    "
-                + _TEMPLATE.format(
-                    ref=item.ref,
-                    description=item.description,
-                    symbolic=item.symbolic,
-                ),
+            msg = _TEMPLATE.format(
+                ref=item.ref,
+                description=item.description,
+                symbolic=item.symbolic,
             )
+            output.append(f"    {msg}")
             if extra is not None:
-                print(f"    {extra}")
+                output.append(f"    {extra}")
+
+    if output:
+        print("\n".join(output))
 
     return max(retcodes)

{docsig-0.85.2 → docsig-0.86.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.85.2"
+__version__ = "0.86.1"

{docsig-0.85.2 → docsig-0.86.1}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.85.2"
+current_version = "0.86.1"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -27,11 +27,6 @@ filename = "pyproject.toml"
 replace = 'version = "{new_version}"'
 search = 'version = "{current_version}"'
 
-[[tool.bumpversion.files]]
-filename = "package.json"
-replace = '"version": "{new_version}"'
-search = '"version": "{current_version}"'
-
 [[tool.bumpversion.files]]
 filename = "README.rst"
 replace = "rev: v{new_version}"
@@ -122,7 +117,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.85.2"
+version = "0.86.1"
 
 [tool.poetry.dependencies]
 Sphinx = ">=7,<9"