pydocstyle
A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/).
This version of Pants uses pydocstyle
version 6.3.0 by default. Use a dedicated lockfile and the install_from_resolve
option to control this.
Backend: pants.backend.python.lint.pydocstyle
Config section: [pydocstyle]
Basic options
args
--pydocstyle-args="[<shell_str>, <shell_str>, ...]"
PANTS_PYDOCSTYLE_ARGS
[pydocstyle]
args = [
<shell_str>,
<shell_str>,
...,
]
[]
Arguments to pass directly to Pydocstyle, e.g. --pydocstyle-args='--select=D101,D102'
.
skip
--[no-]pydocstyle-skip
PANTS_PYDOCSTYLE_SKIP
[pydocstyle]
skip = <bool>
False
If true, don't use Pydocstyle when running pants lint
.
Advanced options
config
--pydocstyle-config=<file_option>
PANTS_PYDOCSTYLE_CONFIG
[pydocstyle]
config = <file_option>
None
Path to a Pydocstyle config file (http://www.pydocstyle.org/en/stable/usage.html#configuration-files).
config_discovery
--[no-]pydocstyle-config-discovery
PANTS_PYDOCSTYLE_CONFIG_DISCOVERY
[pydocstyle]
config_discovery = <bool>
True
If true, Pants will include any relevant config files during runs (setup.cfg
, tox.ini
, .pydocstyle
, .pydocstyle.ini
, .pydocstylerc
, .pydocstylerc.ini
, and pyproject.toml
) searching for the configuration file in this particular order.
Please note that even though pydocstyle
keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the pants
command).
Use [pydocstyle].config
instead if your config is in a non-standard location.
console_script
--pydocstyle-console-script=<str>
PANTS_PYDOCSTYLE_CONSOLE_SCRIPT
[pydocstyle]
console_script = <str>
pydocstyle
The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point
since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.
entry_point
--pydocstyle-entry-point=<str>
PANTS_PYDOCSTYLE_ENTRY_POINT
[pydocstyle]
entry_point = <str>
None
The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script
(which this option is mutually exclusive with). Usually, you will not want to change this from the default.
install_from_resolve
--pydocstyle-install-from-resolve=<str>
PANTS_PYDOCSTYLE_INSTALL_FROM_RESOLVE
[pydocstyle]
install_from_resolve = <str>
None
If specified, install the tool using the lockfile for this named resolve.
This resolve must be defined in [python].resolves
, as described in https://www.pantsbuild.org/2.22/docs/python/overview/lockfiles#lockfiles-for-tools.
The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements
option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.
If unspecified, and the lockfile
option is unset, the tool will be installed using the default lockfile shipped with Pants, which uses pydocstyle
version 6.3.0.
If unspecified, and the lockfile
option is set, the tool will use the custom pydocstyle
"tool lockfile" generated from the version
and extra_requirements
options. But note that this mechanism is deprecated.
interpreter_constraints
--pydocstyle-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_PYDOCSTYLE_INTERPRETER_CONSTRAINTS
[pydocstyle]
interpreter_constraints = [
'<str>',
'<str>',
...,
]
[ "CPython>=3.7,<4" ]
Python interpreter constraints for this tool.
requirements
--pydocstyle-requirements="['<str>', '<str>', ...]"
PANTS_PYDOCSTYLE_REQUIREMENTS
[pydocstyle]
requirements = [
'<str>',
'<str>',
...,
]
[]
If install_from_resolve
is specified, install these requirements, at the versions provided by the specified resolve's lockfile.
Values can be pip-style requirements (e.g., tool
or tool==1.2.3
or tool>=1.2.3
), or addresses of python_requirement
targets (or targets that generate or depend on python_requirement
targets).
The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.
If unspecified, install the entire lockfile.
Deprecated options
None
Related subsystems
None