The Python docformatter tool (https://github.com/myint/docformatter).
Backend: <span style="color: purple"><code>pants.backend.python.lint.docformatter</code></span> Config section: <span style="color: purple"><code>[docformatter]</code></span>
## Basic options
<div style="color: purple"> <h3><code>skip</code></h3> <code>--[no-]docformatter-skip</code><br> <code>PANTS_DOCFORMATTER_SKIP</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>
<br>
Don't use docformatter when running `./pants fmt` and `./pants lint`.
</div> <br>
<div style="color: purple"> <h3><code>args</code></h3> <code>--docformatter-args="[<shell_str>, <shell_str>, ...]"</code><br> <code>PANTS_DOCFORMATTER_ARGS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Arguments to pass directly to docformatter, e.g. `--docformatter-args='--wrap-summaries=100 --pre-summary-newline'`.
</div> <br>
<div style="color: purple"> <h3><code>export</code></h3> <code>--[no-]docformatter-export</code><br> <code>PANTS_DOCFORMATTER_EXPORT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>True</code></span>
<br>
If true, export a virtual environment with docformatter when running `./pants export`.
This can be useful, for example, with IDE integrations to point your editor to the tool's binary.
</div> <br>
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--docformatter-version=<str></code><br> <code>PANTS_DOCFORMATTER_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>docformatter>=1.4,<1.5</code></span>
<br>
Requirement string for the tool.
</div> <br>
<div style="color: purple"> <h3><code>extra_requirements</code></h3> <code>--docformatter-extra-requirements="['<str>', '<str>', ...]"</code><br> <code>PANTS_DOCFORMATTER_EXTRA_REQUIREMENTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
</div> <br>
<div style="color: purple"> <h3><code>interpreter_constraints</code></h3> <code>--docformatter-interpreter-constraints="['<str>', '<str>', ...]"</code><br> <code>PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "CPython>=3.7,<4" ]</pre></span>
<br>
Python interpreter constraints for this tool.
</div> <br>
<div style="color: purple"> <h3><code>lockfile</code></h3> <code>--docformatter-lockfile=<str></code><br> <code>PANTS_DOCFORMATTER_LOCKFILE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code><default></code></span>
<br>
Path to a lockfile used for installing the tool.
Set to the string `<default>` to use a lockfile provided by Pants, so long as you have not changed the `--version` and `--extra-requirements` options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by `[python].invalid_lockfile_behavior`). See https://github.com/pantsbuild/pants/blob/release_2.12.1/src/python/pants/backend/python/lint/docformatter/docformatter.lock for the default lockfile contents.
Set to the string `<none>` to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.
To use a custom lockfile, set this option to a file path relative to the build root, then run `./pants generate-lockfiles --resolve=docformatter`.
As explained at [Third-party dependencies](🔗), lockfile generation via `generate-lockfiles` does not always work and you may want to manually generate the lockfile. You will want to set `[python].invalid_lockfile_behavior = 'ignore'` so that Pants does not complain about missing lockfile headers.
</div> <br>
<div style="color: purple"> <h3><code>console_script</code></h3> <code>--docformatter-console-script=<str></code><br> <code>PANTS_DOCFORMATTER_CONSOLE_SCRIPT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>docformatter</code></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>entry_point</code></h3> <code>--docformatter-entry-point=<str></code><br> <code>PANTS_DOCFORMATTER_ENTRY_POINT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>
<br>
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.
</div> <br>
## Deprecated options
None