Warning
This documentation is for an old version of IPython. You can find docs for newer versions here.
Module: core.alias¶
System command aliases.
Authors:
- Fernando Perez
- Brian Granger
4 Classes¶
-
class
IPython.core.alias.AliasError¶ Bases:
exceptions.Exception
-
class
IPython.core.alias.InvalidAliasError¶
-
class
IPython.core.alias.Alias(shell, name, cmd)¶ Bases:
objectCallable object storing the details of one alias.
Instances are registered as magic functions to allow use of aliases.
-
__init__(shell, name, cmd)¶
-
validate()¶ Validate the alias, and return the number of arguments.
-
-
class
IPython.core.alias.AliasManager(shell=None, **kwargs)¶ Bases:
IPython.config.configurable.Configurable-
__init__(shell=None, **kwargs)¶
-
define_alias(name, cmd)¶ Define a new alias after validating it.
This will raise an
AliasErrorif there are validation problems.
-
get_alias(name)¶ Return an alias, or None if no alias by that name exists.
-
is_alias(name)¶ Return whether or not a given name has been defined as an alias
-
retrieve_alias(name)¶ Retrieve the command to which an alias expands.
-
soft_define_alias(name, cmd)¶ Define an alias, but don’t raise on an AliasError.
-