ipython API reference

315 public APIs from ipython (ipython/ipython) — 103 classes, 115 functions, 97 methods. Signatures extracted by static analysis of the actual source.

Repository: ipython/ipython

Kind	Count
Classes	103
Functions	115
Methods	97

API list

classIPython.core.alias.Alias

Callable object storing the details of one alias.

funcIPython.core.alias.default_aliases() -> list[tuple[str, str]]

Return list of shell aliases to auto-define.

classIPython.core.autocall.ZMQExitAutocall

Exit IPython.

funcIPython.core.compilerop.code_name(code:str, number:int=0) -> str

Compute a (probably) unique name for code for caching.

classIPython.core.completer.Completion

Completion object used and returned by IPython completers.

methodIPython.core.completer.IPCompleter.all_completions(text:str) -> list[str]

Wrapper around the completion methods for the benefit of emacs.

methodIPython.core.completer.IPCompleter.completions(text:str, offset:int) -> Iterator[Completion]

Returns an iterator over the possible completions ..

methodIPython.core.completer.IPCompleter.custom_completer_matcher(context:CompletionContext) -> SimpleMatcherResult

Dispatch custom completer.

methodIPython.core.completer.IPCompleter.dict_key_matcher(context:CompletionContext) -> SimpleMatcherResult

Match string keys in a dictionary, after e.g.

methodIPython.core.completer.IPCompleter.dict_key_matches(text:str) -> list[str]

Match string keys in a dictionary, after e.g.

methodIPython.core.completer.IPCompleter.dispatch_custom_completer(text:str) -> list[str] | None

methodIPython.core.completer.IPCompleter.file_matcher(context:CompletionContext) -> SimpleMatcherResult

Match filenames, expanding ~USER type strings.

methodIPython.core.completer.IPCompleter.latex_matches(text:str) -> tuple[str, Sequence[str]]

Match Latex syntax for unicode characters.

methodIPython.core.completer.IPCompleter.latex_name_matcher(context:CompletionContext) -> SimpleMatcherResult

Match Latex syntax for unicode characters.

methodIPython.core.completer.IPCompleter.magic_color_matcher(context:CompletionContext) -> SimpleMatcherResult

Match color schemes for %colors magic.

methodIPython.core.completer.IPCompleter.magic_config_matcher(context:CompletionContext) -> SimpleMatcherResult

Match class names and attributes for %config magic.

methodIPython.core.completer.IPCompleter.magic_config_matches(text:str) -> list[str]

Match class names and attributes for %config magic.

methodIPython.core.completer.IPCompleter.magic_matcher(context:CompletionContext) -> SimpleMatcherResult

Match magics.

methodIPython.core.completer.IPCompleter.matchers() -> list[Matcher]

All active matcher routines for completion

methodIPython.core.completer.IPCompleter.python_func_kw_matches(text:str) -> list[str]

Match named parameters (kwargs) of the last open function.

methodIPython.core.completer.IPCompleter.python_matcher(context:CompletionContext) -> SimpleMatcherResult

Match attributes or global python names

classIPython.core.completer.MatcherAPIv2

Protocol describing Matcher API v2.

classIPython.core.completer.SimpleMatcherResult

Result of new-style completion matcher.

func

IPython.core.completer.completion_matcher(*priority:float | None=None, *identifier:str | None=None, *api_version:int=1) -> Callable[[Matcher], Matcher]

Adds attributes describing the matcher.

funcIPython.core.completer.compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str

Does the opposite of expand_user, with its outputs.

funcIPython.core.completer.expand_user(path:str) -> tuple[str, bool, str]

Expand ``~``-style usernames in strings.

funcIPython.core.completer.get__all__entries(obj:Any) -> list[str]

returns the strings in the __all__ attribute

funcIPython.core.completer.has_any_completions(result:MatcherResult) -> bool

Check if any result includes any completions.

funcIPython.core.completer.has_open_quotes(s:str) -> str | bool

Return whether a string has open quotes.

funcIPython.core.completer.protect_filename(s:str, protectables:str=PROTECTABLES) -> str

Escape a string to protect certain characters.

funcIPython.core.completerlib.reset_completer(self, event)

A completer for %reset magic

classIPython.core.crashhandler.CrashHandler

Customizable crash handlers for IPython applications.

methodIPython.core.crashhandler.CrashHandler.make_report(traceback:str) -> str

