docsig 0.59.1__tar.gz → 0.59.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {docsig-0.59.1 → docsig-0.59.3}/PKG-INFO +4 -4
- {docsig-0.59.1 → docsig-0.59.3}/README.rst +3 -3
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_core.py +14 -14
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_files.py +12 -9
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_version.py +1 -1
- {docsig-0.59.1 → docsig-0.59.3}/pyproject.toml +4 -3
- {docsig-0.59.1 → docsig-0.59.3}/LICENSE +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/__init__.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/__main__.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_config.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_decorators.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_directives.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_hooks.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_main.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_module.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_report.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_stub.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/_utils.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/messages.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/plugin.py +0 -0
- {docsig-0.59.1 → docsig-0.59.3}/docsig/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: docsig
|
|
3
|
-
Version: 0.59.
|
|
3
|
+
Version: 0.59.3
|
|
4
4
|
Summary: Check signature params for proper documentation
|
|
5
5
|
Home-page: https://pypi.org/project/docsig/
|
|
6
6
|
License: MIT
|
|
@@ -169,7 +169,7 @@ ensure your installation has registered `docsig`
|
|
|
169
169
|
.. code-block:: console
|
|
170
170
|
|
|
171
171
|
$ flake8 --version
|
|
172
|
-
7.1.0 (docsig: 0.59.
|
|
172
|
+
7.1.0 (docsig: 0.59.3, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
|
|
173
173
|
|
|
174
174
|
And now use `flake8` to lint your files
|
|
175
175
|
|
|
@@ -258,7 +258,7 @@ Standalone
|
|
|
258
258
|
|
|
259
259
|
repos:
|
|
260
260
|
- repo: https://github.com/jshwi/docsig
|
|
261
|
-
rev: v0.59.
|
|
261
|
+
rev: v0.59.3
|
|
262
262
|
hooks:
|
|
263
263
|
- id: docsig
|
|
264
264
|
args:
|
|
@@ -277,7 +277,7 @@ or integrated with ``flake8``
|
|
|
277
277
|
hooks:
|
|
278
278
|
- id: flake8
|
|
279
279
|
additional_dependencies:
|
|
280
|
-
- docsig==0.59.
|
|
280
|
+
- docsig==0.59.3
|
|
281
281
|
args:
|
|
282
282
|
- "--sig-check-class"
|
|
283
283
|
- "--sig-check-dunders"
|
|
@@ -143,7 +143,7 @@ ensure your installation has registered `docsig`
|
|
|
143
143
|
.. code-block:: console
|
|
144
144
|
|
|
145
145
|
$ flake8 --version
|
|
146
|
-
7.1.0 (docsig: 0.59.
|
|
146
|
+
7.1.0 (docsig: 0.59.3, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
|
|
147
147
|
|
|
148
148
|
And now use `flake8` to lint your files
|
|
149
149
|
|
|
@@ -232,7 +232,7 @@ Standalone
|
|
|
232
232
|
|
|
233
233
|
repos:
|
|
234
234
|
- repo: https://github.com/jshwi/docsig
|
|
235
|
-
rev: v0.59.
|
|
235
|
+
rev: v0.59.3
|
|
236
236
|
hooks:
|
|
237
237
|
- id: docsig
|
|
238
238
|
args:
|
|
@@ -251,7 +251,7 @@ or integrated with ``flake8``
|
|
|
251
251
|
hooks:
|
|
252
252
|
- id: flake8
|
|
253
253
|
additional_dependencies:
|
|
254
|
-
- docsig==0.59.
|
|
254
|
+
- docsig==0.59.3
|
|
255
255
|
args:
|
|
256
256
|
- "--sig-check-class"
|
|
257
257
|
- "--sig-check-dunders"
|
|
@@ -26,20 +26,20 @@ from .messages import Messages as _Messages
|
|
|
26
26
|
|
|
27
27
|
_DEFAULT_EXCLUDES = """\
|
|
28
28
|
(?x)^(
|
|
29
|
-
|\\.?venv
|
|
30
|
-
|\\.git
|
|
31
|
-
|\\.hg
|
|
32
|
-
|\\.idea
|
|
33
|
-
|\\.mypy_cache
|
|
34
|
-
|\\.nox
|
|
35
|
-
|\\.pytest_cache
|
|
36
|
-
|\\.svn
|
|
37
|
-
|\\.tox
|
|
38
|
-
|\\.vscode
|
|
39
|
-
|_?build
|
|
40
|
-
|
|
41
|
-
|dist
|
|
42
|
-
|node_modules
|
|
29
|
+
|\\.?venv[\\\\/].*
|
|
30
|
+
|\\.git[\\\\/].*
|
|
31
|
+
|\\.hg[\\\\/].*
|
|
32
|
+
|\\.idea[\\\\/].*
|
|
33
|
+
|\\.mypy_cache[\\\\/].*
|
|
34
|
+
|\\.nox[\\\\/].*
|
|
35
|
+
|\\.pytest_cache[\\\\/].*
|
|
36
|
+
|\\.svn[\\\\/].*
|
|
37
|
+
|\\.tox[\\\\/].*
|
|
38
|
+
|\\.vscode[\\\\/].*
|
|
39
|
+
|_?build[\\\\/].*
|
|
40
|
+
|.*[\\\\/]__pycache__[\\\\/].*
|
|
41
|
+
|dist[\\\\/].*
|
|
42
|
+
|node_modules[\\\\/].*
|
|
43
43
|
)$
|
|
44
44
|
"""
|
|
45
45
|
|
|
@@ -88,21 +88,24 @@ class Paths(_t.List[_Path]): # pylint: disable=too-many-instance-attributes
|
|
|
88
88
|
for path in paths:
|
|
89
89
|
self._populate(path)
|
|
90
90
|
|
|
91
|
+
for path in list(self):
|
|
92
|
+
if str(path) != "." and any(
|
|
93
|
+
_re.match(i, str(path)) for i in self._excludes
|
|
94
|
+
):
|
|
95
|
+
_vprint(
|
|
96
|
+
FILE_INFO.format(
|
|
97
|
+
path=path, msg="in exclude list, skipping"
|
|
98
|
+
),
|
|
99
|
+
self._verbose,
|
|
100
|
+
)
|
|
101
|
+
self.remove(path)
|
|
102
|
+
|
|
91
103
|
self.sort()
|
|
92
104
|
|
|
93
105
|
def _populate(self, root: _Path) -> None:
|
|
94
106
|
if not root.exists():
|
|
95
107
|
raise FileNotFoundError(root)
|
|
96
108
|
|
|
97
|
-
if str(root) != "." and any(
|
|
98
|
-
_re.match(i, root.name) for i in self._excludes
|
|
99
|
-
):
|
|
100
|
-
_vprint(
|
|
101
|
-
FILE_INFO.format(path=root, msg="in exclude list, skipping"),
|
|
102
|
-
self._verbose,
|
|
103
|
-
)
|
|
104
|
-
return
|
|
105
|
-
|
|
106
109
|
if not self._include_ignored and self._gitignore.match_file(root):
|
|
107
110
|
_vprint(
|
|
108
111
|
FILE_INFO.format(path=root, msg="in gitignore, skipping"),
|
|
@@ -11,7 +11,7 @@ line-length = 79
|
|
|
11
11
|
allow_dirty = true
|
|
12
12
|
commit = true
|
|
13
13
|
commit_args = "-sS"
|
|
14
|
-
current_version = "0.59.
|
|
14
|
+
current_version = "0.59.3"
|
|
15
15
|
message = "bump: version {current_version} → {new_version}"
|
|
16
16
|
sign_tags = true
|
|
17
17
|
tag = true
|
|
@@ -132,7 +132,7 @@ maintainers = [
|
|
|
132
132
|
name = "docsig"
|
|
133
133
|
readme = "README.rst"
|
|
134
134
|
repository = "https://github.com/jshwi/docsig"
|
|
135
|
-
version = "0.59.
|
|
135
|
+
version = "0.59.3"
|
|
136
136
|
|
|
137
137
|
[tool.poetry.dependencies]
|
|
138
138
|
Sphinx = "^7.0.0"
|
|
@@ -144,7 +144,7 @@ python = "^3.8.1"
|
|
|
144
144
|
[tool.poetry.group.dev.dependencies]
|
|
145
145
|
black = "^24.4.2"
|
|
146
146
|
bump-my-version = "^0.24.1"
|
|
147
|
-
deptry = "
|
|
147
|
+
deptry = ">=0.16.1,<0.18.0"
|
|
148
148
|
docformatter = "^1.7.5"
|
|
149
149
|
flynt = "^1.0.1"
|
|
150
150
|
gitpython = "^3.1.43"
|
|
@@ -160,6 +160,7 @@ vulture = "^2.11"
|
|
|
160
160
|
|
|
161
161
|
[tool.poetry.group.docs.dependencies]
|
|
162
162
|
furo = "^2024.4.27"
|
|
163
|
+
incremental = "22.10.0"
|
|
163
164
|
myst-parser = "^3.0.1"
|
|
164
165
|
pytest = "^8.2.0"
|
|
165
166
|
pyyaml = "^6.0.1"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|