docsig 0.87.1__tar.gz → 0.89.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.87.1
+Version: 0.89.0
 Summary: Check signature params for proper documentation
 License-Expression: MIT
 License-File: LICENSE
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: astroid (>=4.0.2,<5.0.0)
 Requires-Dist: pathspec (>=0.12.1,<1.2.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0)
-Requires-Dist: wcmatch (>=8.5.2,<11.0.0)
+Requires-Dist: wcmatch (>=10.2.1,<11.0.0)
 Project-URL: Documentation, https://docsig.io/en/latest
 Project-URL: Homepage, https://docsig.io
 Project-URL: Repository, https://github.com/jshwi/docsig
@@ -35,7 +35,7 @@ Description-Content-Type: text/x-rst
 
 |
 
-|License| |PyPI| |Jetbrains Plugin| |CI| |Jetbrains Build| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.10| |Black| |isort| |pylint| |Security Status|
+|License| |PyPI| |Jetbrains Plugin| |VS Code Extension| |CI| |Jetbrains Build| |VS Code Build| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.10| |Black| |isort| |pylint| |Security Status|
 
 .. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
@@ -79,6 +79,12 @@ Description-Content-Type: text/x-rst
 .. |Jetbrains Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml/badge.svg
    :target: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml
    :alt: Build
+.. |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
+   :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
+   :alt: VS Code Extension Version
 
 Check Python signature params for proper documentation
 -------------------------------------------------------
@@ -118,7 +124,7 @@ Commandline
                   [--check-property-returns] [--check-protected]
                   [--check-protected-class-methods] [--ignore-args] [--ignore-kwargs]
                   [--ignore-no-params] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
-                  [-I] [-s STR]
+                  [-i] [-s STR]
                   [path [path ...]]
 
     Check signature params for proper documentation
@@ -154,7 +160,7 @@ Commandline
                             regular expression of files or dirs to exclude from checks
       -E PATH [PATH ...], --excludes PATH [PATH ...]
                             path glob patterns to exclude from checks
-      -I, --include-ignored
+      -i, --include-ignored
                             check files even if they match a gitignore pattern
       -s STR, --string STR  string to parse instead of files
 
@@ -200,7 +206,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.87.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    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
 
 And now use `flake8` to lint your files
 
@@ -286,7 +292,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.87.1
+        rev: v0.89.0
         hooks:
           - id: docsig
             args:
@@ -305,7 +311,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.87.1
+              - docsig==0.89.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

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

@@ -7,7 +7,7 @@
 
 |
 
-|License| |PyPI| |Jetbrains Plugin| |CI| |Jetbrains Build| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.10| |Black| |isort| |pylint| |Security Status|
+|License| |PyPI| |Jetbrains Plugin| |VS Code Extension| |CI| |Jetbrains Build| |VS Code Build| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.10| |Black| |isort| |pylint| |Security Status|
 
 .. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
@@ -51,6 +51,12 @@
 .. |Jetbrains Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml/badge.svg
    :target: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml
    :alt: Build
+.. |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
+   :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
+   :alt: VS Code Extension Version
 
 Check Python signature params for proper documentation
 -------------------------------------------------------
@@ -90,7 +96,7 @@ Commandline
                   [--check-property-returns] [--check-protected]
                   [--check-protected-class-methods] [--ignore-args] [--ignore-kwargs]
                   [--ignore-no-params] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
-                  [-I] [-s STR]
+                  [-i] [-s STR]
                   [path [path ...]]
 
     Check signature params for proper documentation
@@ -126,7 +132,7 @@ Commandline
                             regular expression of files or dirs to exclude from checks
       -E PATH [PATH ...], --excludes PATH [PATH ...]
                             path glob patterns to exclude from checks
-      -I, --include-ignored
+      -i, --include-ignored
                             check files even if they match a gitignore pattern
       -s STR, --string STR  string to parse instead of files
 
@@ -172,7 +178,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.87.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    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
 
 And now use `flake8` to lint your files
 
@@ -258,7 +264,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.87.1
+        rev: v0.89.0
         hooks:
           - id: docsig
             args:
@@ -277,7 +283,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.87.1
+              - docsig==0.89.0
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

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

@@ -168,17 +168,10 @@ def build_parser() -> _ArgumentParser:
         help="check overridden methods",
         dest="check_overridden",
     )