Return a string containing a crash report.

classIPython.core.debugger.Pdb

Modified Pdb class, does not load readline.

methodIPython.core.debugger.Pdb.do_pdoc(arg)

Print the docstring for an object.

methodIPython.core.debugger.Pdb.format_stack_entry(frame_lineno:tuple[FrameType, int], lprefix:str=': ') -> str

overwrite from super class so must -> str

methodIPython.core.debugger.Pdb.print_stack_entry(frame_lineno:tuple[FrameType, int], prompt_prefix:str='\n-> ') -> None

Overwrite print_stack_entry from superclass (PDB)

funcIPython.core.debugger.set_trace(frame=None, header=None)

Start debugging from `frame`.

classIPython.core.display.DisplayObject

An object that wraps data to be displayed.

methodIPython.core.display.DisplayObject.reload()

Reload the raw data from file or URL.

methodIPython.core.display.Image.reload()

Reload the raw data from file or URL.

classIPython.core.display.ProgressBar

Progressbar supports displaying a progressbar like element

classIPython.core.display.SVG

Embed an SVG into the display.

classIPython.core.display.TextDisplayObject

Create a text display object given raw data.

classIPython.core.display_trap.DisplayTrap

Object to manage sys.displayhook.

methodIPython.core.display_trap.DisplayTrap.set()

Set the hook.

methodIPython.core.display_trap.DisplayTrap.unset()

Unset the hook.

classIPython.core.displayhook.DisplayHook

The custom IPython displayhook to replace sys.displayhook.

methodIPython.core.displayhook.DisplayHook.log_output(format_dict)

Log the output.

methodIPython.core.displayhook.DisplayHook.write_format_data(format_dict, md_dict=None) -> None

Write the format data dict to the frontend.

methodIPython.core.displayhook.DisplayHook.write_output_prompt()

Write the output prompt.

classIPython.core.displaypub.CapturingDisplayPublisher

A DisplayPublisher that stores

classIPython.core.displaypub.DisplayPublisher

A traited class that publishes display data to frontends.

classIPython.core.error.InputRejected

Input rejected by ast transformer.

classIPython.core.error.TryNext

Try next hook exception.

classIPython.core.error.UsageError

Error in magic function arguments, etc.

methodIPython.core.events.EventManager.register(event:str, function:Callable[..., Any]) -> None

methodIPython.core.events.EventManager.trigger(event:str, *args:Any, **kwargs:Any) -> None

Call callbacks for ``event``.

methodIPython.core.events.EventManager.unregister(event:str, function:Callable[..., Any]) -> None

Remove a callback from the given event.

funcIPython.core.events.post_run_cell(result:ExecutionResult) -> None

Fires after user-entered code runs.

funcIPython.core.events.pre_run_cell(info:ExecutionInfo) -> None

Fires before user-entered code runs.

classIPython.core.extensions.ExtensionManager

A class to manage IPython extensions.

classIPython.core.formatters.BaseFormatter

A base formatter class that is configurable.

methodIPython.core.formatters.BaseFormatter.lookup(obj)

Look up the formatter for a given instance.

methodIPython.core.formatters.BaseFormatter.lookup_by_type(typ)

Look up the registered formatter for a type.

methodIPython.core.formatters.BaseFormatter.pop(typ, default=_raise_key_error)

Pop a formatter for the given type.

classIPython.core.formatters.FormatterABC

Abstract base class for Formatters.

classIPython.core.formatters.FormatterWarning

Warning class for errors in formatters

classIPython.core.formatters.HTMLFormatter

An HTML formatter.

classIPython.core.formatters.JPEGFormatter

A JPEG formatter.

classIPython.core.formatters.JSONFormatter

A JSON string formatter.

classIPython.core.formatters.JavascriptFormatter

A Javascript formatter.

classIPython.core.formatters.LatexFormatter

A LaTeX formatter.

classIPython.core.formatters.MarkdownFormatter

A Markdown formatter.

classIPython.core.formatters.MimeBundleFormatter

A Formatter for arbitrary mime-types.

classIPython.core.formatters.PDFFormatter

A PDF formatter.

classIPython.core.formatters.PNGFormatter

A PNG formatter.

classIPython.core.formatters.PlainTextFormatter

The default pretty-printer.

classIPython.core.formatters.SVGFormatter

An SVG formatter.

funcIPython.core.formatters.catch_format_error(method)

