docsig 0.82.0__tar.gz → 0.82.1__tar.gz

{docsig-0.82.0 → docsig-0.82.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.82.0
+Version: 0.82.1
 Summary: Check signature params for proper documentation
 License: MIT
 License-File: LICENSE
@@ -184,7 +184,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.82.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.82.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
 
@@ -270,7 +270,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.82.0
+        rev: v0.82.1
         hooks:
           - id: docsig
             args:
@@ -289,7 +289,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.82.0
+              - docsig==0.82.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.82.0 → docsig-0.82.1}/README.rst

@@ -155,7 +155,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.82.0, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.82.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
 
@@ -241,7 +241,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.82.0
+        rev: v0.82.1
         hooks:
           - id: docsig
             args:
@@ -260,7 +260,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.82.0
+              - docsig==0.82.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.82.0 → docsig-0.82.1}/docsig/_config.py

@@ -364,7 +364,7 @@ class Config:
     target: _Messages = _field(default_factory=_Messages)
     disable: _Messages = _field(default_factory=_Messages)
     exclude: list[str] = _field(default_factory=list)
-    excludes: list[str] | None = None
+    excludes: list[str] = _field(default_factory=list)
     list_checks: bool = False
     include_ignored: bool = False
     no_ansi: bool = False

{docsig-0.82.0 → docsig-0.82.1}/docsig/_core.py

@@ -199,7 +199,7 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         target=target or _Messages(),
         disable=disable,
         exclude=exclude_,
-        excludes=excludes,
+        excludes=excludes or [],
     )
     setup_logger(config.verbose)
     if config.list_checks:

{docsig-0.82.0 → docsig-0.82.1}/docsig/_decorators.py

@@ -12,8 +12,8 @@ from pathlib import Path as _Path
 
 from .messages import E as _E
 
-_FuncType = _t.Callable[..., _t.Union[int]]
-_WrappedFuncType = _t.Callable[..., _t.Union[str, int]]
+_FuncType = _t.Callable[..., int]
+_WrappedFuncType = _t.Callable[..., str | int]
 
 
 def parse_msgs(func: _WrappedFuncType) -> _WrappedFuncType:

{docsig-0.82.0 → docsig-0.82.1}/docsig/_directives.py

@@ -8,14 +8,13 @@ Parsing and storage for docsig comment directives.
 from __future__ import annotations as _
 
 import tokenize as _tokenize
-import typing as _t
 from io import StringIO as _StringIO
 
 from .messages import E as _E
 from .messages import Messages as _Messages
 
 
-class Comments(_t.List["Comment"]):
+class Comments(list["Comment"]):
     """List of comments."""
 
 
@@ -96,7 +95,7 @@ class Comment(_Messages):
         return None
 
 
-class Directives(_t.Dict[int, _t.Tuple[Comments, _Messages]]):
+class Directives(dict[int, tuple[Comments, _Messages]]):
     """Map line number to comments and disabled messages for that line.
 
     Keys are line numbers; values are tuples of comment directives and

{docsig-0.82.0 → docsig-0.82.1}/docsig/_files.py

@@ -10,7 +10,6 @@ from __future__ import annotations as _
 import logging as _logging
 import os as _os
 import re as _re
-import typing as _t
 from pathlib import Path as _Path
 
 from pathspec import PathSpec as _PathSpec
@@ -71,7 +70,7 @@ def _glob(path: _Path, pattern: str) -> bool:
     return _WcPath(str(path)).globmatch(pattern)  # type: ignore
 
 
-class Files(_t.List[_Path]):
+class Files(list[_Path]):
     """Collect paths to check (gitignore and exclude applied).
 
     :param paths: Path(s) to collect (files or directories).
@@ -93,7 +92,7 @@ class Files(_t.List[_Path]):
         for path in list(self):
             if str(path) != "." and (
                 any(_re.match(i, str(path)) for i in config.exclude)
-                or any(_glob(path, i) for i in config.excludes or [])
+                or any(_glob(path, i) for i in config.excludes)
             ):
                 logger.debug(FILE_INFO, path, "in exclude list, skipping")
                 self.remove(path)

{docsig-0.82.0 → docsig-0.82.1}/docsig/_module.py

@@ -23,16 +23,13 @@ from ._stub import Signature as _Signature
 from .messages import Messages as _Messages
 
 
-class _Imports(_t.Dict[str, str]):
-    """Represents python imports."""
+class _Imports(dict[str, str]): ...
 
 
-class _Overloads(_t.Dict[str, "Function"]):
-    """Represents overloaded methods."""
+class _Overloads(dict[str, "Function"]): ...
 
 
-class _Children(_t.List[_t.Union["Parent", "Function"]]):
-    """Represents children of an object."""
+class _Children(list[_t.Union["Parent", "Function"]]): ...
 
 
 class Error(_Enum):

