npdlint 1__py3-none-any.whl
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.
- npdlint/__init__.py +12 -0
- npdlint/_vendor/LICENSE-numpydoc.txt +24 -0
- npdlint/_vendor/__init__.py +10 -0
- npdlint/_vendor/docscrape.py +780 -0
- npdlint/cli.py +588 -0
- npdlint/compat.py +220 -0
- npdlint/config.py +816 -0
- npdlint/diagnostics.py +50 -0
- npdlint/discovery.py +338 -0
- npdlint/docstring.py +404 -0
- npdlint/output.py +226 -0
- npdlint/plugins.py +142 -0
- npdlint/rules/__init__.py +33 -0
- npdlint/rules/base.py +356 -0
- npdlint/rules/general.py +346 -0
- npdlint/rules/messages.py +127 -0
- npdlint/rules/parameters.py +377 -0
- npdlint/rules/properties.py +438 -0
- npdlint/rules/returns.py +160 -0
- npdlint/rules/see_also.py +145 -0
- npdlint/rules/summary.py +233 -0
- npdlint/rules/suppressions.py +178 -0
- npdlint/runner.py +479 -0
- npdlint/scope.py +284 -0
- npdlint/selection.py +164 -0
- npdlint/source.py +477 -0
- npdlint/targets.py +1093 -0
- npdlint-1.dist-info/METADATA +469 -0
- npdlint-1.dist-info/RECORD +31 -0
- npdlint-1.dist-info/WHEEL +4 -0
- npdlint-1.dist-info/entry_points.txt +2 -0
npdlint/__init__.py
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""A fast, modular, structurally-aware linter for numpydoc-style docstrings."""
|
|
2
|
+
|
|
3
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
4
|
+
|
|
5
|
+
from npdlint.diagnostics import Diagnostic
|
|
6
|
+
|
|
7
|
+
try:
|
|
8
|
+
__version__ = version("npdlint")
|
|
9
|
+
except PackageNotFoundError: # pragma: no cover - running from a source tree
|
|
10
|
+
__version__ = "0.0.0+unknown"
|
|
11
|
+
|
|
12
|
+
__all__ = ["Diagnostic", "__version__"]
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
Copyright (C) 2008-2023 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi>
|
|
2
|
+
|
|
3
|
+
Redistribution and use in source and binary forms, with or without
|
|
4
|
+
modification, are permitted provided that the following conditions are
|
|
5
|
+
met:
|
|
6
|
+
|
|
7
|
+
1. Redistributions of source code must retain the above copyright
|
|
8
|
+
notice, this list of conditions and the following disclaimer.
|
|
9
|
+
2. Redistributions in binary form must reproduce the above copyright
|
|
10
|
+
notice, this list of conditions and the following disclaimer in
|
|
11
|
+
the documentation and/or other materials provided with the
|
|
12
|
+
distribution.
|
|
13
|
+
|
|
14
|
+
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
15
|
+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
16
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
17
|
+
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
|
|
18
|
+
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
19
|
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
20
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
21
|
+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
22
|
+
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
23
|
+
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
24
|
+
POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"""Vendored third-party code.
|
|
2
|
+
|
|
3
|
+
``docscrape.py`` is copied verbatim from numpydoc (BSD 3-Clause). The upstream
|
|
4
|
+
licence is kept alongside it in ``LICENSE-numpydoc.txt``. It is vendored rather
|
|
5
|
+
than imported so that this linter does not depend on numpydoc, and therefore
|
|
6
|
+
does not pull in Sphinx.
|
|
7
|
+
|
|
8
|
+
Upstream: https://github.com/numpy/numpydoc/blob/main/numpydoc/docscrape.py
|
|
9
|
+
Vendored at: numpydoc 1.11.0
|
|
10
|
+
"""
|