show traceback on failed format call

funcIPython.core.getipython.get_ipython() -> 'InteractiveShell | None'

Get the global InteractiveShell instance.

classIPython.core.guarded_eval.EvaluationPolicy

Definition of evaluation policy.

classIPython.core.guarded_eval.GuardRejection

Exception raised when guard rejects evaluation attempt.

funcIPython.core.guarded_eval.eval_node(node:ast.AST | None, context:EvaluationContext)

Evaluate AST node in provided context.

funcIPython.core.guarded_eval.guarded_eval(code:str, context:EvaluationContext)

Evaluate provided code in the evaluation context.

classIPython.core.history.DummyDB

Dummy DB that will act as a black hole for history.

classIPython.core.history.HistoryAccessor

Access the history database without adding to it.

methodIPython.core.history.HistoryAccessor.close() -> None

Close the SQLite database connection.

methodIPython.core.history.HistoryAccessor.get_last_session_id() -> int | None

Get the last session ID currently in the database.

method

IPython.core.history.HistoryAccessor.get_range(session:int, start:int=1, stop:int | None=None, raw:bool=True, output:bool=False) -> Iterable[tuple[int, int, InOrInOut]]

Retrieve input by session.

method

IPython.core.history.HistoryAccessor.get_session_info(session:int) -> tuple[int, datetime.datetime, datetime.datetime | None, int | None, str]

Get info about a session.

methodIPython.core.history.HistoryAccessor.init_db() -> None

Connect to the database, and create tables if necessary.

classIPython.core.history.HistoryAccessorBase

An abstract class for History Accessors

funcIPython.core.history.only_when_enabled(f:t.Callable[_P, _R]) -> t.Callable[_P, _R]

Decorator: return an empty list in the absence of sqlite.

funcIPython.core.hooks.clipboard_get(self)

Get text from the clipboard.

funcIPython.core.hooks.show_in_pager(self, data, start, screen_lines)

Run a string through pager

classIPython.core.inputtransformer2.EscapedCommand

Transformer for escaped commands like %foo, !foo, or /foo

classIPython.core.inputtransformer2.HelpEnd

Transformer for help syntax: obj?

classIPython.core.inputtransformer2.MagicAssign

Transformer for assignments from magics (a = %foo)

classIPython.core.inputtransformer2.PromptStripper

Remove matching input prompts from a block of input.

classIPython.core.inputtransformer2.TokenTransformBase

Base class for transformations which examine tokens.

classIPython.core.inputtransformer2.TransformerManager

Applies various transformations to a cell or code block.

methodIPython.core.inputtransformer2.TransformerManager.transform_cell(cell:str) -> str

Transforms a cell of input code

funcIPython.core.inputtransformer2.leading_indent(lines)

Remove leading indentation.

classIPython.core.interactiveshell.InteractiveShell

An enhanced, interactive shell for Python.

methodIPython.core.interactiveshell.InteractiveShell.debugger(force=False)

Call the pdb debugger.

methodIPython.core.interactiveshell.InteractiveShell.run_code(code_obj, result=None, *async_=False)

Execute a code object.

methodIPython.core.interactiveshell.InteractiveShell.run_line_magic(magic_name:str, line:str, _stack_depth=1)

Execute the given line magic.

methodIPython.core.interactiveshell.InteractiveShell.set_autoindent(value=None)

Set the autoindent flag.

methodIPython.core.interactiveshell.InteractiveShell.set_custom_completer(completer, pos=0) -> None

Adds a new custom completer function.

methodIPython.core.interactiveshell.InteractiveShell.show_usage()

Show a usage message

classIPython.core.interactiveshell.InteractiveShellABC

An abstract base class for InteractiveShell.

classIPython.core.interactiveshell.ProvisionalWarning

Warning class for unstable features

classIPython.core.logger.Logger

A Logfile class with different policies for file creation

methodIPython.core.logger.Logger.log(line_mod:str, line_ori:str) -> None

Write the sources to a log.

methodIPython.core.logger.Logger.log_write(data:str, kind:str='input') -> None

Write data to the log file, if active

methodIPython.core.logger.Logger.logstate() -> None

Print a status message about the logger.

methodIPython.core.logger.Logger.logstop() -> None

Fully stop logging and close log file.

methodIPython.core.logger.Logger.switch_log(val:bool) -> None

Switch logging on/off.

