isort

skip

--[no-]isort-skip

PANTS_ISORT_SKIP

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

args

--isort-args="[<shell_str>, <shell_str>, ...]"

PANTS_ISORT_ARGS

Arguments to pass directly to isort, e.g. --isort-args='--case-sensitive --trailing-comma'.

version

--isort-version=<str>

PANTS_ISORT_VERSION

Requirement string for the tool.

extra_requirements

--isort-extra-requirements="['<str>', '<str>', ...]"

PANTS_ISORT_EXTRA_REQUIREMENTS

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

--isort-interpreter-constraints="['<str>', '<str>', ...]"

PANTS_ISORT_INTERPRETER_CONSTRAINTS

[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile

--isort-lockfile=<str>

PANTS_ISORT_LOCKFILE

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.15.1rc2/src/python/pants/backend/python/lint/isort/isort.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=isort.

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.

console_script

--isort-console-script=<str>

PANTS_ISORT_CONSOLE_SCRIPT

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

--isort-entry-point=<str>

PANTS_ISORT_ENTRY_POINT

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.

config

--isort-config="[<file_option>, <file_option>, ...]"

PANTS_ISORT_CONFIG

Path to config file understood by isort (https://pycqa.github.io/isort/docs/configuration/config_files/).

Setting this option will disable [isort].config_discovery. Use this option if the config is located in a non-standard location.

If using isort 5+ and you specify only 1 config file, Pants will configure isort's argv to point to your config file.

config_discovery

--[no-]isort-config-discovery

PANTS_ISORT_CONFIG_DISCOVERY

If true, Pants will include any relevant config files during runs (.isort.cfg, pyproject.toml, setup.cfg, tox.ini and .editorconfig).

Use [isort].config instead if your config is in a non-standard location.

export

--[no-]isort-export

PANTS_ISORT_EXPORT

Deprecated, is scheduled to be removed in version: 2.23.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 isort when running pants export.

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