From 34a60763e79546e0f84e30fbcc430632f3dbb39e Mon Sep 17 00:00:00 2001 From: hut Date: Tue, 16 Feb 2010 01:56:21 +0100 Subject: incremented version number and updated pydoc html files --- doc/pydoc/ranger.applications.html | 103 ++++++++++--------------------------- 1 file changed, 26 insertions(+), 77 deletions(-) (limited to 'doc/pydoc/ranger.applications.html') diff --git a/doc/pydoc/ranger.applications.html b/doc/pydoc/ranger.applications.html index 7dd7e000..29755773 100644 --- a/doc/pydoc/ranger.applications.html +++ b/doc/pydoc/ranger.applications.html @@ -1,6 +1,6 @@ + Python: module ranger.applications - @@ -8,8 +8,8 @@
 
 
ranger.applications		index
/home/hut/work/ranger/ranger/applications.py
-

This module faciliates starting of new processes.

+>index
/home/hut/ranger/ranger/applications.pyc +

This module provides helper functions/classes for ranger.defaults.apps.

@@ -27,11 +27,10 @@
       
-
builtins.object +
ranger.shared.FileManagerAware(ranger.shared.Awareness)
-
AppContext -
Applications +
Applications
@@ -39,70 +38,7 @@ - - - - -
 
-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(ranger.shared.FileManagerAware) - - -
 
-class Applications(builtins.object)
    This class contains definitions on how to run programs and should
@@ -117,7 +53,7 @@ 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.
+AppContext instance.
 
You should define at least app_default, app_pager and app_editor since
internal functions depend on those.  Here are sample implementations:
@@ -137,17 +73,32 @@ def app_pager(self, context):
def app_editor(self, context):
        return ('vim', ) + tuple(context)
 
 Methods defined here:
+
Method resolution order:
+
Applications
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
__builtin__.object
+
+
+Methods defined here:
all(self)
Returns a list with all application functions
app_self(self, context)
Run the file itself
+
apply(self, app, context)
+ +
either(self, context, *args)
+
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:
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = None
+ +
+Data descriptors inherited from ranger.shared.Awareness:
__dict__
dictionary for instance variables (if defined)
@@ -161,7 +112,7 @@ Data descriptors defined here:
Functions
       
run(action=None, **kw)
Shortcut for creating and immediately running an AppContext.
+
depends_on(*args)
tup(*args)
This helper function creates a tuple out of the arguments.
 
('a', ) + tuple(some_iterator)
@@ -174,7 +125,5 @@ is equivalent to:
Data
       ALLOWED_FLAGS = 'sdpSDP'
-PIPE = -1
-devnull = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'>
+

PIPE = -1
\ No newline at end of file -- cgit 1.4.1-2-gfad0