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: core.profileapp

An application for managing IPython profiles.

To be invoked as the ipython profile subcommand.

Authors:

  • Min RK

4 Classes

class IPython.core.profileapp.ProfileLocate(**kwargs: Any)

Bases: BaseIPythonApplication

parse_command_line(argv=None)

Parse the command line arguments.

start()

Start the app mainloop.

Override in subclasses.

class IPython.core.profileapp.ProfileList(**kwargs: Any)

Bases: Application

ipython_dir

The name of the IPython directory. This directory is used for logging configuration (through profiles), history storage, etc. The default is usually $HOME/.ipython. This options can also be specified through the environment variable IPYTHONDIR.

start()

Start the app mainloop.

Override in subclasses.

class IPython.core.profileapp.ProfileCreate(**kwargs: Any)

Bases: BaseIPythonApplication

init_config_files()

[optionally] copy default config files into profile dir.

parallel

whether to include parallel computing config files

parse_command_line(argv)

Parse the command line arguments.

stage_default_config_file()

auto generate default config file, and stage it into the profile.

class IPython.core.profileapp.ProfileApp(**kwargs: Any)

Bases: Application

start()

Start the app mainloop.

Override in subclasses.

2 Functions

IPython.core.profileapp.list_profiles_in(path)

list profiles in a given root directory

IPython.core.profileapp.list_bundled_profiles()

list profiles that are bundled with IPython.