docsig 0.60.0__tar.gz → 0.61.0__tar.gz

{docsig-0.60.0 → docsig-0.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.60.0
+Version: 0.61.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -17,10 +17,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 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,<9.0.0)
+Requires-Dist: tomli (>=2.0.1,<3.0.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
@@ -113,36 +113,44 @@ Commandline
     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
+                            path glob patterns to exclude from checks
 
 Options can also be configured with the pyproject.toml file
 
@@ -172,7 +180,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.60.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.61.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
 
@@ -261,7 +269,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.60.0
+        rev: v0.61.0
         hooks:
           - id: docsig
             args:
@@ -280,7 +288,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.60.0
+              - docsig==0.61.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.60.0 → docsig-0.61.0}/README.rst

@@ -86,36 +86,44 @@ Commandline
     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
+                            path glob patterns to exclude from checks
 
 Options can also be configured with the pyproject.toml file
 
@@ -145,7 +153,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.60.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.61.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
 
@@ -234,7 +242,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.60.0
+        rev: v0.61.0
         hooks:
           - id: docsig
             args:
@@ -253,7 +261,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.60.0
+              - docsig==0.61.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

docsig-0.61.0/docsig/_config.py

@@ -0,0 +1,266 @@
+"""
+docsig._config
+==============
+"""
+
+from __future__ import annotations as _
+
+import argparse as _a
+import os as _os
+import re as _re
+import typing as _t
+from pathlib import Path as _Path
+
+import tomli as _tomli
+
+from ._version import __version__
+
+PYPROJECT_TOML = "pyproject.toml"
+
+
+# split str by comma, but allow for escaping
+def _split_comma(value: str) -> list[str]:
+    return [i.replace("\\,", ",") for i in _re.split(r"(?<!\\),", value)]
+
+
+# attempt to locate a pyproject.toml file if one exists in parents
+def _find_pyproject_toml(path: _Path | None = None) -> _Path | None:
+    if not path:
+        path = _Path.cwd()
+
+    pyproject_toml = path / PYPROJECT_TOML
+    if pyproject_toml.is_file():
+        return pyproject_toml
+
+    if str(path) == _os.path.abspath(_os.sep):
+        return None
+
+    return _find_pyproject_toml(path.parent)
+
+
+def get_config(prog: str) -> dict[str, _t.Any]:
+    """Get config dict object from package's tool section in toml file.
+
+    :param prog: Program name.
+    :return: Config dict.
+    """
+    pyproject_file = _find_pyproject_toml()
+    if pyproject_file is None:
+        return {}
+
+    return {
+        k.replace("-", "_"): v
+        for k, v in _tomli.loads(pyproject_file.read_text())
+        .get("tool", {})
+        .get(prog, {})
+        .items()
+    }
+
+
+def merge_configs(
+    obj1: dict[str, _t.Any], obj2: dict[str, _t.Any]
+) -> dict[str, _t.Any]:
+    """Merge two config dicts.
+
+    :param obj1: Config dict one.
+    :param obj2: Config dict two.
+    :return: Config dict.
+    """
+    for key, n_val in obj1.items():
+        c_val = obj2.get(key)
+        if isinstance(c_val, list) and isinstance(n_val, list):
+            obj1[key].extend(c_val)
+        elif c_val:
+            obj1[key] = c_val
+
+    return obj1
+
+
+class _ArgumentParser(_a.ArgumentParser):
+    def parse_known_args(  # type: ignore
+        self,
+        args: _t.Sequence[str] | None = None,
+        namespace: _a.Namespace | None = None,
+    ) -> tuple[_a.Namespace | None, list[str]]:
+        namespace, args = super().parse_known_args(args, namespace)
+        config = get_config(self.prog)
+        namespace.__dict__ = merge_configs(namespace.__dict__, config)
+        return namespace, args
+
+    def add_list_argument(self, *args: str, **kwargs: _t.Any) -> None:
+        """Parse a comma separated list of strings into a list.
+
+        :param args: Long and/or short form argument(s).
+        :param kwargs: Kwargs to pass to ``add_argument``.
+        """
+        kwargs.update(
+            {
+                "action": "store",
+                "type": _split_comma,
+                "default": kwargs.get("default", []),
+            }
+        )
+        self.add_argument(*args, **kwargs)
+
+
+def parse_args(args: _t.Sequence[str] | None = None) -> _a.Namespace:
+    """Parse commandline arguments.
+
+    :param args: Args for manual parsing.
+    :return: Parsed arguments.
+    """
+    parser = _ArgumentParser(
+        description="Check signature params for proper documentation",
+    )
+    parser.add_argument(
+        "-V",
+        "--version",
+        action="version",
+        version=__version__,
+    )
+    parser.add_argument(
+        "path",
+        nargs="*",
+        action="store",
+        type=_Path,
+        help="directories or files to check",
+    )
+    parser.add_argument(
+        "-l",
+        "--list-checks",
+        action="store_true",
+        help="display a list of all checks and their messages",
+    )
+    group = parser.add_mutually_exclusive_group(required=False)
+    group.add_argument(
+        "-c",
+        "--check-class",
+        action="store_true",
+        help="check class docstrings",
+    )
+    group.add_argument(
+        "-C",
+        "--check-class-constructor",
+        action="store_true",
+        help="check __init__ methods. Note: mutually incompatible with -c",
+    )
+    parser.add_argument(
+        "-D",
+        "--check-dunders",
+        action="store_true",
+        help="check dunder methods",
+    )
+    parser.add_argument(
+        "-m",
+        "--check-protected-class-methods",
+        action="store_true",
+        help="check public methods belonging to protected classes",
+    )
+    parser.add_argument(
+        "-N",
+        "--check-nested",
+        action="store_true",
+        help="check nested functions and classes",
+    )
+    parser.add_argument(
+        "-o",
+        "--check-overridden",
+        action="store_true",
+        help="check overridden methods",
+    )
+    parser.add_argument(
+        "-p",
+        "--check-protected",
+        action="store_true",
+        help="check protected functions and classes",
+    )
+    parser.add_argument(
+        "-P",
+        "--check-property-returns",
+        action="store_true",
+        help="check property return values",
+    )
+    parser.add_argument(
+        "-i",
+        "--ignore-no-params",
+        action="store_true",
+        help="ignore docstrings where parameters are not documented",
+    )
+    parser.add_argument(
+        "-a",
+        "--ignore-args",
+        action="store_true",
+        help="ignore args prefixed with an asterisk",
+    )
+    parser.add_argument(
+        "-k",
+        "--ignore-kwargs",
+        action="store_true",
+        help="ignore kwargs prefixed with two asterisks",
+    )
+    parser.add_argument(
+        "-T",
+        "--ignore-typechecker",
+        action="store_true",
+        help="ignore checking return values",
+    )
+    parser.add_argument(
+        "-I",
+        "--include-ignored",
+        action="store_true",
+        help="check files even if they match a gitignore pattern",
+    )
+    parser.add_argument(
+        "-n",
+        "--no-ansi",
+        action="store_true",
+        help="disable ansi output",
+    )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="increase output verbosity",
+    )
+    parser.add_argument(
+        "-s",
+        "--string",
+        action="store",
+        metavar="STR",
+        help="string to parse instead of files",
+    )
+    parser.add_list_argument(
+        "-d",
+        "--disable",
+        metavar="LIST",
+        help="comma separated list of rules to disable",
+    )
+    parser.add_list_argument(
+        "-t",
+        "--target",
+        metavar="LIST",
+        help="comma separated list of rules to target",
+    )
+    parser.add_argument(
+        "-e",
+        "--exclude",
+        metavar="PATTERN",
+        help="regular expression of files or dirs to exclude from checks",
+    )
+    parser.add_argument(
+        "-E",
+        "--excludes",
+        nargs="+",
+        metavar="PATH",
+        help="path glob patterns to exclude from checks",
+    )
+
+    # deprecated
+    parser.add_argument(
+        "-S",
+        "--summary",
+        action="store_true",
+        help=_a.SUPPRESS,
+    )
+
+    return parser.parse_args(args)

