docsig 0.56.0__tar.gz → 0.57.0__tar.gz

{docsig-0.56.0 → docsig-0.57.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.56.0
+Version: 0.57.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -9,10 +9,9 @@ Author: jshwi
 Author-email: stephen@jshwisolutions.com
 Maintainer: jshwi
 Maintainer-email: stephen@jshwisolutions.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.8.1,<4.0.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -162,6 +161,39 @@ Options can also be configured with the pyproject.toml file
         "SIG201",
     ]
 
+Flake8
+******
+
+``docsig`` can also be used as a ``flake8`` plugin. Install ``flake8`` and
+ensure your installation has registered `docsig`
+
+.. code-block:: console
+
+    $ flake8 --version
+    7.1.0 (docsig: 0.57.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+
+And now use `flake8` to lint your files
+
+.. code-block:: console
+
+    $ flake8 example.py
+    example.py:1:1: SIG202 includes parameters that do not exist (params-do-not-exist) 'function'
+
+With ``flake8`` the pyproject.toml config will still be the base config, though the
+`ini files <https://flake8.pycqa.org/en/latest/user/configuration.html#configuration-locations>`_ ``flake8`` gets it config from will override the pyproject.toml config.
+For ``flake8`` all args and config options are prefixed with ``sig`` to
+avoid any potential conflicts with other plugins
+
+.. code-block:: ini
+
+    [flake8]
+    sig-check-dunders = True
+    sig-check-overridden = True
+    sig-check-protected = True
+
+..
+   end flake8
+
 API
 ***
 
@@ -225,7 +257,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.56.0
+        rev: v0.57.0
         hooks:
           - id: docsig
             args:

{docsig-0.56.0 → docsig-0.57.0}/README.rst

@@ -134,6 +134,39 @@ Options can also be configured with the pyproject.toml file
         "SIG201",
     ]
 
