config.api

Module: config.api

Inheritance diagram for IPython.config.api:

This is the official entry point to IPython’s configuration system.

ConfigObjManager

class IPython.config.api.ConfigObjManager(configObj, filename)

Bases: object

__init__(configObj, filename)
get_config_obj()
resolve_file_path(filename, ipythondir=None)

Resolve filenames into absolute paths.

This function looks in the following directories in order:

  1. In the current working directory or by absolute path with ~ expanded
  2. In ipythondir if that is set
  3. In the IPYTHONDIR environment variable if it exists
  4. In the ~/.ipython directory
Note: The IPYTHONDIR is also used by the trunk version of IPython so
changing it will also affect it was well.
update_config_obj(newConfig)
update_config_obj_from_default_file(ipythondir=None)
update_config_obj_from_file(filename)
write_config_obj_to_file(filename)
write_default_config_file()