classIPython.core.macro.Macro

Simple class to store the value of macros as strings.

classIPython.core.magic.MagicAlias

An alias to another magic function.

classIPython.core.magic.Magics

Base class for implementing magic functions.

methodIPython.core.magic.Magics.arg_err(func:Callable[..., Any]) -> None

Print docstring if incorrect arguments were passed

methodIPython.core.magic.Magics.format_latex(strng:str) -> str

Format a string for latex inclusion.

methodIPython.core.magic.Magics.parse_options(arg_str:str, opt_str:str, *long_opts:str, **kw:Any) -> tuple[Any, Any]

Parse options passed to an argument string.

methodIPython.core.magic.MagicsManager.auto_status() -> str

Return descriptive string with automagic status.

methodIPython.core.magic.MagicsManager.lsmagic() -> dict[str, dict[str, Any]]

Return a dict of currently available magic functions.

methodIPython.core.magic.MagicsManager.lsmagic_docs(brief:bool=False, missing:str='') -> dict[str, dict[str, str]]

Return dict of documentation of magic functions.

methodIPython.core.magic.MagicsManager.register(*magic_objects:type[Magics] | Magics) -> None

method

IPython.core.magic.MagicsManager.register_alias(alias_name:str, magic_name:str, magic_kind:_MagicKind='line', magic_params:str | None=None) -> None

methodIPython.core.magic.MagicsManager.register_lazy(name:str, fully_qualified_name:str) -> None

Lazily register a magic via an extension.

funcIPython.core.magic.compress_dhist(dh:list[str]) -> list[str]

Compress a directory history into a new one with at most 20 entries.

funcIPython.core.magic.magics_class(cls:_T) -> _T

Class decorator for all subclasses of the main Magics class.

funcIPython.core.magic.needs_local_scope(func:_F) -> _F

Decorator to mark magic functions which need to local scope to run.

funcIPython.core.magic.output_can_be_silenced(magic_func:_F) -> _F

Mark a magic function so its output may be silenced.

funcIPython.core.magic.validate_type(magic_kind:str) -> None

Ensure that the given magic_kind is valid.

classIPython.core.magic_arguments.ArgMethodWrapper

Base class to define a wrapper for ArgumentParser method.

classIPython.core.magic_arguments.MagicArgumentParser

An ArgumentParser tweaked for use by IPython magics.

classIPython.core.magic_arguments.argument

Store arguments and keywords to pass to add_argument().

classIPython.core.magic_arguments.defaults

Store arguments and keywords to pass to set_defaults().

classIPython.core.magic_arguments.kwds

Provide other keywords to the sub-parser constructor.

funcIPython.core.magic_arguments.real_name(magic_func)

Find the real name of the magic.

classIPython.core.magics.UserMagics

Placeholder for user-defined magics to be added at runtime.

classIPython.core.magics.auto.AutoMagics

Magics that control various autoX behaviors.

classIPython.core.magics.basic.BasicMagics

Magics that provide central IPython functionality.

methodIPython.core.magics.basic.BasicMagics.doctest_mode(parameter_s='')

Toggle doctest mode on and off.

methodIPython.core.magics.basic.BasicMagics.pprint(parameter_s='')

Toggle pretty printing on/off.

methodIPython.core.magics.basic.BasicMagics.quickref(arg)

Show a quick reference sheet

classIPython.core.magics.execution.TimeitTemplateFiller

Fill in the AST template for timing execution.

methodIPython.core.magics.execution.TimeitTemplateFiller.visit_FunctionDef(node)

Fill in the setup statement

classIPython.core.magics.extension.ExtensionMagics

Magics to manage the IPython extensions system.

classIPython.core.magics.logging.LoggingMagics

Magics related to all logging machinery.

methodIPython.core.magics.logging.LoggingMagics.logoff(parameter_s='')

Temporarily stop logging.

methodIPython.core.magics.logging.LoggingMagics.logon(parameter_s='')

Restart logging.

classIPython.core.magics.namespace.NamespaceMagics

Magics to manage various aspects of the user's namespace.

classIPython.core.magics.packaging.PackagingMagics

Magics related to packaging & installation

classIPython.core.magics.pylab.PylabMagics

Magics related to matplotlib's pylab support

funcIPython.core.magics.script.script_args(f)

single decorator for adding script args

methodIPython.core.oinspect.Inspector.psource(obj, oname='')

