docsig 0.89.0__tar.gz → 0.90.1__tar.gz

{docsig-0.89.0 → docsig-0.90.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.89.0
+Version: 0.90.1
 Summary: Check signature params for proper documentation
 License-Expression: MIT
 License-File: LICENSE
@@ -82,7 +82,7 @@ Description-Content-Type: text/x-rst
 .. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
    :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
    :alt: Build
-.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.0-007ACC
+.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
    :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
    :alt: VS Code Extension Version
 
@@ -206,7 +206,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.89.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.90.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
 
@@ -292,7 +292,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.89.0
+        rev: v0.90.1
         hooks:
           - id: docsig
             args:
@@ -311,7 +311,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.89.0
+              - docsig==0.90.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.89.0 → docsig-0.90.1}/README.rst

@@ -54,7 +54,7 @@
 .. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
    :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
    :alt: Build
-.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.0-007ACC
+.. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
    :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
    :alt: VS Code Extension Version
 
@@ -178,7 +178,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.89.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.90.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
 
@@ -264,7 +264,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.89.0
+        rev: v0.90.1
         hooks:
           - id: docsig
             args:
@@ -283,7 +283,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.89.0
+              - docsig==0.90.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.89.0 → docsig-0.90.1}/docsig/_check.py

@@ -47,9 +47,9 @@ def _run_check(
         parent,
         config,
     ):
-        failure = _check_function(child, config)
-        if failure:
-            failures.append(failure)
+        result = _check_function(child, config)
+        if result:
+            failures.append(result)
 
     # recurse for either class methods or, if enabled, nested functions
     if not isinstance(child, _Function) or config.check.nested:

{docsig-0.89.0 → docsig-0.90.1}/docsig/_config.py

@@ -173,17 +173,10 @@ def build_parser() -> _ArgumentParser:
         action="store_true",
         help="check property return values",
     )
-    parser.add_argument(
-        "-p",
-        action="store_true",
-        help=_argparse.SUPPRESS,
-        dest="check_protected",
-    )
     parser.add_argument(
         "--check-protected",
         action="store_true",
         help="check protected functions and classes",
-        dest="check_protected",
     )
     parser.add_argument(
         "--check-protected-class-methods",

{docsig-0.89.0 → docsig-0.90.1}/docsig/_directives.py

@@ -174,6 +174,14 @@ class Directives(dict[int, tuple[Comments, _Messages]]):
                         comments = scoped_comments
                         messages = scoped_messages
                     else:
+                        # keep disable on this line even if an earlier
+                        # token already recorded an empty entry (e.g.
+                        # a string arg before an inline comment)
+                        directives[lineno] = (
+                            Comments(scoped_comments),
+                            _Messages(scoped_messages),
+                        )
+
                         # defer scoped state for the next line without
                         # changing module-level messages
                         pending_inline = (

{docsig-0.89.0 → docsig-0.90.1}/docsig/_main.py

@@ -20,7 +20,6 @@ def _warn_on_deprecated_short_flags() -> None:
         "-c": "--check-class",
         "-D": "--check-dunders",
         "-o": "--check-overridden",
-        "-p": "--check-protected",
     }
     raw_args = _sys.argv[1:]
     expanded_flags = []

{docsig-0.89.0 → docsig-0.90.1}/docsig/_module.py

@@ -109,6 +109,22 @@ class Parent:  # pylint: disable=too-many-instance-attributes
                     subnode.lineno or 0,
                     (_Comments(), _Messages()),
                 )