{docsig-0.82.0 → docsig-0.82.1}/docsig/_report.py

@@ -36,7 +36,7 @@ _MIN_MATCH = 0.8
 _MAX_MATCH = 1.0
 
 
-class Failures(_t.List["Failure"]):
+class Failures(list["Failure"]):
     """Sequence of Failure instances (one per function checked)."""
 
 
@@ -52,7 +52,7 @@ class Failed(_t.NamedTuple):
     new: bool = False
 
 
-class Failure(_t.List[Failed]):
+class Failure(list[Failed]):
     """Collect docstring and signature failures for one function.
 
     Runs configured checks and appends Failed entries for each

{docsig-0.82.0 → docsig-0.82.1}/docsig/_stub.py

@@ -9,7 +9,6 @@ from __future__ import annotations as _
 
 import re as _re
 import textwrap as _textwrap
-import typing as _t
 from collections import Counter as _Counter
 from enum import Enum as _Enum
 
@@ -153,7 +152,7 @@ class Param:
         return self._closing_token
 
 
-class Params(_t.List[Param]):
+class Params(list[Param]):
     """A list-like collection of params.
 
     :param ignore: Configuration object for what to ignore.
@@ -366,15 +365,12 @@ class Docstring(_Stub):
         # todo: we can start building return objects for more detailed
         # todo: checks that are in common with the params class
         match = _re.search(
-            ":(?:returns?|yields?):(.*)?",
+            r":(?:returns?|yields?):\s*(.*)",
             string,
             _re.IGNORECASE,
         )
         returns = bool(match)
-        ret_description_missing = False
-        if match:
-            ret_description_missing = not match.group(1)
-
+        ret_description_missing = not match or not match.group(1)
         docstring = cls(string, returns, ret_description_missing)
         for match in _re.findall(
             r":([\w\s]+(?:\s\|\s[\w\s]+|\w+))([^\w\s])((?:.|\n)*?)(?=\n:|$)",

{docsig-0.82.0 → docsig-0.82.1}/docsig/_utils.py

@@ -9,7 +9,6 @@ from __future__ import annotations as _
 
 import re as _re
 import sys as _sys
-import typing as _t
 from difflib import SequenceMatcher as _SequenceMatcher
 
 from .messages import TEMPLATE as _TEMPLATE
@@ -34,7 +33,7 @@ def almost_equal(str1: str, str2: str, mini: float, maxi: float) -> bool:
 
 
 def pretty_print_error(
-    exception_type: _t.Type[BaseException],
+    exception_type: type[BaseException],
     msg: str,
     no_ansi: bool,
 ) -> None:

{docsig-0.82.0 → docsig-0.82.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.82.0"
+__version__ = "0.82.1"

{docsig-0.82.0 → docsig-0.82.1}/docsig/messages.py

@@ -24,7 +24,7 @@ NEW = """\
 """
 
 
-class Messages(_t.List["Message"]):
+class Messages(list["Message"]):
     """Sequence of Message instances, typically for one failure."""
 
 
@@ -41,7 +41,7 @@ class Message(_t.NamedTuple):
     symbolic: str = ""
 
     #: A hint, if any, suggesting why the error may have occurred.
-    hint: _t.Optional[str] = None
+    hint: str | None = None
 
     #: Whether this message is a new addition.
     new: bool = False
@@ -67,7 +67,7 @@ class Message(_t.NamedTuple):
         )
 
 
-class MessageMap(_t.Dict[int, Message]):
+class MessageMap(dict[int, Message]):
     """Mapping from integer key to Message (used for the E registry)."""
 
     def from_ref(self, ref: str) -> Message:

{docsig-0.82.0 → docsig-0.82.1}/docsig/plugin.py

@@ -22,7 +22,7 @@ from ._core import handle_deprecations, runner, setup_logger
 from ._version import __version__
 from .messages import FLAKE8, E
 
-Flake8Error = t.Tuple[int, int, str, t.Type[t.Any]]
+Flake8Error = tuple[int, int, str, type[t.Any]]
 sys.path.append(os.path.abspath(os.getcwd()))
 
 

{docsig-0.82.0 → docsig-0.82.1}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.82.0"
+current_version = "0.82.1"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -122,7 +122,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.82.0"
+version = "0.82.1"
 
 [tool.poetry.dependencies]
 Sphinx = ">=7,<9"
@@ -236,3 +236,14 @@ name = "Removed"
 
 [tool.towncrier.fragment.security]
 name = "Security"
+
+[tool.vulture]
+exclude = [
+  "tests/_templates.py",
+  "tests/conftest.py"
+]
+make_whitelist = true
+paths = [
+  "docsig",
+  "tests"
+]