Print the source code for an object.

classIPython.core.oinspect.InspectorHookData

Data passed to the mime hook

funcIPython.core.oinspect.getdoc(obj) -> str | None

Stable wrapper around inspect.getdoc.

funcIPython.core.oinspect.getsource(obj, oname='') -> str | None

Wrapper around inspect.getsource.

funcIPython.core.oinspect.is_simple_callable(obj)

True if obj is a function ()

func

IPython.core.oinspect.object_info(*name:str, *found:bool, *isclass:bool=False, *isalias:bool=False, *ismagic:bool=False, **kw) -> InfoDict

Make an object info dict with all fields present.

funcIPython.core.page.display_page(strng, start=0, screen_lines=25)

Just display, no paging.

funcIPython.core.page.get_pager_cmd(pager_cmd=None)

Return a pager command.

classIPython.core.prefilter.PrefilterChecker

Inspect an input line and return a handler for that line.

classIPython.core.prefilter.PrefilterManager

Main prefilter component.

methodIPython.core.prefilter.PrefilterManager.get_handler_by_name(name)

Get a handler by its name.

methodIPython.core.prefilter.PrefilterManager.handlers()

Return a dict of all the handlers.

methodIPython.core.prefilter.PrefilterManager.init_checkers()

Create the default checkers.

methodIPython.core.prefilter.PrefilterManager.init_handlers()

Create the default handlers.

methodIPython.core.prefilter.PrefilterManager.register_checker(checker)

methodIPython.core.prefilter.PrefilterManager.sort_checkers()

Sort the checkers by priority.

methodIPython.core.prefilter.PrefilterManager.sort_transformers()

Sort the transformers by priority.

methodIPython.core.prefilter.PrefilterManager.unregister_checker(checker)

Unregister a checker instance.

classIPython.core.prefilter.PrefilterTransformer

Transform a line of user input.

classIPython.core.profiledir.ProfileDir

An object to manage the profile directory and its resources.

classIPython.core.splitinput.LineInfo

A single line of input and associated info.

classIPython.core.tbtools.TBTools

Basic tools used by all traceback printer classes.

methodIPython.core.tbtools.TBTools.set_colors(name:str) -> None

Shorthand access to the color table scheme selector method.

methodIPython.core.tbtools.TBTools.stb2text(stb:list[str]) -> str

Convert a structured traceback (a list) to a string.

method

IPython.core.tbtools.TBTools.structured_traceback(etype:type, evalue:BaseException | None, etb:TracebackType | None=None, tb_offset:int | None=None, context:int=5) -> list[str]

Return a list of traceback frames.

method

IPython.core.tbtools.TBTools.text(etype:type, value:BaseException | None, tb:TracebackType | None, tb_offset:int | None=None, context:int=5) -> str

Return formatted traceback.

funcIPython.core.tbtools.text_repr(value:Any) -> str

Hopefully pretty robust repr equivalent.

classIPython.core.ultratb.AutoFormattedTB

A traceback printer which can be called on the fly.

classIPython.core.ultratb.ColorTB

Deprecated since IPython 9.0.

classIPython.core.ultratb.FormattedTB

Subclass ListTB but allow calling with a traceback.

methodIPython.core.ultratb.FormattedTB.set_mode(mode:str | None=None) -> None

Switch to the desired mode.

methodIPython.core.ultratb.FormattedTB.stb2text(stb:list[str]) -> str

Convert a structured traceback (a list) to a string.

classIPython.core.ultratb.SyntaxTB

Extension which holds some state: the last exception value

methodIPython.core.ultratb.SyntaxTB.clear_err_state() -> Any | None

Return the current error state and clear it

methodIPython.core.ultratb.SyntaxTB.stb2text(stb:list[str]) -> str

Convert a structured traceback (a list) to a string.

funcIPython.extensions.autoreload.load_ipython_extension(ip)

Load the extension in IPython.

classIPython.extensions.deduperreload.deduperreload.DependencyNode

Each node represents a function.

classIPython.extensions.storemagic.StoreMagics

Lightweight persistence for python variables.

funcIPython.extensions.storemagic.load_ipython_extension(ip)

Load the extension in IPython.

classIPython.lib.backgroundjobs.BackgroundJobBase

Base class to build BackgroundJob classes.

classIPython.lib.backgroundjobs.BackgroundJobManager

Class to manage a pool of backgrounded threaded jobs.

