| | |
- builtins.object
-
- AppContext
- Applications
class AppContext(builtins.object) |
| |
An AppContext object abstracts the spawning of processes.
At initialization of the object you can define many high-level options.
When you call the run() function, those options are evaluated and
translated into Popen() calls.
An instances of this class is passed as the only argument to
app_xyz calls of the Applications object.
Attributes:
action -- a string with a command or a list of arguments for
the Popen call.
app -- the name of the app function. ("vim" for app_vim.)
app is used to get an action if the user didn't specify one.
mode -- a number, mainly used in determining the action in app_xyz()
flags -- a string with flags which change the way programs are run
files -- a list containing files, mainly used in app_xyz
file -- an arbitrary file from that list (or None)
fm -- the filemanager instance
wait -- boolean, wait for the end or execute programs in parallel?
stdout -- directly passed to Popen
stderr -- directly passed to Popen
stdin -- directly passed to Popen
shell -- directly passed to Popen. Should the string be shell-interpreted?
List of allowed flags:
s: silent mode. output will be discarded.
d: detach the process.
p: redirect output to the pager
An uppercase key ensures that a certain flag will not be used.
|
| |
Methods defined here:
- __init__(self, app='default', files=None, mode=0, flags='', fm=None, stdout=None, stderr=None, stdin=None, shell=None, wait=True, action=None)
- The necessary parameters are fm and action or app.
- __iter__(self)
- Iterates over all file paths
- get_action(self, apps=None)
- Get the action from app_xyz
- run(self)
- Run the application in the way specified by the options.
Returns False if nothing can be done, None if there was an error,
otherwise the process object returned by Popen().
This function tries to find an action if none is defined.
- squash_flags(self)
- Remove duplicates and lowercase counterparts of uppercase flags
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Applications(builtins.object) |
| |
This class contains definitions on how to run programs and should
be extended in ranger.defaults.apps
The user can decide what program to run, and if he uses eg. 'vim', the
function app_vim() will be called. However, usually the user
simply wants to "start" the file without specific instructions.
In such a case, app_default() is called, where you should examine
the context and decide which program to use.
All app functions have a name starting with app_ and return a string
containing the whole command or a tuple containing a list of the
arguments. They are supplied with one argument, which is the
AppContext instance.
You should define at least app_default, app_pager and app_editor since
internal functions depend on those. Here are sample implementations:
def app_default(self, context):
if context.file.media:
if context.file.video:
# detach videos from the filemanager
context.flags += 'd'
return app_mplayer(context)
else:
return app_editor(context)
def app_pager(self, context):
return ('less', ) + tuple(context)
def app_editor(self, context):
return ('vim', ) + tuple(context)
|
| |
Methods defined here:
- all(self)
- Returns a list with all application functions
- app_self(self, context)
- Run the file itself
- get(self, app)
- Looks for an application, returns app_default if it doesn't exist
- has(self, app)
- Returns whether an application is defined
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |