pydocstyle - docstring style checker
pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.
pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.
pydocstyle supports Python 3.6+.
Quick Start
Install
pip install pydocstyleRun
$ pydocstyle test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:27 in public function `get_user`:
D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
D201: No blank lines allowed before function docstring (found 1)
...Develop
You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -
Before submitting a PR make sure that you run make all.
Links
2 maintainers
Metadata
2 maintainers
Release files for pydocstyle 6.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pydocstyle-6.3.0.tar.gz | 36.8 kB | Without provenance | Details for pydocstyle-6.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pydocstyle-6.3.0-py3-none-any.whl | Python 3 | none | any | Details for pydocstyle-6.3.0-py3-none-any.whl |
Total release size: 74.8 kB
Release files / pydocstyle-6.3.0.tar.gz
| Download URL | pydocstyle-6.3.0.tar.gz |
|---|---|
| Size | 36.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1
|
|
BLAKE2b-256 checksum How to use checksums |
e95cd5385ca59fd065e3c6a5fe19f9bc9d5ea7f2509fa8c9c22fb6b2031dd953
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.6 Linux/5.15.0-1030-azure
|
Release files / pydocstyle-6.3.0-py3-none-any.whl
| Download URL | pydocstyle-6.3.0-py3-none-any.whl |
|---|---|
| Size | 38.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019
|
|
BLAKE2b-256 checksum How to use checksums |
36ea99ddefac41971acad68f14114f38261c1f27dac0b3ec529824ebc739bdaa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.6 Linux/5.15.0-1030-azure
|
Security for pydocstyle 6.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