funcIPython.lib.clipboard.osx_clipboard_get() -> str

Get the clipboard's text on OS X.

funcIPython.lib.deepreload.add_submodule(mod, submod, fullname, subname)

mod.{subname} = submod

funcIPython.lib.deepreload.deep_reload_hook(m)

Replacement for reload().

classIPython.lib.demo.ClearMixin

Use this mixin to make Demo classes with less visual clutter.

classIPython.lib.demo.LineDemo

Demo where each line is executed as a separate block.

classIPython.lib.display.Audio

Create an audio object.

methodIPython.lib.display.Audio.reload()

Reload the raw data from file or URL.

classIPython.lib.display.Code

Display syntax-highlighted source code.

classIPython.lib.display.IFrame

Generic class to embed an iframe in an IPython notebook

funcIPython.lib.editorhooks.jed(exe='jed')

JED, the lightweight emacsish editor

funcIPython.lib.editorhooks.komodo(exe='komodo')

Activestate Komodo [Edit]

funcIPython.lib.editorhooks.mate(exe='mate')

TextMate, the missing editor

funcIPython.lib.editorhooks.scite(exe='scite')

SciTE or Sc1

funcIPython.lib.guisupport.is_event_loop_running_qt4(app=None)

Is the qt event loop running.

funcIPython.lib.guisupport.is_event_loop_running_wx(app=None)

Is the wx event loop running.

classIPython.lib.latextools.LaTeXTool

An object to store configuration of the LaTeX tool.

funcIPython.lib.latextools.latex_to_png(s:str, encode=False, backend=None, wrap=False, color='Black', scale=1.0)

Render a LaTeX string to PNG.

methodIPython.lib.pretty.PrettyPrinter.begin_group(indent=0, open='')

Begin a group.

methodIPython.lib.pretty.PrettyPrinter.end_group(dedent=0, close='')

End a group.

methodIPython.lib.pretty.PrettyPrinter.flush()

Flush data that is left in the buffer.

methodIPython.lib.pretty.PrettyPrinter.text(obj)

Add literal text to the output.

classIPython.lib.pretty.RawStringLiteral

Wrapper that shows a string with a `r` prefix

funcIPython.lib.pretty.for_type(typ, func)

Add a pretty printer for a given type.

funcIPython.paths.get_ipython_cache_dir() -> str

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

funcIPython.paths.get_ipython_dir() -> str

Get the IPython directory for this platform and user.

funcIPython.paths.get_ipython_package_dir() -> str

Get the base directory where IPython itself is installed.

funcIPython.paths.locate_profile(profile:str='default') -> str

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

classIPython.sphinxext.ipython_directive.EmbeddedSphinxShell

An embedded IPython instance to run inside Sphinx

classIPython.terminal.debugger.TerminalPdb

Standalone IPython debugger.

funcIPython.terminal.debugger.set_trace(frame=None)

Start debugging from `frame`.

classIPython.terminal.prompts.RichPromptDisplayHook

Subclass of base display hook using coloured prompt

funcIPython.terminal.pt_inputhooks.osx.C(classname)

get an ObjC Class by name

funcIPython.terminal.pt_inputhooks.osx.inputhook(context)

Inputhook for Cocoa (NSApp)

funcIPython.terminal.pt_inputhooks.osx.n(name)

create a selector name (for ObjC methods)

funcIPython.terminal.pt_inputhooks.tk.inputhook(inputhook_context)

Inputhook for Tk.

classIPython.terminal.ptutils.IPythonPTCompleter

Adaptor to provide IPython completions to prompt_toolkit

classIPython.terminal.ptutils.IPythonPTLexer

Wrapper around PythonLexer and BashLexer.

funcIPython.terminal.shortcuts.auto_match.braces(event:KeyPressEvent)

Auto-close braces

funcIPython.terminal.shortcuts.auto_match.brackets(event:KeyPressEvent)

Auto-close brackets

funcIPython.terminal.shortcuts.auto_match.delete_pair(event:KeyPressEvent)

Delete auto-closed parenthesis

funcIPython.terminal.shortcuts.auto_match.docstring_double_quotes(event:KeyPressEvent)

Auto-close docstring (double quotes)

funcIPython.terminal.shortcuts.auto_match.docstring_single_quotes(event:KeyPressEvent)

Auto-close docstring (single quotes)

