Skip to main content
Version: 2.14 (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'.

export​

--[no-]docformatter-export
PANTS_DOCFORMATTER_EXPORT
pants.toml
[docformatter]
export = <bool>
default: True

If true, export a virtual environment with docformatter when running /home/josh/work/scie-pants/dist/pants export.

This can be useful, for example, with IDE integrations to point your editor to the tool's binary.

skip​

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

If true, don't use docformatter when running /home/josh/work/scie-pants/dist/pants fmt and /home/josh/work/scie-pants/dist/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.

extra_requirements​

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

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.

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.

lockfile​

--docformatter-lockfile=<str>
PANTS_DOCFORMATTER_LOCKFILE
pants.toml
[docformatter]
lockfile = <str>
default: <default>

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.14.2/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 /home/josh/work/scie-pants/dist/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

Requirement string for the tool.

Deprecated options​

None

None