From 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 2 Jan 2010 00:10:49 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.applications.html | 110 +++++++++++++++++++++++++++++++++++-- 1 file changed, 105 insertions(+), 5 deletions(-) (limited to 'doc/pydoc/ranger.applications.html') diff --git a/doc/pydoc/ranger.applications.html b/doc/pydoc/ranger.applications.html index 822ec412..6cda3202 100644 --- a/doc/pydoc/ranger.applications.html +++ b/doc/pydoc/ranger.applications.html @@ -30,7 +30,8 @@
builtins.object
-
Applications +
AppContext +
Applications
@@ -38,12 +39,106 @@ + + + + +
 
+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.
+ 
+This function ensures that there is an action.
+ +
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.
+It has one argument, which is the AppContext instance.
+ 
+You should define 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
@@ -63,8 +158,12 @@ Data descriptors defined here:
Functions
       
run(*args, **kw)
Run files with the specified parameters
-
spawn(command, fm=None, suspend=True, wait=True)
+
run(action=None, **kw)
Shortcut for creating and immediately running an AppContext.
+
tup(*args)
This helper function creates a tuple out of the arguments.
+ 
+('a', ) + tuple(some_iterator)
+is equivalent to:
+tup('a', *some_iterator)

@@ -73,5 +172,6 @@ Data descriptors defined here:
        ALLOWED_FLAGS = 'sdpSDP'
-null = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'>
+PIPE = -1
+devnull = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'> \ No newline at end of file -- cgit 1.4.1-2-gfad0