{docsig-0.60.0 → docsig-0.61.0}/docsig/_directives.py

@@ -1,6 +1,6 @@
 """
-docsig._disable
-===============
+docsig._directives
+==================
 """
 
 from __future__ import annotations as _

docsig-0.61.0/docsig/_main.py

@@ -0,0 +1,48 @@
+"""
+docsig._main
+============
+
+Contains package entry point.
+"""
+
+from __future__ import annotations as _
+
+from ._config import parse_args as _parse_args
+from ._core import docsig as _docsig
+from ._hooks import excepthook as _excepthook
+
+
+def main() -> str | int:
+    """Main function for package.
+
+    Collect config and arguments for the commandline.
+
+    :return: Exit status for whether test failed or not.
+    """
+    a = _parse_args()
+    _excepthook(a.no_ansi)
+    return _docsig(
+        *a.path,
+        string=a.string,
+        list_checks=a.list_checks,
+        check_class=a.check_class,
+        check_class_constructor=a.check_class_constructor,
+        check_dunders=a.check_dunders,
+        check_protected_class_methods=a.check_protected_class_methods,
+        check_nested=a.check_nested,
+        check_overridden=a.check_overridden,
+        check_protected=a.check_protected,
+        check_property_returns=a.check_property_returns,
+        include_ignored=a.include_ignored,
+        ignore_no_params=a.ignore_no_params,
+        ignore_args=a.ignore_args,
+        ignore_kwargs=a.ignore_kwargs,
+        ignore_typechecker=a.ignore_typechecker,
+        no_ansi=a.no_ansi,
+        summary=a.summary,  # deprecated
+        verbose=a.verbose,
+        target=a.target,
+        disable=a.disable,
+        exclude=a.exclude,
+        excludes=a.excludes,
+    )

