ipython¶
The IPython enhanced REPL (https://ipython.org/).
Backend: pants.backend.python
Config section: [ipython]
Basic options¶
None
Advanced options¶
install_from_resolve¶
--ipython-install-from-resolve=<str>
PANTS_IPYTHON_INSTALL_FROM_RESOLVE
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.18/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 ipython "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.
requirements¶
--ipython-requirements="['<str>', '<str>', ...]"
PANTS_IPYTHON_REQUIREMENTS
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.
console_script¶
--ipython-console-script=<str>
PANTS_IPYTHON_CONSOLE_SCRIPT
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
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.
ignore_cwd¶
--[no-]ipython-ignore-cwd
PANTS_IPYTHON_IGNORE_CWD
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.
Deprecated options¶
None