-    parser.add_argument(
-        "-P",
-        action="store_true",
-        help=_argparse.SUPPRESS,
-        dest="check_property_returns",
-    )
     parser.add_argument(
         "--check-property-returns",
         action="store_true",
         help="check property return values",
-        dest="check_property_returns",
     )
     parser.add_argument(
         "-p",
@@ -250,6 +243,12 @@ def build_parser() -> _ArgumentParser:
     )
     parser.add_argument(
         "-I",
+        action="store_true",
+        help=_argparse.SUPPRESS,
+        dest="include_ignored",
+    )
+    parser.add_argument(
+        "-i",
         "--include-ignored",
         action="store_true",
         help="check files even if they match a gitignore pattern",

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

@@ -16,11 +16,11 @@ from ._hooks import excepthook as _excepthook
 
 def _warn_on_deprecated_short_flags() -> None:
     deprecated_short_flags = {
+        "-I": "--include-ignored",
         "-c": "--check-class",
         "-D": "--check-dunders",
         "-o": "--check-overridden",
         "-p": "--check-protected",
-        "-P": "--check-property-returns",
     }
     raw_args = _sys.argv[1:]
     expanded_flags = []

{docsig-0.87.1 → docsig-0.89.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.87.1"
+__version__ = "0.89.0"

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

@@ -12,7 +12,7 @@ dependencies = [
   "astroid (>=4.0.2,<5.0.0)",
   "pathspec (>=0.12.1,<1.2.0)",
   "tomli (>=2.0.1,<3.0.0)",
-  "wcmatch (>=8.5.2,<11.0.0)"
+  "wcmatch (>=10.2.1,<11.0.0)"
 ]
 description = "Check signature params for proper documentation"
 keywords = [
@@ -29,7 +29,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "0.87.1"
+version = "0.89.0"
 
 [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.87.1"
+current_version = "0.89.0"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -96,6 +96,7 @@ omit = [
   "docs/conf.py",
   "docsig/__main__.py",
   "docsig/_vendor/sphinx/ext/napoleon.py",
+  "tests/plugins/_gitignore.py",
   "whitelist.py"
 ]
 
@@ -141,18 +142,18 @@ repository = "https://github.com/jshwi/docsig"
 
 [tool.poetry.group.dev.dependencies]
 black = ">=24.4.2,<27.0.0"
-bump-my-version = ">=0.24.1,<1.4.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"
 isort = ">=5.13.2,<9.0.0"
 mypy = ">=1.10,<3.0"
 pre-commit = ">=3.3.3,<5.0.0"
-pylint = "^4.0.4"
+pylint = "^4.0.6"
 tomli = "^2.0.1"
 tomli-w = "^1.0.0"
 towncrier = ">=23.11,<26.0"
-tox = "^4.15.0"
+tox = "^4.56.1"
 validate-pyproject = {extras = ["all", "store"], version = "^0.25"}
 vulture = "^2.11"
 
@@ -160,7 +161,7 @@ vulture = "^2.11"
 Sphinx = ">=7,<8.2"
 furo = ">=2024.4.27,<2026.0.0"
 myst-parser = ">=3.0.1,<5.0.0"
-pytest = "9.0.3"
+pytest = "9.1.1"
 pyyaml = "^6.0.1"
 roman-numerals = "4.1.0"
 sphinx-copybutton = "^0.5.2"
@@ -175,10 +176,9 @@ flake8 = "^7.1.0"
 shiv = "^1.0.8"
 
 [tool.poetry.group.tests.dependencies]
-pytest = ">=8.2,<10.0"
+pytest = ">=9.1.1,<10.0"
 pytest-benchmark = ">=4,<6"
 pytest-cov = ">=5,<8"
-pytest-gitignore = "^1.3"
 pytest-randomly = ">=3.15,<5.0"
 pytest-sugar = "^1.0.0"
 pytest-xdist = "^3.6.1"
@@ -202,6 +202,7 @@ addopts = [
   "--color=yes",
   "--cov-report=term-missing",
   "--durations=5",
+  "-p _gitignore",
   "-vv"
 ]
 filterwarnings = "ignore::DeprecationWarning"
@@ -215,6 +216,9 @@ norecursedirs = [
   ".pytest_cache",
   "docs"
 ]
+pythonpath = [
+  "tests/plugins"
+]
 
 [tool.towncrier]
 directory = "changelog"
@@ -252,7 +256,8 @@ name = "Security"
 exclude = [
   "_vendor",
   "tests/base_test.py",
-  "tests/conftest.py"
+  "tests/conftest.py",
+  "tests/plugin"
 ]
 make_whitelist = true
 paths = [