docsig 0.90.1__tar.gz → 0.90.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.90.1
+Version: 0.90.3
 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.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.90.3, 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.1
+        rev: v0.90.3
         hooks:
           - id: docsig
             args:
@@ -311,7 +311,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.90.1
+              - docsig==0.90.3
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

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

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

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

@@ -282,8 +282,8 @@ class Function(Parent):  # pylint: disable=too-many-instance-attributes
 
     @property
     def isproperty(self) -> bool:
-        """Whether this function is a property."""
-        valid_properties = "property", "cached_property"
+        """Whether this function is a property or property method."""
+        valid_properties = "property", "cached_property", "setter", "deleter"
         return self.ismethod and any(
             self._decorated_with(i) for i in valid_properties
         )

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

@@ -36,14 +36,14 @@ _MIN_MATCH = 0.8
 _MAX_MATCH = 1.0
 
 
-def check_function(func: _Function, config: _Config) -> "Failure":
+def check_function(func: _Function, config: _Config) -> "FunctionChecker":
     """Run configured checks for one function and return the result.
 
     :param func: Function under check.
     :param config: Configuration object.
     :return: Collected diagnostics for the function.
     """
-    return Failure(func, config)
+    return FunctionChecker(func, config)
 
 
 class RetCode:
@@ -68,7 +68,7 @@ class RetCode:
         return max(self._data)
 
 
-class Failures(list["Failure"]):
+class Failures(list["FunctionChecker"]):
     """Sequence of Failure instances (one per function checked)."""
 
 
@@ -85,7 +85,7 @@ class Diagnostic:  # pylint: disable=too-few-public-methods
     new: bool = False
 
 
-class Failure(list[Diagnostic]):
+class FunctionChecker(list[Diagnostic]):
     """Collect docstring and signature failures for one function.
 
     Runs configured checks and appends Failed entries for each

{docsig-0.90.1 → docsig-0.90.3}/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
@@ -42,6 +42,18 @@ class RetType(_Enum):
         if isinstance(returns, _ast.nodes.Const) and returns.value is None:
             return cls.NONE
 
+        # NoReturn / Never mean the function never returns a value, so
+        # treat them the same as -> None for documentation purposes
+        _no_return = {"NoReturn", "Never"}
+        if isinstance(returns, _ast.nodes.Name) and returns.name in _no_return:
+            return cls.NONE
+
+        if (
+            isinstance(returns, _ast.nodes.Attribute)
+            and returns.attrname in _no_return
+        ):
+            return cls.NONE
+
         if isinstance(
             returns,
             (
@@ -325,21 +337,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,
@@ -359,9 +394,9 @@ class Docstring(_Stub):
         indent_anomaly = cls._indent_anomaly(node.value)
         string = cls._normalize_docstring(node.value)
         match = _re.search(
-            r":(?:returns?|yields?):\s*(.*)",
+            r"^[ \t]*:(?:returns?|yields?):\s*(.*)",
             string,
-            _re.IGNORECASE,
+            _re.IGNORECASE | _re.MULTILINE,
         )
         returns = _Return(
             bool(match),
@@ -371,16 +406,25 @@ 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"^[ \t]*:((?:\\?\*){0,2}[\w]+"
+            r"(?:\s+(?:\\?\*){0,2}[\w]+|"
+            r"\s\|\s(?:\\?\*){0,2}[\w]+)*)"
+            r"([^\w\s\\*])"
+            r"((?:.|\n)*?)(?=\n[ \t]*:|\Z)",
             string,
+            _re.MULTILINE,
         ):
             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.1 → docsig-0.90.3}/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.1"
+__version__ = "0.90.3"

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

@@ -29,7 +29,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "0.90.1"
+version = "0.90.3"
 
 [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.1"
+current_version = "0.90.3"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -146,9 +146,9 @@ black = ">=24.4.2,<27.0.0"
 bump-my-version = ">=1.4.1,<1.5.0"
 deptry = ">=0.16.1,<0.26.0"
 flynt = "^1.0.1"
-gitpython = "^3.1.43"
+gitpython = "^3.1.51"
 isort = ">=5.13.2,<9.0.0"
-mypy = ">=2.2.0,<3.0"
+mypy = ">=2.3.0,<3.0"
 pre-commit = ">=3.3.3,<5.0.0"
 pylint = "^4.0.6"
 tomli = "^2.0.1"