docsig 0.45.0__tar.gz → 0.46.0__tar.gz

{docsig-0.45.0 → docsig-0.46.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.45.0
+Version: 0.46.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: Pygments (>=2.13.0,<3.0.0)
 Requires-Dist: Sphinx (>=7.0.0,<8.0.0)
-Requires-Dist: arcon (>=0.3.1)
+Requires-Dist: arcon (>=0.4.0)
 Requires-Dist: astroid (>=3.0.1,<4.0.0)
 Requires-Dist: object-colors (>=2.1.0,<3.0.0)
 Requires-Dist: typing-extensions (>=4.8.0,<5.0.0)
@@ -106,8 +106,8 @@ Commandline
 
 .. code-block:: console
 
-    usage: docsig [-h] [-v] [-l] [-c | -C] [-D] [-m] [-o] [-p] [-P] [-i] [-a] [-k]
-                             [-n] [-S] [-s STR] [-d LIST] [-t LIST] [-e EXCLUDE]
+    usage: docsig [-h] [-V] [-l] [-c | -C] [-D] [-m] [-o] [-p] [-P] [-i] [-a] [-k]
+                             [-n] [-S] [-v] [-s STR] [-d LIST] [-t LIST] [-e EXCLUDE]
                              [path [path ...]]
 
     Check signature params for proper documentation
@@ -117,7 +117,7 @@ Commandline
 
     optional arguments:
       -h, --help                           show this help message and exit
-      -v, --version                        show program's version number 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
@@ -134,6 +134,7 @@ Commandline
       -k, --ignore-kwargs                  ignore kwargs prefixed with two asterisks
       -n, --no-ansi                        disable ansi output
       -S, --summary                        print a summarised report
+      -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
@@ -231,7 +232,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.45.0
+        rev: v0.46.0
         hooks:
           - id: docsig
             args:

{docsig-0.45.0 → docsig-0.46.0}/README.rst

@@ -77,8 +77,8 @@ Commandline
 
 .. code-block:: console
 
-    usage: docsig [-h] [-v] [-l] [-c | -C] [-D] [-m] [-o] [-p] [-P] [-i] [-a] [-k]
-                             [-n] [-S] [-s STR] [-d LIST] [-t LIST] [-e EXCLUDE]
+    usage: docsig [-h] [-V] [-l] [-c | -C] [-D] [-m] [-o] [-p] [-P] [-i] [-a] [-k]
+                             [-n] [-S] [-v] [-s STR] [-d LIST] [-t LIST] [-e EXCLUDE]
                              [path [path ...]]
 
     Check signature params for proper documentation
@@ -88,7 +88,7 @@ Commandline
 
     optional arguments:
       -h, --help                           show this help message and exit
-      -v, --version                        show program's version number 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
@@ -105,6 +105,7 @@ Commandline
       -k, --ignore-kwargs                  ignore kwargs prefixed with two asterisks
       -n, --no-ansi                        disable ansi output
       -S, --summary                        print a summarised report
+      -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
@@ -202,7 +203,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.45.0
+        rev: v0.46.0
         hooks:
           - id: docsig
             args:

{docsig-0.45.0 → docsig-0.46.0}/docsig/_config.py

@@ -23,6 +23,7 @@ class Parser(_ArgumentParser):
                 prog, max_help_position=45
             ),
             description="Check signature params for proper documentation",
+            version_short_form="-V",
         )
         self._add_arguments()
         self.args = self.parse_args()
@@ -114,6 +115,12 @@ class Parser(_ArgumentParser):
             action="store_true",
             help="print a summarised report",
         )
