Skip to main content
Version: 2.9 (deprecated)

ipython

The IPython enhanced REPL (https://ipython.org/).

Backend: ``

Config section: [ipython]

Basic options​

None

Advanced options​

console_script​

--ipython-console-script=<str>
PANTS_IPYTHON_CONSOLE_SCRIPT
pants.toml
[ipython]
console_script = <str>
default: ipython

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​

--ipython-entry-point=<str>
PANTS_IPYTHON_ENTRY_POINT
pants.toml
[ipython]
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​

--ipython-extra-requirements="['<str>', '<str>', ...]"
PANTS_IPYTHON_EXTRA_REQUIREMENTS
pants.toml
[ipython]
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.

ignore_cwd​

--[no-]ipython-ignore-cwd
PANTS_IPYTHON_IGNORE_CWD
pants.toml
[ipython]
ignore_cwd = <bool>
default: True

Whether to tell IPython not to put the CWD on the import path.

Normally you want this to be True, so that imports come from the hermetic environment Pants creates.

However IPython<7.13.0 doesn't support this option, so if you're using an earlier version (e.g., because you have Python 2.7 code) then you will need to set this to False, and you may have issues with imports from your CWD shading the hermetic environment.

lockfile​

--ipython-lockfile=<str>
PANTS_IPYTHON_LOCKFILE
pants.toml
[ipython]
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.9.2/src/python/pants/backend/python/subsystems/ipython_lockfile.txt 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=ipython.

Lockfile generation currently does not wire up the [python-repos] options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or pip freeze. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set [python].invalid_lockfile_behavior = 'ignore'.

version​

--ipython-version=<str>
PANTS_IPYTHON_VERSION
pants.toml
[ipython]
version = <str>
default: ipython==7.16.1

Requirement string for the tool.

Deprecated options​

None

None