funcIPython.terminal.shortcuts.auto_match.double_quote(event:KeyPressEvent)

Auto-close double quotes

funcIPython.terminal.shortcuts.auto_match.parenthesis(event:KeyPressEvent)

Auto-close parenthesis

funcIPython.terminal.shortcuts.auto_match.raw_string_braces(event:KeyPressEvent)

Auto-close braces in raw strings

funcIPython.terminal.shortcuts.auto_match.raw_string_bracket(event:KeyPressEvent)

Auto-close bracker in raw strings

funcIPython.terminal.shortcuts.auto_match.raw_string_parenthesis(event:KeyPressEvent)

Auto-close parenthesis in raw strings

funcIPython.terminal.shortcuts.auto_match.single_quote(event:KeyPressEvent)

Auto-close single quotes

funcIPython.terminal.shortcuts.auto_suggest.accept(event:KeyPressEvent)

Accept autosuggestion

funcIPython.terminal.shortcuts.auto_suggest.accept_character(event:KeyPressEvent)

Fill partial autosuggestion by character

funcIPython.terminal.shortcuts.auto_suggest.accept_token(event:KeyPressEvent)

Fill partial autosuggestion by token

funcIPython.terminal.shortcuts.auto_suggest.accept_word(event:KeyPressEvent)

Fill partial autosuggestion by word

funcIPython.terminal.shortcuts.auto_suggest.discard(event:KeyPressEvent)

Discard autosuggestion

funcIPython.terminal.shortcuts.auto_suggest.down_and_update_hint(event:KeyPressEvent)

Go down and update hint

funcIPython.terminal.shortcuts.auto_suggest.resume_hinting(event:KeyPressEvent)

Resume autosuggestions

funcIPython.terminal.shortcuts.auto_suggest.swap_autosuggestion_up(event:KeyPressEvent)

Get next autosuggestion from history.

funcIPython.terminal.shortcuts.auto_suggest.up_and_update_hint(event:KeyPressEvent)

Go up and update hint

funcIPython.terminal.shortcuts.dismiss_completion(event)

Dismiss completion

funcIPython.terminal.shortcuts.indent_buffer(event)

Indent buffer

funcIPython.terminal.shortcuts.reformat_and_execute(event)

Reformat code and execute it

funcIPython.terminal.shortcuts.reset_buffer(event)

Reset buffer

funcIPython.terminal.shortcuts.reset_search_buffer(event)

Reset search buffer

funcIPython.terminal.shortcuts.suspend_to_bg(event)

Suspend to background

classIPython.utils.PyColorize.Parser

Format colored Python source.

methodIPython.utils.PyColorize.Parser.format2(raw:str, out:Any=None) -> tuple[str | None, bool]

Parse and send the colored source.

methodIPython.utils.PyColorize.Theme.make_arrow(width:int) -> str

generate the leading arrow in front of traceback or debugger

funcIPython.utils._process_common.arg_split(commandline:str, posix:bool=False, strict:bool=True) -> list[str]

Split a command line's arguments in a shell-like manner.

funcIPython.utils._process_common.getoutput(cmd:str | list[str]) -> str

Run a command and return its stdout/stderr as a string.

funcIPython.utils._process_common.read_no_interrupt(stream:IO[bytes]) -> bytes | None

Read from a pipe ignoring EINTR errors.

classIPython.utils._process_posix.ProcessHandler

Execute subprocesses under the control of pexpect.

methodIPython.utils._process_posix.ProcessHandler.getoutput(cmd:str) -> str | None

Run a command and return its stdout/stderr as a string.

methodIPython.utils._process_posix.ProcessHandler.system(cmd:str) -> int

Execute a command in a subshell.

classIPython.utils._process_win32.AvoidUNCPath

A context manager to protect command execution from UNC paths.

funcIPython.utils._process_win32.arg_split(commandline:str, posix:bool=False, strict:bool=True) -> list[str]

Split a command line's arguments in a shell-like manner.

funcIPython.utils._process_win32.getoutput(cmd:str) -> str

Return standard output of executing cmd in a shell.

funcIPython.utils._process_win32.system(cmd:str) -> int | None

Win32 version of os.system() that works with network shares.

classIPython.utils.capture.capture_output

context manager for capturing stdout/err

classIPython.utils.contexts.preserve_keys

Preserve a set of keys in a dictionary.

funcIPython.utils.data.chop(seq:Sequence[T], size:int) -> list[Sequence[T]]