+        self.add_argument(
+            "-v",
+            "--verbose",
+            action="store_true",
+            help="increase output verbosity",
+        )
         self.add_argument(
             "-s",
             "--string",

{docsig-0.45.0 → docsig-0.46.0}/docsig/_core.py

@@ -99,6 +99,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
     ignore_kwargs: bool = False,
     no_ansi: bool = False,
     summary: bool = False,
+    verbose: bool = False,
     targets: list[_Message] | None = None,
     disable: list[_Message] | None = None,
     exclude: str | None = None,
@@ -130,6 +131,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
     :param ignore_kwargs: Ignore kwargs prefixed with two asterisks.
     :param no_ansi: Disable ANSI output.
     :param summary: Print a summarised report.
+    :param verbose: increase output verbosity.
     :param targets: List of errors to target.
     :param disable: List of errors to disable.
     :param exclude: Regular expression of files and dirs to exclude from
@@ -151,6 +153,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         ignore_args=ignore_args,
         ignore_kwargs=ignore_kwargs,
         check_class_constructor=check_class_constructor,
+        verbose=verbose,
     )
     display = _Display(no_ansi)
     for module in modules:

{docsig-0.45.0 → docsig-0.46.0}/docsig/_main.py

@@ -39,6 +39,7 @@ def main() -> str | int:
         ignore_kwargs=parser.args.ignore_kwargs,
         no_ansi=parser.args.no_ansi,
         summary=parser.args.summary,
+        verbose=parser.args.verbose,
         targets=parser.args.target,
         disable=parser.args.disable,
         exclude=parser.args.exclude,

{docsig-0.45.0 → docsig-0.46.0}/docsig/_module.py

@@ -16,6 +16,9 @@ from ._directives import Directives as _Directives
 from ._function import Function as _Function
 from ._message import Message as _Message
 from ._utils import isprotected as _isprotected
+from ._utils import vprint as _vprint
+
+_FILE_INFO = "{path}: {msg}"
 
 
 class Parent(_t.List[_Function]):
@@ -138,6 +141,7 @@ class Modules(_t.List[_Module]):
     :param check_class_constructor: Check the class constructor's
         docstring. Otherwise, expect the constructor's documentation to
         be on the class level docstring.
+    :param verbose: increase output verbosity.
     """
 
     # handle errors here before appending a module
@@ -178,6 +182,13 @@ class Modules(_t.List[_Module]):
                 # their suffix, will continue to fail
                 raise err
 
+            _vprint(
+                _FILE_INFO.format(
+                    path=root or "stdin", msg=str(err).replace("\n", " ")
+                ),
+                self._verbose,
+            )
+
     def __init__(  # pylint: disable=too-many-arguments
         self,
         *paths: _Path,
@@ -187,6 +198,7 @@ class Modules(_t.List[_Module]):
         ignore_args: bool = False,
         ignore_kwargs: bool = False,
         check_class_constructor: bool = False,
+        verbose: bool = False,
     ) -> None:
         super().__init__()
         self._disable = disable
@@ -194,6 +206,7 @@ class Modules(_t.List[_Module]):
         self._ignore_args = ignore_args
         self._ignore_kwargs = ignore_kwargs
         self.check_class_constructor = check_class_constructor
+        self._verbose = verbose
         if string is not None:
             self._add_module(
                 disable,
@@ -213,6 +226,10 @@ class Modules(_t.List[_Module]):
         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 root.is_file():

{docsig-0.45.0 → docsig-0.46.0}/docsig/_utils.py

@@ -28,3 +28,13 @@ def almost_equal(str1: str, str2: str, mini: float, maxi: float) -> bool:
     :return: Boolean result for whether both strings are almost equal.
     """
     return mini < _SequenceMatcher(a=str1, b=str2).ratio() < maxi
+
+
+def vprint(msg: str, verbose: bool = False) -> None:
+    """Print messages only if verbose is true.
+
+    :param msg: Message to print.
+    :param verbose: Whether verbose mode is enabled.
+    """
+    if verbose:
+        print(msg)

{docsig-0.45.0 → docsig-0.46.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.45.0"
+__version__ = "0.46.0"

{docsig-0.45.0 → docsig-0.46.0}/pyproject.toml

@@ -72,12 +72,12 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.45.0"
+version = "0.46.0"
 
 [tool.poetry.dependencies]
 Pygments = "^2.13.0"
 Sphinx = "^7.0.0"
-arcon = ">=0.3.1"
+arcon = ">=0.4.0"
 astroid = "^3.0.1"
 object-colors = "^2.1.0"
 python = "^3.8"