+
+                # astroid sets lineno to the first decorator
+                # inline disable on the def line is at fromlineno
+                fromlineno = getattr(subnode, "fromlineno", 0)
+                if (
+                    isinstance(subnode, _ast.nodes.FunctionDef)
+                    and fromlineno
+                    and fromlineno != (subnode.lineno or 0)
+                ):
+                    more_comments, more_disabled = self._directives.get(
+                        fromlineno,
+                        (_Comments(), _Messages()),
+                    )
+                    comments.extend(more_comments)
+                    disabled.extend(more_disabled)
+
                 comments.extend(parent_comments)
                 disabled.extend(parent_disabled)
                 if isinstance(

{docsig-0.89.0 → docsig-0.90.1}/docsig/_report.py

@@ -13,6 +13,7 @@ import json as _json
 import os as _os
 import sys as _sys
 import typing as _t
+from dataclasses import dataclass as _dataclass
 from warnings import warn as _warn
 
 import astroid as _ast
@@ -71,7 +72,8 @@ class Failures(list["Failure"]):
     """Sequence of Failure instances (one per function checked)."""
 
 
-class Failed(_t.NamedTuple):
+@_dataclass(frozen=True, order=True)
+class Diagnostic:  # pylint: disable=too-few-public-methods
     """Single reported issue."""
 
     name: str
@@ -83,7 +85,7 @@ class Failed(_t.NamedTuple):
     new: bool = False
 
 
-class Failure(list[Failed]):
+class Failure(list[Diagnostic]):
     """Collect docstring and signature failures for one function.
 
     Runs configured checks and appends Failed entries for each
@@ -137,7 +139,7 @@ class Failure(list[Failed]):
         **kwargs: _t.Any,
     ) -> None:
         self._retcode.add(int(not value.new))
-        failed = Failed(
+        failed = Diagnostic(
             self._name,
             value.ref,
             value.description.format(**kwargs),
@@ -416,15 +418,15 @@ def report(
     retcodes = RetCode()
     output = []
     obj = []
-    for failure in failures:
-        retcodes.add(failure.retcode)
+    for result in failures:
+        retcodes.add(result.retcode)
         path_prefix = f"{file}:" if file is not None else ""
-        header = f"{path_prefix}{failure.lineno} in {failure.name}"
+        header = f"{path_prefix}{result.lineno} in {result.name}"
         if not config.no_ansi and _sys.stdout.isatty():
             header = f"\033[35m{header}\033[0m"
 
         output.append(header)
-        for item in failure:
+        for item in result:
             extra = None
             if item.hint:
                 extra = f"hint: {item.hint}"
@@ -444,9 +446,9 @@ def report(
 
             obj.append(
                 {
-                    "line": None if failure.retcode == 2 else item.lineno,
+                    "line": None if result.retcode == 2 else item.lineno,
                     "message": msg,
-                    "exit": failure.retcode,
+                    "exit": result.retcode,
                 },
             )
 

{docsig-0.89.0 → docsig-0.90.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.89.0"
+__version__ = "0.90.1"

{docsig-0.89.0 → docsig-0.90.1}/pyproject.toml

@@ -29,7 +29,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "0.89.0"
+version = "0.90.1"
 
 [project.entry-points."flake8.extension"]
 SIG = "docsig.plugin:Flake8"
@@ -47,7 +47,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.89.0"
+current_version = "0.90.1"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -102,6 +102,7 @@ omit = [
 
 [tool.deptry.per_rule_ignores]
 DEP004 = [
+  "docutils",
   "flake8",
   "git",
   "pytest",
@@ -147,25 +148,25 @@ deptry = ">=0.16.1,<0.26.0"
 flynt = "^1.0.1"
 gitpython = "^3.1.43"
 isort = ">=5.13.2,<9.0.0"
-mypy = ">=1.10,<3.0"
+mypy = ">=2.2.0,<3.0"
 pre-commit = ">=3.3.3,<5.0.0"
 pylint = "^4.0.6"
 tomli = "^2.0.1"
 tomli-w = "^1.0.0"
 towncrier = ">=23.11,<26.0"
-tox = "^4.56.1"
+tox = "^4.56.4"
 validate-pyproject = {extras = ["all", "store"], version = "^0.25"}
 vulture = "^2.11"
 
 [tool.poetry.group.docs.dependencies]
 Sphinx = ">=7,<8.2"
+docutils = ">=0.18,<0.22"
 furo = ">=2024.4.27,<2026.0.0"
 myst-parser = ">=3.0.1,<5.0.0"
 pytest = "9.1.1"
 pyyaml = "^6.0.1"
 roman-numerals = "4.1.0"
 sphinx-copybutton = "^0.5.2"
-sphinx-jsonschema = "^1.19.2"
 sphinx-markdown-builder = ">=0.5.5,<0.7.0"
 sphinx-sitemap = "^2.9.0"