+Flake8
+******
+
+``docsig`` can also be used as a ``flake8`` plugin. Install ``flake8`` and
+ensure your installation has registered `docsig`
+
+.. code-block:: console
+
+    $ flake8 --version
+    7.1.0 (docsig: 0.57.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+
+And now use `flake8` to lint your files
+
+.. code-block:: console
+
+    $ flake8 example.py
+    example.py:1:1: SIG202 includes parameters that do not exist (params-do-not-exist) 'function'
+
+With ``flake8`` the pyproject.toml config will still be the base config, though the
+`ini files <https://flake8.pycqa.org/en/latest/user/configuration.html#configuration-locations>`_ ``flake8`` gets it config from will override the pyproject.toml config.
+For ``flake8`` all args and config options are prefixed with ``sig`` to
+avoid any potential conflicts with other plugins
+
+.. code-block:: ini
+
+    [flake8]
+    sig-check-dunders = True
+    sig-check-overridden = True
+    sig-check-protected = True
+
+..
+   end flake8
+
 API
 ***
 
@@ -197,7 +230,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.56.0
+        rev: v0.57.0
         hooks:
           - id: docsig
             args:

{docsig-0.56.0 → docsig-0.57.0}/docsig/_hooks.py

@@ -14,7 +14,7 @@ def excepthook(no_ansi: bool = False) -> None:
 
     :param no_ansi: Disable ANSI output.
     """
-    if _e.get("DOCSIG_DEBUG", None) != "1":
+    if _e.get("DOCSIG_DEBUG") != "1":
         _sys.excepthook = lambda x, y, _: _pretty_print_error(
             x, str(y), no_ansi
         )

{docsig-0.56.0 → docsig-0.57.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.56.0"
+__version__ = "0.57.0"

{docsig-0.56.0 → docsig-0.57.0}/docsig/messages.py

@@ -14,6 +14,9 @@ UNKNOWN = "SIG000"
 #: Default template to format message strings.
 TEMPLATE = "{ref}: {description} ({symbolic})"
 
+#: Flake8 template to format message strings.
+FLAKE8 = "{ref} {description} ({symbolic})"
+
 
 class Message(_t.NamedTuple):
     """Represents an error message."""

docsig-0.57.0/docsig/plugin.py

@@ -0,0 +1,165 @@
+"""Flake8 implementation of docsig."""
+
+import ast
+import contextlib
+import io
+import re
+import sys
+import typing as t
+from argparse import Namespace
+
+import docsig
+
+Flake8Error = t.Tuple[int, int, str, t.Type]
+
+
+class Docsig:
+    """Flake8 implementation of docsig class.
+
+    :param tree: Ast module, which will not be used by flake8 will
+        provide.
+    :param filename: Filename to pass to docsig.
+    """
+
+    off_by_default = False
+    name = docsig.__name__
+    version = docsig.__version__
+    options_dict: t.Dict[str, bool] = {}
+
+    def __init__(self, tree: ast.Module, filename: str) -> None:
+        _tree = tree  # noqa
+        self.filename = filename
+
+    # won't import flake8 type
+    # conflicts with this module name
+    # might require that flake8 actually be installed, which is not a
+    # requirement for this package
+    @classmethod
+    def add_options(cls, parser) -> None:
+        """Add flake8 commandline and config options.sig_
+
+        :param parser: Flake8 option manager.
+        """
+        parser.add_option(
+            "--sig-check-class",
+            action="store_true",
+            parse_from_config=True,
+            help="check class docstrings",
+        )
+        parser.add_option(
+            "--sig-check-class-constructor",
+            action="store_true",
+            parse_from_config=True,
+            help="check __init__ methods. Note: mutually incompatible with -c",
+        )
+        parser.add_option(
+            "--sig-check-dunders",
+            action="store_true",
+            parse_from_config=True,
+            help="check dunder methods",
+        )
+        parser.add_option(
+            "--sig-check-protected-class-methods",
+            action="store_true",
+            parse_from_config=True,
+            help="check public methods belonging to protected classes",
+        )
+        parser.add_option(
+            "--sig-check-nested",
+            action="store_true",
+            parse_from_config=True,
+            help="check nested functions and classes",
+        )
+        parser.add_option(
+            "--sig-check-overridden",
+            action="store_true",
+            parse_from_config=True,
+            help="check overridden methods",
+        )
+        parser.add_option(
+            "--sig-check-protected",
+            action="store_true",
+            parse_from_config=True,
+            help="check protected functions and classes",
+        )
+        parser.add_option(
+            "--sig-check-property-returns",
+            action="store_true",
+            parse_from_config=True,
+            help="check property return values",
+        )
+        parser.add_option(
+            "--sig-ignore-no-params",
+            action="store_true",
+            parse_from_config=True,
+            help="ignore docstrings where parameters are not documented",
+        )
+        parser.add_option(
+            "--sig-ignore-args",
+            action="store_true",
+            parse_from_config=True,
+            help="ignore args prefixed with an asterisk",
+        )
+        parser.add_option(
+            "--sig-ignore-kwargs",
+            action="store_true",
+            parse_from_config=True,
+            help="ignore kwargs prefixed with two asterisks",
+        )
+        parser.add_option(
+            "--sig-ignore-typechecker",
+            action="store_true",
+            parse_from_config=True,
+            help="ignore checking return values",
+        )
+
+    @classmethod
+    def parse_options(cls, options: Namespace) -> None:
+        """Parse flake8 options into am instance accessible dict.
+
+        :param options: Argparse namespace.
+        """
+        cls.options_dict = {
+            "check_class": options.sig_check_class,
+            "check_class_constructor": options.sig_check_class_constructor,
+            "check_dunders": options.sig_check_dunders,
+            "check_protected_class_methods": (
+                options.sig_check_protected_class_methods
+            ),
+            "check_nested": options.sig_check_nested,
+            "check_overridden": options.sig_check_overridden,
+            "check_protected": options.sig_check_protected,
+            "check_property_returns": options.sig_check_property_returns,
+            "ignore_no_params": options.sig_ignore_no_params,
+            "ignore_args": options.sig_ignore_args,
+            "ignore_kwargs": options.sig_ignore_kwargs,
+            "ignore_typechecker": options.sig_ignore_typechecker,
+        }
+
+    def run(self) -> t.Generator[Flake8Error, None, None]:
+        """Run docsig and possibly yield a flake8 error.
+
+        :return: Flake8 error, if there is one.
+        """
+        buffer = io.StringIO()
+        with contextlib.redirect_stdout(buffer):
+            sys.argv = [
+                __package__,
+                self.filename,
+                *[
+                    f"--{k.replace('_', '-')}"
+                    for k, v in self.options_dict.items()
+                    if v
+                ],
+            ]
+            docsig.main()
+
+        results = re.split(r"^(?!\s)", buffer.getvalue(), flags=re.MULTILINE)
+        for result in results:
+            if not result:
+                continue
+
+            header, remainder = result.splitlines()[:2]
+            lineno, func_name = header.split(":", 1)[1].split(" in ", 1)
+            line = f"{remainder.lstrip().replace(':', '')} '{func_name}'"
+            yield int(lineno), 0, line, self.__class__

{docsig-0.56.0 → docsig-0.57.0}/pyproject.toml

@@ -7,12 +7,56 @@ requires = [
 [tool.black]
 line-length = 79
 
+[tool.bumpversion]
+allow_dirty = true
+commit = true
+commit_args = "-sS"
+current_version = "0.57.0"
+message = "bump: version {current_version} → {new_version}"
+sign_tags = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"
+
+[[tool.bumpversion.files]]
+filename = "docsig/_version.py"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+replace = 'version = "{new_version}"'
+search = 'version = "{current_version}"'
+
+[[tool.bumpversion.files]]
+filename = "package.json"
+replace = '"version": "{new_version}"'
+search = '"version": "{current_version}"'
+
+[[tool.bumpversion.files]]
+filename = "README.rst"
+replace = "rev: v{new_version}"
+search = "rev: v{current_version}"
+
+[[tool.bumpversion.files]]
+filename = "README.rst"
+replace = "docsig: {new_version}"
+search = "docsig: {current_version}"
+
+[[tool.bumpversion.files]]
+filename = "SECURITY.md"
+
+[[tool.bumpversion.files]]
+filename = "Makefile"
+replace = "VERSION := {new_version}"
+search = "VERSION := {current_version}"
+
 [tool.codespell]
 ignore-words-list = "astroid"
 
 [tool.coverage.report]
 exclude_lines = [
-  "@_t.overload"
+  "@_t.overload",
+  "if __name__ == .__main__.:"
 ]
 fail_under = 100
 
@@ -24,7 +68,14 @@ omit = [
 ]
 
 [tool.deptry.per_rule_ignores]
-DEP004 = ["yaml"]
+DEP004 = [
+  "flake8",
+  "git",
+  "pytest",
+  "tomli",
+  "tomli_w",
+  "yaml"
+]
 
 [tool.docformatter]
 in-place = true
@@ -76,7 +127,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.56.0"
+version = "0.57.0"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
@@ -84,18 +135,22 @@ arcon = ">=0.4.0"
 astroid = "^3.0.1"
 click = "^8.1.7"
 pathspec = "^0.12.1"
-python = "^3.8"
+python = "^3.8.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
-bump2version = "^1.0.1"
+bump-my-version = "^0.24.1"
 deptry = "^0.16.1"
 docformatter = "^1.7.5"
 flynt = "^1.0.1"
+gitpython = "^3.1.43"
 isort = "^5.13.2"
 mypy = "^1.10.0"
 pre-commit = "^3.3.3"
 pylint = "^3.1.0"
+tomli = "^2.0.1"
+tomli-w = "^1.0.0"
+towncrier = "^23.11.0"
 tox = "^4.15.0"
 vulture = "^2.11"
 
@@ -108,6 +163,9 @@ sphinx-copybutton = "^0.5.2"
 sphinx-markdown-builder = ">=0.5.5,<0.7.0"
 templatest = "^0.10.1"
 
+[tool.poetry.group.flake8.dependencies]
+flake8 = "^7.1.0"
+
 [tool.poetry.group.tests.dependencies]
 pytest = "^8.2.0"
 pytest-benchmark = "^4.0.0"
@@ -117,6 +175,9 @@ pytest-sugar = "^1.0.0"
 pytest-xdist = "^3.6.1"
 templatest = "^0.10.1"
 
+[tool.poetry.plugins."flake8.extension"]
+SIG = "docsig.plugin:Docsig"
+
 [tool.poetry.scripts]
 docsig = "docsig.__main__:main"
 
@@ -149,3 +210,32 @@ norecursedirs = [
   ".pytest_cache",
   "docs"
 ]
+
+[tool.towncrier]
+directory = "changelog"
+filename = "CHANGELOG.md"
+issue_format = "[#{issue}](https://github.com/jshwi/docsig/issues/{issue})"
+package = "docsig"
+start_string = "<!-- release notes start -->\n"
+template = "changelog/_template.md"
+
+[tool.towncrier.fragment.add]
+name = "Added"
+
+[tool.towncrier.fragment.change]
+name = "Changed"
+
+[tool.towncrier.fragment.deprecate]
+name = "Deprecated"
+
+[tool.towncrier.fragment.fix]
+name = "Fixed"
+
+[tool.towncrier.fragment.hack]
+name = "Hacked"
+
+[tool.towncrier.fragment.remove]
+name = "Removed"
+
+[tool.towncrier.fragment.security]
+name = "Security"