Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

Module: paths

Find files and directories which IPython uses.

5 Functions

IPython.paths.get_ipython_dir() → str

Get the IPython directory for this platform and user.

This uses the logic in get_home_dir to find the home directory and then adds .ipython to the end of the path.

IPython.paths.get_ipython_cache_dir() → str

Get the cache directory it is created if it does not exist.

IPython.paths.get_ipython_package_dir() → str

Get the base directory where IPython itself is installed.

IPython.paths.get_ipython_module_path(module_str)

Find the path to an IPython module in this version of IPython.

This will always find the version of the module that is in this importable IPython package. This will always return the path to the .py version of the module.

IPython.paths.locate_profile(profile='default')

Find the path to the folder associated with a given profile.

I.e. find $IPYTHONDIR/profile_whatever.