ranger.api.commands
index
../../ranger/api/commands.py

# Copyright (C) 2009-2013  Roman Zimbelmann <hut@lavabit.com>
# This software is distributed under the terms of the GNU GPL version 3.

 
Modules
       
os
ranger
re

 
Classes
       
builtins.object
CommandContainer
ranger.core.shared.FileManagerAware(builtins.object)
Command
AliasCommand
FunctionCommand

 
class AliasCommand(Command)
    
Method resolution order:
AliasCommand
Command
ranger.core.shared.FileManagerAware
builtins.object

Methods defined here:
cancel(self)
execute(self)
quick(self)
tab(self)

Methods inherited from Command:
__init__(self, line, quantifier=None)
arg(self, n)
Returns the nth space separated word
parse_flags(self)
Finds and returns flags in the command
 
>>> Command("").parse_flags()
('', '')
>>> Command("foo").parse_flags()
('', '')
>>> Command("shell test").parse_flags()
('', 'test')
>>> Command("shell -t ls -l").parse_flags()
('t', 'ls -l')
>>> Command("shell -f -- -q test").parse_flags()
('f', '-q test')
>>> Command("shell -foo -bar rest of the command").parse_flags()
('foobar', 'rest of the command')
parse_setting_line(self)
rest(self, n)
Returns everything from and after arg(n)
shift(self)
start(self, n)
Returns everything until (inclusively) arg(n)
tabinsert(self, word)

Class methods inherited from Command:
get_name() from builtins.type

Data and other attributes inherited from Command:
allow_abbrev = True
escape_macros_for_shell = False
name = None
quantifier = None
resolve_macros = True

Data descriptors inherited from ranger.core.shared.FileManagerAware:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Command(ranger.core.shared.FileManagerAware)
    Abstract command class
 
 
Method resolution order:
Command
ranger.core.shared.FileManagerAware
builtins.object

Methods defined here:
__init__(self, line, quantifier=None)
arg(self, n)
Returns the nth space separated word
cancel(self)
Override this
execute(self)
Override this
parse_flags(self)
Finds and returns flags in the command
 
>>> Command("").parse_flags()
('', '')
>>> Command("foo").parse_flags()
('', '')
>>> Command("shell test").parse_flags()
('', 'test')
>>> Command("shell -t ls -l").parse_flags()
('t', 'ls -l')
>>> Command("shell -f -- -q test").parse_flags()
('f', '-q test')
>>> Command("shell -foo -bar rest of the command").parse_flags()
('foobar', 'rest of the command')
parse_setting_line(self)
quick(self)
Override this
rest(self, n)
Returns everything from and after arg(n)
shift(self)
start(self, n)
Returns everything until (inclusively) arg(n)
tab(self)
Override this
tabinsert(self, word)

Class methods defined here:
get_name() from builtins.type

Data and other attributes defined here:
allow_abbrev = True
escape_macros_for_shell = False
name = None
quantifier = None
resolve_macros = True

Data descriptors inherited from ranger.core.shared.FileManagerAware:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class CommandContainer(builtins.object)
     Methods defined here:
__getitem__(self, key)
__init__(self)
alias(self, name, full_command)
command_generator(self, start)
get_command(self, name, abbrev=True)
load_commands_from_module(self, module)
load_commands_from_object(self, obj, filtr)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class FunctionCommand(Command)
    
Method resolution order:
FunctionCommand
Command
ranger.core.shared.FileManagerAware
builtins.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, quantifier=None)
arg(self, n)
Returns the nth space separated word
cancel(self)
Override this
parse_flags(self)
Finds and returns flags in the command
 
>>> Command("").parse_flags()
('', '')
>>> Command("foo").parse_flags()
('', '')
>>> Command("shell test").parse_flags()
('', 'test')
>>> Command("shell -t ls -l").parse_flags()
('t', 'ls -l')
>>> Command("shell -f -- -q test").parse_flags()
('f', '-q test')
>>> Command("shell -foo -bar rest of the command").parse_flags()
('foobar', 'rest of the command')
parse_setting_line(self)
quick(self)
Override this
rest(self, n)
Returns everything from and after arg(n)
shift(self)
start(self, n)
Returns everything until (inclusively) arg(n)
tab(self)
Override this
tabinsert(self, word)

Class methods inherited from Command:
get_name() from builtins.type

Data and other attributes inherited from Command:
allow_abbrev = True
escape_macros_for_shell = False
name = None
quantifier = None
resolve_macros = True

Data descriptors inherited from ranger.core.shared.FileManagerAware:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
alias(*_)

 
Data
        DELETE_WARNING = 'delete seriously? '