Chop a sequence into chunks of the given size.

funcIPython.utils.data.uniq_stable(elems:Iterable[T]) -> list[T]

uniq_stable(elems) -> list ..

funcIPython.utils.decorators.flag_calls(func:Callable[..., Any]) -> Callable[..., Any]

Wrap a function to detect and flag when it gets called.

func

IPython.utils.decorators.sphinx_options(show_inheritance:bool=True, show_inherited_members:bool=False, exclude_inherited_from:Sequence[str]=tuple()) -> Callable[[F], F]

Set sphinx options

funcIPython.utils.decorators.undoc(func:F) -> F

Mark a function or class as undocumented.

funcIPython.utils.dir2.safe_hasattr(obj:object, attr:str) -> bool

In recent versions of Python, hasattr() only catches AttributeError.

funcIPython.utils.encoding.get_stream_enc(stream:Any, default:str | None=None) -> str | None

Return the given stream's encoding or a default.

funcIPython.utils.generics.complete_object(obj:Any, prev_completions:list[str]) -> list[str]

Custom completer dispatching for python objects.

funcIPython.utils.importstring.import_item(name:str) -> Any

Import and return ``bar`` given the string ``foo.bar``.

classIPython.utils.io.Tee

A class to duplicate an output stream to stdout/err.

methodIPython.utils.io.Tee.close()

Close the file and restore the channel.

methodIPython.utils.io.Tee.flush()

Flush both channels.

methodIPython.utils.io.Tee.write(data)

Write data to both channels.

funcIPython.utils.io.temp_pyfile(src:str, ext:str='.py') -> str

Make a temporary python file, return filename and filehandle.

classIPython.utils.ipstruct.Struct

A dict subclass with attribute style access.

methodIPython.utils.ipstruct.Struct.copy()

Return a copy as a Struct.

methodIPython.utils.ipstruct.Struct.hasattr(key)

hasattr function available as a method.

funcIPython.utils.path.compress_user(path:str) -> str

Reverse of :func:`os.path.expanduser`

funcIPython.utils.path.filefind(filename:str, path_dirs=None) -> str

Find a file by looking through a sequence of paths.

funcIPython.utils.path.get_home_dir(require_writable:bool=False) -> str

Return the 'home' directory, as a unicode string.

funcIPython.utils.path.get_long_path_name(path)

Expand a path into its long form.

funcIPython.utils.path.unescape_glob(string)

Unescape glob pattern in `string`.

funcIPython.utils.process.abbrev_cwd()

Return abbreviated version of cwd, e.g.

classIPython.utils.strdispatch.StrDispatch

Dispatch (lookup) a set of strings / regexps for match.

methodIPython.utils.strdispatch.StrDispatch.add_s(s:str, obj:Callable, priority:int=0)

Adds a target 'string' for dispatching

funcIPython.utils.terminal.set_term_title(title:str) -> None

Set terminal title using the necessary platform-dependent calls.

funcIPython.utils.terminal.toggle_set_term_title(val:bool)

Control whether set_term_title is active or not.

classIPython.utils.text.LSString

String derivative with a special access attributes.

classIPython.utils.text.SList

List derivative with a special access attributes.

funcIPython.utils.text.dedent(text:str) -> str

Equivalent of textwrap.dedent that ignores unindented first line.

funcIPython.utils.text.format_screen(strng:str) -> str

Format a string for screen printing.

funcIPython.utils.text.indent(instr:str, nspaces:int=4, ntabs:int=0, flatten:bool=False) -> str

Indent a string a given number of spaces or tabstops.

funcIPython.utils.text.marquee(txt:str='', width:int=78, mark:str='*') -> str

Return the input string centered in a 'marquee'.

funcIPython.utils.text.strip_email_quotes(text:str) -> str

Strip leading email quotation characters ('>').

funcIPython.utils.tokenutil.generate_tokens(readline:Callable) -> Generator[TokenInfo]

wrap generate_tkens to catch EOF errors

funcIPython.utils.tokenutil.token_at_cursor(cell:str, cursor_pos:int=0) -> str

Get the token at a given cursor Used for introspection.

classsetupbase.MyBuildPy

Subclass to write commit data into installation tree

funcsetupbase.find_data_files()

Find IPython's data_files.

About this data

These signatures were extracted from the public source of ipython/ipython using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries