Get the global InteractiveShell instance. Returns None if no InteractiveShell instance is registered.

Run a complete IPython cell. Parameters ---------- raw_cell : str The code (including IPython code such as %magic f

Return a format data dict for an object. By default all format types will be computed. The following MIME types are usually implemen

Print information about the magic function system. Supported formats: -latex, -brief, -rest

Pop a formatter for the given type. Parameters ---------- typ : type or '__module__.__name__' string for a type defau

DEPRECATED: Write a string to the default output

Close the file and restore the channel.

Pretty print the given object.

Write data to both channels.

like begin_group / end_group but for the with statement.

Return the next possible completion for 'text'. This is called successively with state == 0, 1, 2, ... until it returns None. The co

Parse options passed to an argument string. The interface is similar to that of :func:`getopt.getopt`, but it returns a :class:`~IPyt

Make a valid python temp file.

Return a copy as a Struct. Examples -------- >>> s = Struct(a=10,b=30) >>> s2 = s.copy() >>> type(s2) is Str

Register a new event callback. Parameters ---------- event : str The event for which to register this callb

Add a func to the cmd chain with given priority

DEPRECATED. Compute a dict with detailed information about an object.

sort by specified fields (see fields()) Example:: a.sort(1, nums = True) Sorts a by second field, in numerical order (

Display the exception that just occurred. If nothing is known about the exception, this is the method which should be used throughout

Add literal text to the output.

Equivalent of textwrap.dedent that ignores unindented first line. This means it will still dedent strings like: '''foo is a bar '''

Execute the given cell magic. Parameters ---------- magic_name : str Name of the desired magic function, without '%

Execute the given line magic. Parameters ---------- magic_name : str Name of the desired magic function, without '%

Search the database using unix glob-style matching (wildcards * and ?). Parameters ---------- pattern : str

Find the first help command (foo?) in the cell.

Return whether a block of interactive input can accept more input. This method is meant to be used by line-oriented frontends, who need to

Execute a command in a subshell. Parameters ---------- cmd : str A command to be executed in the system shell.

Display a Python object in all frontends. By default all representations will be computed and sent to the frontends. Frontends can decide whi

Add a format function for a given type. Parameters ---------- typ : type or '__module__.__name__' string for a type

Generic interface to the inspector system. This function is meant to be called by pdef, pdoc & friends.

Flush both channels.

Import and return ``bar`` given the string ``foo.bar``. Calling ``bar = import_item("foo.bar")`` is the functional equivalent of executing th

Pretty print the object and display it through a pager. %page [options] OBJECT If no object is given, use _ (last output).

Transform an input cell before parsing it. Static transformations, implemented in IPython.core.inputtransformer2, deal with things li

internal implementation of all display_foo methods Parameters ---------- mimetype : str The mimetype to be published (e.g. 'image

Find and return a line magic by name. Returns None if the magic isn't found.

Get a handler by its name.

Installs the editor that is called by IPython for the %edit magic. This overrides the default editor, which is generally set by your EDITOR e

Look up the registered formatter for a type. Parameters ---------- typ : type or '__module__.__name__' string for a type

Split a string into an argument list and parse that argument list.

This context manager has to be used in any place where unstable completer behavior and API may be called. >>> with provisionalcomplete

Move the current seek pointer to the given block. You can use negative indices to seek from the end, with identical semantics to thos

Return formatted traceback. Subclasses may override this if they add extra arguments.

Find an object in the available namespaces. self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic Has special code to detec

Add a breakable separator to the output. This does not mean that it will automatically break here. If no breaking on this position

clock() -> floating point number Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of the process. This is done via

Activate the interactive debugger. This magic command support two ways of activating debugger. One is to activate debugger before exe

Raise a catchable error instead of exiting.

Execute a normal python statement in user namespace.

Call callbacks for ``event``. Any additional arguments are passed to all callbacks registered for this event. Exceptions rais

Returns an iterator over the possible completions .. warning:: Unstable This function is unstable, API may change witho

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

Complete files that end in .py or .ipy or .ipynb for the %run command.

Add a new background job and start it in a separate thread. There are two types of jobs which can be created: 1. Jobs based on expre

Parse the string of arguments for the given magic function.

Paste input text, by default in quiet mode

set_custom_exc(exc_tuple, handler) Set a custom exception handler, which will be called if any of the exceptions in exc_tuple occur i

Switch to the desired mode. If mode is not specified, cycles through the available modes.

Split a command line's arguments in a shell-like manner. This is a special version for windows that use a ctypes call to CommandLineToArgvW

Define a new alias after validating it. This will raise an :exc:`AliasError` if there are validation problems.

Flush data that is left in the buffer.

Get the base directory where IPython itself is installed.

Look up the formatter for a given instance. Parameters ---------- obj : object instance Returns ---

Push one or more lines of input. This stores the given lines and returns a status code indicating whether the code forms a complete P

Recursively reload all modules used in the given module. Optionally takes a list of modules to exclude from reloading. The default exclude l

DEPRECATED since IPython 5.0 Set PyOS_InputHook to callback and return the previous one.

Return a color formatted string with the traceback info. Parameters ---------- etype : exception type Type of the e

Remove a callback from the given event.

Expand python variables in a string. The depth argument indicates how many frames above the caller should be walked to look for the l

Update the status of the job lists. This method moves finished jobs to one of two lists: - self.completed: jobs which completed suc

Begin a group. The first parameter specifies the indentation for the next line (usually the width of the opening text), the s

dir2(obj) -> list of strings Extended version of the Python builtin dir(), which does a few extra checks. This version is guaranteed to

Enable interactive matplotlib and inline figure support. This takes the following steps: 1. select the appropriate e

End a group. See `begin_group` for more details.

Find absolute path to executable cmd in a cross platform manner. This function tries to determine the full path to a command line program usi

Indent a string a given number of spaces or tabstops. indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. Parameters ---------