This documentation covers a development version of IPython. The development version may differ significantly from the latest stable release.
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).
System command aliases.
Alias(shell, name, cmd)¶
Callable object storing the details of one alias.
Instances are registered as magic functions to allow use of aliases.
__init__(shell, name, cmd)¶
Initialize self. See help(type(self)) for accurate signature.
Validate the alias, and return the number of arguments.
Create a configurable given a config config.
config (Config) – If this is empty, default values are used. If config is a
Configinstance, it will be used to configure the instance.
parent (Configurable instance, optional) – The parent Configurable instance of this object.
class MyConfigurable(Configurable): def __init__(self, config=None): super(MyConfigurable, self).__init__(config=config) # Then any other code you need to finish initialization.
This ensures that instances will be configured properly.
Define a new alias after validating it.
This will raise an
AliasErrorif there are validation problems.
Return an alias, or None if no alias by that name exists.
Return whether or not a given name has been defined as an alias
Retrieve the command to which an alias expands.
Define an alias, but don’t raise on an AliasError.