docsig 0.90.0__tar.gz → 0.90.2__tar.gz

{docsig-0.90.0 → docsig-0.90.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.90.0
+Version: 0.90.2
 Summary: Check signature params for proper documentation
 License-Expression: MIT
 License-File: LICENSE
@@ -206,7 +206,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.90.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.2, 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.90.0
+        rev: v0.90.2
         hooks:
           - id: docsig
             args:
@@ -311,7 +311,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.90.0
+              - docsig==0.90.2
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.90.0 → docsig-0.90.2}/README.rst

@@ -178,7 +178,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.90.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.2, 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.90.0
+        rev: v0.90.2
         hooks:
           - id: docsig
             args:
@@ -283,7 +283,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.90.0
+              - docsig==0.90.2
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.90.0 → docsig-0.90.2}/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.90.0 → docsig-0.90.2}/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.90.0 → docsig-0.90.2}/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.90.0 → docsig-0.90.2}/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.90.0 → docsig-0.90.2}/docsig/_stub.py

@@ -7,8 +7,8 @@ Stub types for parsed docstrings and signatures.
 
 from __future__ import annotations as _
 
+import inspect as _inspect
 import re as _re
-import textwrap as _textwrap
 import typing as _t
 from collections import Counter as _Counter
 from enum import Enum as _Enum
@@ -325,21 +325,44 @@ class Docstring(_Stub):
 
         return False
 
+    @staticmethod
+    def _docstring_style(string: str) -> str:
+        # prefer existing rst fields over napoleon section headers
+        if _re.search(r"^:\w+", string, _re.MULTILINE):
+            return "rst"
+
+        if _re.search(
+            r"^(Parameters|Other Parameters|Returns|Yields|Raises|"
+            r"See Also|Notes|Examples|Attributes|Methods)\n"
+            r"\s*-{3,}\s*$",
+            string,
+            _re.MULTILINE,
+        ):
+            return "numpy"
+
+        if _re.search(
+            r"^(Args|Arguments|Parameters|Returns|Yields|Raises|"
+            r"Attributes|Example|Examples):\s*$",
+            string,
+            _re.MULTILINE,
+        ):
+            return "google"
+
+        return "rst"
+
     @staticmethod
     def _normalize_docstring(string: str) -> str:
-        # convert Google and numpy style docstrings to parse docstrings
-        # as restructured text
-        return str(
-            _s.NumpyDocstring(  # type: ignore
-                str(
-                    _s.GoogleDocstring(  # type: ignore
-                        _textwrap.dedent(
-                            "\n".join(string.splitlines()[1:]),
-                        ).replace("*", ""),
-                    ),
-                ),
-            ),
-        )
+        # convert Google or numpy style to rst when detected
+        # leave rst (including field lists) unchanged
+        string = _inspect.cleandoc(string)
+        style = Docstring._docstring_style(string)
+        if style == "google":
+            return str(_s.GoogleDocstring(string))  # type: ignore
+
+        if style == "numpy":
+            return str(_s.NumpyDocstring(string))  # type: ignore
+
+        return string
 
     def __init__(
         self,
@@ -371,16 +394,24 @@ class Docstring(_Stub):
         # the suggestion is broken
         # noinspection RegExpSingleCharAlternation
         for match in _re.findall(
-            r":([\w\s]+(?:\s\|\s[\w\s]+|\w+))([^\w\s])((?:.|\n)*?)(?=\n:|$)",
+            r":((?:\\?\*){0,2}[\w]+"
+            r"(?:\s+(?:\\?\*){0,2}[\w]+|"
+            r"\s\|\s(?:\\?\*){0,2}[\w]+)*)"
+            r"([^\w\s\\*])"
+            r"((?:.|\n)*?)(?=\n:|$)",
             string,
         ):
             if match:
                 kinds = match[0].split()
                 if kinds:
+                    name = None
+                    if len(kinds) > 1:
+                        # drop * / ** / napoleon-escaped stars on the name
+                        name = kinds[-1].lstrip("\\*")
                     docstring.args.append(
                         Param(
                             DocType.from_str(kinds[0]),
-                            UNNAMED if len(kinds) == 1 else kinds[-1],
+                            UNNAMED if name is None else name,
                             match[2] or None,
                             int(indent_anomaly),
                             match[1],

{docsig-0.90.0 → docsig-0.90.2}/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.90.0"
+__version__ = "0.90.2"

{docsig-0.90.0 → docsig-0.90.2}/pyproject.toml

@@ -29,7 +29,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "0.90.0"
+version = "0.90.2"
 
 [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.90.0"
+current_version = "0.90.2"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true