{docsig-0.60.0 → docsig-0.61.0}/docsig/_stub.py

@@ -1,6 +1,6 @@
 """
-docsig._function
-================
+docsig._stub
+============
 """
 
 from __future__ import annotations as _
@@ -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.60.0 → docsig-0.61.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.60.0"
+__version__ = "0.61.0"

{docsig-0.60.0 → docsig-0.61.0}/docsig/plugin.py

@@ -1,11 +1,11 @@
 """Flake8 implementation of docsig."""
 
 import ast
-import sys
 import typing as t
 from argparse import Namespace
 
-from ._config import Parser
+from ._config import get_config as _get_config
+from ._config import merge_configs as _merge_configs
 from ._core import runner
 from ._version import __version__
 from .messages import FLAKE8
@@ -24,7 +24,7 @@ class Docsig:
     off_by_default = False
     name = __package__
     version = __version__
-    options_dict: t.Dict[str, bool] = {}
+    a = Namespace()
 
     def __init__(self, tree: ast.Module, filename: str) -> None:
         _tree = tree  # noqa
@@ -36,7 +36,7 @@ class Docsig:
     # requirement for this package
     @classmethod
     def add_options(cls, parser) -> None:
-        """Add flake8 commandline and config options.sig_
+        """Add flake8 commandline and config options.
 
         :param parser: Flake8 option manager.
         """
@@ -112,62 +112,46 @@ class Docsig:
             parse_from_config=True,
             help="ignore checking return values",
         )
+        parser.add_option(
+            "--sig-verbose",
+            action="store_true",
+            parse_from_config=True,
+            help="increase output verbosity",
+        )
 
     @classmethod
-    def parse_options(cls, options: Namespace) -> None:
+    def parse_options(cls, a: Namespace) -> None:
         """Parse flake8 options into am instance accessible dict.
 
-        :param options: Argparse namespace.
+        :param a: Argparse namespace.
         """
-        cls.options_dict = {
-            "check_class": options.sig_check_class,
-            "check_class_constructor": options.sig_check_class_constructor,
-            "check_dunders": options.sig_check_dunders,
-            "check_protected_class_methods": (
-                options.sig_check_protected_class_methods
-            ),
-            "check_nested": options.sig_check_nested,
-            "check_overridden": options.sig_check_overridden,
-            "check_protected": options.sig_check_protected,
-            "check_property_returns": options.sig_check_property_returns,
-            "ignore_no_params": options.sig_ignore_no_params,
-            "ignore_args": options.sig_ignore_args,
-            "ignore_kwargs": options.sig_ignore_kwargs,
-            "ignore_typechecker": options.sig_ignore_typechecker,
-        }
+        cls.a.__dict__ = _merge_configs(
+            {k.replace("sig_", ""): v for k, v in a.__dict__.items()},
+            _get_config(__package__),
+        )
 
     def run(self) -> t.Generator[Flake8Error, None, None]:
         """Run docsig and possibly yield a flake8 error.
 
         :return: Flake8 error, if there is one.
         """
-        sys.argv = [
-            __package__,
-            self.filename,
-            *[
-                f"--{k.replace('_', '-')}"
-                for k, v in self.options_dict.items()
-                if v
-            ],
-        ]
-        p = Parser()
         results = runner(
             self.filename,
-            check_class=p.args.check_class,
-            check_class_constructor=p.args.check_class_constructor,
-            check_dunders=p.args.check_dunders,
+            check_class=self.a.check_class,
+            check_class_constructor=self.a.check_class_constructor,
+            check_dunders=self.a.check_dunders,
             check_protected_class_methods=(
-                p.args.check_protected_class_methods
+                self.a.check_protected_class_methods
             ),
-            check_nested=p.args.check_nested,
-            check_overridden=p.args.check_overridden,
-            check_protected=p.args.check_protected,
-            check_property_returns=p.args.check_property_returns,
-            ignore_no_params=p.args.ignore_no_params,
-            ignore_args=p.args.ignore_args,
-            ignore_kwargs=p.args.ignore_kwargs,
-            ignore_typechecker=p.args.ignore_typechecker,
-            no_ansi=p.args.no_ansi,
+            check_nested=self.a.check_nested,
+            check_overridden=self.a.check_overridden,
+            check_protected=self.a.check_protected,
+            check_property_returns=self.a.check_property_returns,
+            ignore_no_params=self.a.ignore_no_params,
+            ignore_args=self.a.ignore_args,
+            ignore_kwargs=self.a.ignore_kwargs,
+            ignore_typechecker=self.a.ignore_typechecker,
+            verbose=self.a.verbose,
         )[0]
         for result in results:
             for info in result:

{docsig-0.60.0 → docsig-0.61.0}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.60.0"
+current_version = "0.61.0"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -77,7 +77,6 @@ DEP004 = [
   "flake8",
   "git",
   "pytest",
-  "tomli",
   "tomli_w",
   "yaml"
 ]
@@ -132,20 +131,20 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.60.0"
+version = "0.61.0"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
-arcon = ">=0.4.0"
 astroid = "^3.0.1"
 pathspec = "^0.12.1"
 python = "^3.8.1"
-wcmatch = "^8.5.2"
+tomli = "^2.0.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"
+bump-my-version = ">=0.24.1,<0.27.0"
+deptry = ">=0.16.1,<0.21.0"
 docformatter = "^1.7.5"
 flynt = "^1.0.1"
 gitpython = "^3.1.43"

docsig-0.60.0/docsig/_config.py

@@ -1,174 +0,0 @@
-"""
-docsig._config
-==============
-"""
-
-from argparse import SUPPRESS as _SUPPRESS
-from argparse import HelpFormatter as _HelpFormatter
-from pathlib import Path as _Path
-
-from arcon import ArgumentParser as _ArgumentParser
-
-from ._version import __version__
-
-
-class Parser(_ArgumentParser):
-    """Parse commandline arguments."""
-
-    def __init__(self) -> None:
-        super().__init__(
-            version=__version__,
-            formatter_class=lambda prog: _HelpFormatter(
-                prog, max_help_position=40
-            ),
-            description="Check signature params for proper documentation",
-            version_short_form="-V",
-        )
-        self._add_arguments()
-        self.args = self.parse_args()
-
-    def _add_arguments(self) -> None:
-        self.add_argument(
-            "path",
-            nargs="*",
-            action="store",
-            type=_Path,
-            help="directories or files to check",
-        )
-        self.add_argument(
-            "-l",
-            "--list-checks",
-            action="store_true",
-            help="display a list of all checks and their messages",
-        )
-        group = self.add_mutually_exclusive_group(required=False)
-        group.add_argument(
-            "-c",
-            "--check-class",
-            action="store_true",
-            help="check class docstrings",
-        )
-        group.add_argument(
-            "-C",
-            "--check-class-constructor",
-            action="store_true",
-            help="check __init__ methods. Note: mutually incompatible with -c",
-        )
-        self.add_argument(
-            "-D",
-            "--check-dunders",
-            action="store_true",
-            help="check dunder methods",
-        )
-        self.add_argument(
-            "-m",
-            "--check-protected-class-methods",
-            action="store_true",
-            help="check public methods belonging to protected classes",
-        )
-        self.add_argument(
-            "-N",
-            "--check-nested",
-            action="store_true",
-            help="check nested functions and classes",
-        )
-        self.add_argument(
-            "-o",
-            "--check-overridden",
-            action="store_true",
-            help="check overridden methods",
-        )
-        self.add_argument(
-            "-p",
-            "--check-protected",
-            action="store_true",
-            help="check protected functions and classes",
-        )
-        self.add_argument(
-            "-P",
-            "--check-property-returns",
-            action="store_true",
-            help="check property return values",
-        )
-        self.add_argument(
-            "-i",
-            "--ignore-no-params",
-            action="store_true",
-            help="ignore docstrings where parameters are not documented",
-        )
-        self.add_argument(
-            "-a",
-            "--ignore-args",
-            action="store_true",
-            help="ignore args prefixed with an asterisk",
-        )
-        self.add_argument(
-            "-k",
-            "--ignore-kwargs",
-            action="store_true",
-            help="ignore kwargs prefixed with two asterisks",
-        )
-        self.add_argument(
-            "-T",
-            "--ignore-typechecker",
-            action="store_true",
-            help="ignore checking return values",
-        )
-        self.add_argument(
-            "-I",
-            "--include-ignored",
-            action="store_true",
-            help="check files even if they match a gitignore pattern",
-        )
-        self.add_argument(
-            "-n",
-            "--no-ansi",
-            action="store_true",
-            help="disable ansi output",
-        )
-        self.add_argument(
-            "-v",
-            "--verbose",
-            action="store_true",
-            help="increase output verbosity",
-        )
-        self.add_argument(
-            "-s",
-            "--string",
-            action="store",
-            metavar="STR",
-            help="string to parse instead of files",
-        )
-        self.add_list_argument(
-            "-d",
-            "--disable",
-            metavar="LIST",
-            help="comma separated list of rules to disable",
-        )
-        self.add_list_argument(
-            "-t",
-            "--target",
-            metavar="LIST",
-            help="comma separated list of rules to target",
-        )
-        self.add_argument(
-            "-e",
-            "--exclude",
-            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(
-            "-S",
-            "--summary",
-            action="store_true",
-            help=_SUPPRESS,
-        )

docsig-0.60.0/docsig/_main.py

@@ -1,48 +0,0 @@
-"""
-docsig._main
-============
-
-Contains package entry point.
-"""
-
-from __future__ import annotations as _
-
-from ._config import Parser as _Parser
-from ._core import docsig as _docsig
-from ._hooks import excepthook as _excepthook
-
-
-def main() -> str | int:
-    """Main function for package.
-
-    Collect config and arguments for the commandline.
-
-    :return: Exit status for whether test failed or not.
-    """
-    p = _Parser()
-    _excepthook(p.args.no_ansi)
-    return _docsig(
-        *p.args.path,
-        string=p.args.string,
-        list_checks=p.args.list_checks,
-        check_class=p.args.check_class,
-        check_class_constructor=p.args.check_class_constructor,
-        check_dunders=p.args.check_dunders,
-        check_protected_class_methods=p.args.check_protected_class_methods,
-        check_nested=p.args.check_nested,
-        check_overridden=p.args.check_overridden,
-        check_protected=p.args.check_protected,
-        check_property_returns=p.args.check_property_returns,
-        include_ignored=p.args.include_ignored,
-        ignore_no_params=p.args.ignore_no_params,
-        ignore_args=p.args.ignore_args,
-        ignore_kwargs=p.args.ignore_kwargs,
-        ignore_typechecker=p.args.ignore_typechecker,
-        no_ansi=p.args.no_ansi,
-        summary=p.args.summary,  # deprecated
-        verbose=p.args.verbose,
-        target=p.args.target,
-        disable=p.args.disable,
-        exclude=p.args.exclude,
-        excludes=p.args.excludes,
-    )