alias.py
267 lines
| 10.0 KiB
| text/x-python
|
PythonLexer
|
r2243 | # encoding: utf-8 | ||
""" | ||||
|
r2731 | System command aliases. | ||
|
r2243 | |||
Authors: | ||||
|
r2731 | * Fernando Perez | ||
|
r2243 | * Brian Granger | ||
""" | ||||
#----------------------------------------------------------------------------- | ||||
|
r5390 | # Copyright (C) 2008-2011 The IPython Development Team | ||
|
r2243 | # | ||
|
r3003 | # Distributed under the terms of the BSD License. | ||
# | ||||
# The full license is in the file COPYING.txt, distributed with this software. | ||||
|
r2243 | #----------------------------------------------------------------------------- | ||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
import os | ||||
|
r2244 | import re | ||
|
r2243 | import sys | ||
|
r21253 | from traitlets.config.configurable import Configurable | ||
|
r25227 | from .error import UsageError | ||
|
r2243 | |||
|
r21253 | from traitlets import List, Instance | ||
|
r22092 | from logging import error | ||
|
r2243 | |||
|
r28626 | import typing as t | ||
|
r2243 | #----------------------------------------------------------------------------- | ||
|
r2244 | # Utilities | ||
|
r2243 | #----------------------------------------------------------------------------- | ||
|
r2244 | # This is used as the pattern for calls to split_user_input. | ||
|
r4744 | shell_line_split = re.compile(r'^(\s*)()(\S+)(.*$)') | ||
|
r2244 | |||
|
r28626 | def default_aliases() -> t.List[t.Tuple[str, str]]: | ||
|
r3003 | """Return list of shell aliases to auto-define. | ||
""" | ||||
# Note: the aliases defined here should be safe to use on a kernel | ||||
# regardless of what frontend it is attached to. Frontends that use a | ||||
# kernel in-process can define additional aliases that will only work in | ||||
# their case. For example, things like 'less' or 'clear' that manipulate | ||||
# the terminal should NOT be declared here, as they will only work if the | ||||
# kernel is running inside a true terminal, and not over the network. | ||||
|
r4872 | |||
|
r2243 | if os.name == 'posix': | ||
|
r3003 | default_aliases = [('mkdir', 'mkdir'), ('rmdir', 'rmdir'), | ||
|
r16641 | ('mv', 'mv'), ('rm', 'rm'), ('cp', 'cp'), | ||
|
r3003 | ('cat', 'cat'), | ||
] | ||||
# Useful set of ls aliases. The GNU and BSD options are a little | ||||
# different, so we make aliases that provide as similar as possible | ||||
# behavior in ipython, by passing the right flags for each platform | ||||
if sys.platform.startswith('linux'): | ||||
ls_aliases = [('ls', 'ls -F --color'), | ||||
# long ls | ||||
('ll', 'ls -F -o --color'), | ||||
# ls normal files only | ||||
('lf', 'ls -F -o --color %l | grep ^-'), | ||||
# ls symbolic links | ||||
('lk', 'ls -F -o --color %l | grep ^l'), | ||||
# directories or links to directories, | ||||
('ldir', 'ls -F -o --color %l | grep /$'), | ||||
# things which are executable | ||||
('lx', 'ls -F -o --color %l | grep ^-..x'), | ||||
] | ||||
|
r18141 | elif sys.platform.startswith('openbsd') or sys.platform.startswith('netbsd'): | ||
|
r18156 | # OpenBSD, NetBSD. The ls implementation on these platforms do not support | ||
# the -G switch and lack the ability to use colorized output. | ||||
|
r18140 | ls_aliases = [('ls', 'ls -F'), | ||
# long ls | ||||
('ll', 'ls -F -l'), | ||||
# ls normal files only | ||||
('lf', 'ls -F -l %l | grep ^-'), | ||||
# ls symbolic links | ||||
('lk', 'ls -F -l %l | grep ^l'), | ||||
# directories or links to directories, | ||||
('ldir', 'ls -F -l %l | grep /$'), | ||||
# things which are executable | ||||
('lx', 'ls -F -l %l | grep ^-..x'), | ||||
] | ||||
|
r3003 | else: | ||
# BSD, OSX, etc. | ||||
|
r10161 | ls_aliases = [('ls', 'ls -F -G'), | ||
|
r3003 | # long ls | ||
|
r10161 | ('ll', 'ls -F -l -G'), | ||
|
r3003 | # ls normal files only | ||
|
r10161 | ('lf', 'ls -F -l -G %l | grep ^-'), | ||
|
r3003 | # ls symbolic links | ||
|
r10161 | ('lk', 'ls -F -l -G %l | grep ^l'), | ||
|
r3003 | # directories or links to directories, | ||
|
r10161 | ('ldir', 'ls -F -G -l %l | grep /$'), | ||
|
r3003 | # things which are executable | ||
|
r10161 | ('lx', 'ls -F -l -G %l | grep ^-..x'), | ||
|
r3003 | ] | ||
default_aliases = default_aliases + ls_aliases | ||||
elif os.name in ['nt', 'dos']: | ||||
default_aliases = [('ls', 'dir /on'), | ||||
('ddir', 'dir /ad /on'), ('ldir', 'dir /ad /on'), | ||||
('mkdir', 'mkdir'), ('rmdir', 'rmdir'), | ||||
('echo', 'echo'), ('ren', 'ren'), ('copy', 'copy'), | ||||
] | ||||
|
r2243 | else: | ||
|
r3003 | default_aliases = [] | ||
|
r4872 | |||
|
r3003 | return default_aliases | ||
|
r2243 | |||
class AliasError(Exception): | ||||
pass | ||||
class InvalidAliasError(AliasError): | ||||
pass | ||||
|
r12627 | class Alias(object): | ||
"""Callable object storing the details of one alias. | ||||
Instances are registered as magic functions to allow use of aliases. | ||||
""" | ||||
# Prepare blacklist | ||||
blacklist = {'cd','popd','pushd','dhist','alias','unalias'} | ||||
|
r12599 | def __init__(self, shell, name, cmd): | ||
|
r12595 | self.shell = shell | ||
|
r12599 | self.name = name | ||
|
r12595 | self.cmd = cmd | ||
|
r21709 | self.__doc__ = "Alias for `!{}`".format(cmd) | ||
|
r12627 | self.nargs = self.validate() | ||
def validate(self): | ||||
"""Validate the alias, and return the number of arguments.""" | ||||
if self.name in self.blacklist: | ||||
raise InvalidAliasError("The name %s can't be aliased " | ||||
"because it is a keyword or builtin." % self.name) | ||||
try: | ||||
caller = self.shell.magics_manager.magics['line'][self.name] | ||||
except KeyError: | ||||
pass | ||||
else: | ||||
if not isinstance(caller, Alias): | ||||
raise InvalidAliasError("The name %s can't be aliased " | ||||
"because it is another magic command." % self.name) | ||||
|
r23037 | if not (isinstance(self.cmd, str)): | ||
|
r12627 | raise InvalidAliasError("An alias command must be a string, " | ||
"got: %r" % self.cmd) | ||||
|
r20886 | nargs = self.cmd.count('%s') - self.cmd.count('%%s') | ||
|
r12627 | if (nargs > 0) and (self.cmd.find('%l') >= 0): | ||
|
r12595 | raise InvalidAliasError('The %s and %l specifiers are mutually ' | ||
|
r12627 | 'exclusive in alias definitions.') | ||
return nargs | ||||
|
r12599 | def __repr__(self): | ||
return "<alias {} for {!r}>".format(self.name, self.cmd) | ||||
|
r12627 | |||
|
r12595 | def __call__(self, rest=''): | ||
cmd = self.cmd | ||||
nargs = self.nargs | ||||
# Expand the %l special to be the user's input line | ||||
if cmd.find('%l') >= 0: | ||||
cmd = cmd.replace('%l', rest) | ||||
rest = '' | ||||
|
r20901 | |||
|
r12595 | if nargs==0: | ||
|
r20901 | if cmd.find('%%s') >= 1: | ||
cmd = cmd.replace('%%s', '%s') | ||||
# Simple, argument-less aliases | ||||
cmd = '%s %s' % (cmd, rest) | ||||
|
r12595 | else: | ||
# Handle aliases with positional arguments | ||||
args = rest.split(None, nargs) | ||||
if len(args) < nargs: | ||||
|
r12599 | raise UsageError('Alias <%s> requires %s arguments, %s given.' % | ||
(self.name, nargs, len(args))) | ||||
|
r12595 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) | ||
|
r12627 | |||
|
r12595 | self.shell.system(cmd) | ||
|
r2244 | #----------------------------------------------------------------------------- | ||
# Main AliasManager class | ||||
#----------------------------------------------------------------------------- | ||||
|
r2731 | class AliasManager(Configurable): | ||
|
r28587 | default_aliases: List = List(default_aliases()).tag(config=True) | ||
user_aliases: List = List(default_value=[]).tag(config=True) | ||||
shell = Instance( | ||||
"IPython.core.interactiveshell.InteractiveShellABC", allow_none=True | ||||
) | ||||
|
r2243 | |||
|
r11064 | def __init__(self, shell=None, **kwargs): | ||
super(AliasManager, self).__init__(shell=shell, **kwargs) | ||||
|
r12627 | # For convenient access | ||
|
r28587 | if self.shell is not None: | ||
self.linemagics = self.shell.magics_manager.magics["line"] | ||||
self.init_aliases() | ||||
|
r2244 | |||
|
r2243 | def init_aliases(self): | ||
|
r12627 | # Load default & user aliases | ||
for name, cmd in self.default_aliases + self.user_aliases: | ||||
|
r28587 | if ( | ||
cmd.startswith("ls ") | ||||
and self.shell is not None | ||||
and self.shell.colors == "NoColor" | ||||
): | ||||
cmd = cmd.replace(" --color", "") | ||||
|
r2243 | self.soft_define_alias(name, cmd) | ||
|
r12627 | @property | ||
def aliases(self): | ||||
return [(n, func.cmd) for (n, func) in self.linemagics.items() | ||||
if isinstance(func, Alias)] | ||||
|
r2245 | |||
|
r2243 | def soft_define_alias(self, name, cmd): | ||
"""Define an alias, but don't raise on an AliasError.""" | ||||
try: | ||||
self.define_alias(name, cmd) | ||||
|
r7787 | except AliasError as e: | ||
|
r2243 | error("Invalid alias: %s" % e) | ||
def define_alias(self, name, cmd): | ||||
"""Define a new alias after validating it. | ||||
This will raise an :exc:`AliasError` if there are validation | ||||
problems. | ||||
""" | ||||
|
r12627 | caller = Alias(shell=self.shell, name=name, cmd=cmd) | ||
|
r12595 | self.shell.magics_manager.register_function(caller, magic_kind='line', | ||
magic_name=name) | ||||
|
r2243 | |||
|
r12627 | def get_alias(self, name): | ||
"""Return an alias, or None if no alias by that name exists.""" | ||||
aname = self.linemagics.get(name, None) | ||||
return aname if isinstance(aname, Alias) else None | ||||
def is_alias(self, name): | ||||
"""Return whether or not a given name has been defined as an alias""" | ||||
return self.get_alias(name) is not None | ||||
|
r2245 | def undefine_alias(self, name): | ||
|
r12627 | if self.is_alias(name): | ||
del self.linemagics[name] | ||||
|
r12595 | else: | ||
raise ValueError('%s is not an alias' % name) | ||||
|
r2245 | |||
|
r12627 | def clear_aliases(self): | ||
|
r28587 | for name, _ in self.aliases: | ||
|
r12627 | self.undefine_alias(name) | ||
|
r12596 | def retrieve_alias(self, name): | ||
"""Retrieve the command to which an alias expands.""" | ||||
|
r12627 | caller = self.get_alias(name) | ||
if caller: | ||||
|
r12596 | return caller.cmd | ||
else: | ||||
raise ValueError('%s is not an alias' % name) | ||||