pydocstyle

https://pep257.readthedocs.io/en/latest/
Admin
pydocstyle is a static analysis tool for checking compliance with Python docstring conventions,...
Tokens:1,570
Snippets:26
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install pydocstyle

Source: https://pep257.readthedocs.io/en/latest/index.html

Install pydocstyle using pip. This command should be run in your terminal.

```bash
pip install pydocstyle
```

--------------------------------

### Configure pydocstyle via INI file

Source: https://pep257.readthedocs.io/en/latest/usage.html

Example configuration file content for pydocstyle, demonstrating how to disable inheritance and set specific ignore rules.

```ini
[pydocstyle]
inherit = false
ignore = D100,D203,D405
match = *.py
```

--------------------------------

### View pydocstyle CLI help

Source: https://pep257.readthedocs.io/en/latest/usage.html

Displays the command-line interface options and usage instructions.

```text
Usage: pydocstyle [options] [<file|dir>...]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -e, --explain         show explanation of each error
  -s, --source          show source for each error
  -d, --debug           print debug information
  -v, --verbose         print status information
  --count               print total number of errors to stdout
  --select=<codes>      choose the basic list of checked errors by specifying
                        which errors to check for (with a list of comma-
                        separated error codes). for example:
                        --select=D101,D202
  --ignore=<codes>      choose the basic list of checked errors by specifying
                        which errors to ignore (with a list of comma-separated
                        error codes). for example: --ignore=D101,D202
  --convention=<name>   choose the basic list of checked errors by specifying
                        an existing convention. Possible conventions: pep257
  --add-select=<codes>  amend the list of errors to check for by specifying
                        more error codes to check.
  --add-ignore=<codes>  amend the list of errors to check for by specifying
                        more error codes to ignore.
  --match=<pattern>     check only files that exactly match <pattern> regular
                        expression; default is --match='(?!test_).*\.py' which
                        matches files that don't start with 'test_' but end
                        with '.py'
  --match-dir=<pattern>
                        search only dirs that exactly match <pattern> regular
                        expression; default is --match-dir='[^\.].*', which
                        matches all dirs that don't start with a dot
```

--------------------------------

### Run pydocstyle on a Python file

Source: https://pep257.readthedocs.io/en/latest/index.html

Execute pydocstyle on a Python file to check for docstring compliance. The output indicates missing docstrings and their locations.

```bash
$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:22 in public method `method`:
        D102: Docstring missing
...
```
Tokens:
Raw