Skip to main content
Version: 2.16 (deprecated)

docformatter

The Python docformatter tool (https://github.com/myint/docformatter).

Backend: pants.backend.python.lint.docformatter

Config section: [docformatter]

Basic options​

args​

--docformatter-args="[<shell_str>, <shell_str>, ...]"
PANTS_DOCFORMATTER_ARGS
pants.toml
[docformatter]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to docformatter, e.g. --docformatter-args='--wrap-summaries=100 --pre-summary-newline'.

skip​

--[no-]docformatter-skip
PANTS_DOCFORMATTER_SKIP
pants.toml
[docformatter]
skip = <bool>
default: False

If true, don't use docformatter when running pants fmt and pants lint.

Advanced options​

console_script​

--docformatter-console-script=<str>
PANTS_DOCFORMATTER_CONSOLE_SCRIPT
pants.toml
[docformatter]
console_script = <str>
default: docformatter

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​

--docformatter-entry-point=<str>
PANTS_DOCFORMATTER_ENTRY_POINT
pants.toml
[docformatter]
entry_point = <str>
default: 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​

--docformatter-install-from-resolve=<str>
PANTS_DOCFORMATTER_INSTALL_FROM_RESOLVE
pants.toml
[docformatter]
install_from_resolve = <str>
default: 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/v2.16/docs/python-third-party-dependencies#user-lockfiles.

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.

If unspecified, and the lockfile option is set, the tool will use the custom docformatter "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

interpreter_constraints​

--docformatter-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTS
pants.toml
[docformatter]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

requirements​

--docformatter-requirements="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_REQUIREMENTS
pants.toml
[docformatter]
requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []

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​

export​

--[no-]docformatter-export
PANTS_DOCFORMATTER_EXPORT
pants.toml
[docformatter]
export = <bool>
default: True
Deprecated, will be removed in version: 2.18.0.dev0.
Use the export goal's --resolve option to select tools to export, instead of using this option to exempt a tool from export-by-default.

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.

extra_requirements​

--docformatter-extra-requirements="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_EXTRA_REQUIREMENTS
pants.toml
[docformatter]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []
Deprecated, will be removed in version: 2.18.0.dev1.
Custom tool versions are now installed from named resolves, as described at https://www.pantsbuild.org/v2.16/docs/python-lockfiles.

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.

lockfile​

--docformatter-lockfile=<str>
PANTS_DOCFORMATTER_LOCKFILE
pants.toml
[docformatter]
lockfile = <str>
default: <default>
Deprecated, will be removed in version: 2.18.0.dev0.
Custom tool versions are now installed from named resolves, as described at https://www.pantsbuild.org/v2.16/docs/python-lockfiles.<br /><br />1. If you have an existing resolve that includes the requirements for this tool,<br /> you can set `[docformatter].install_from_resolve = "<resolve name>".<br /> This may be the case if the tool also provides a runtime library, and you want<br /> to specify the version in just one place.<br />2. If not, you can set up a new resolve as described at the link above.<br /><br />Either way, the resolve you choose should provide the requirements currently set by the `version` and `extra-requirements` options for this tool, which you can see by running `pants help-advanced docformatter`.

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.16.1rc4/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 and supply-chain security.

To use a custom lockfile, set this option to a file path relative to the build root, then run pants generate-lockfiles --resolve=docformatter.

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version​

--docformatter-version=<str>
PANTS_DOCFORMATTER_VERSION
pants.toml
[docformatter]
version = <str>
default: docformatter>=1.4,<1.5
Deprecated, will be removed in version: 2.18.0.dev1.
Custom tool versions are now installed from named resolves, as described at https://www.pantsbuild.org/v2.16/docs/python-lockfiles.

Requirement string for the tool.

None