r15992 - /branches/uf_redesign/user_functions/objects.py -- May 04, 2012 - 20:44

Author: bugman
Date: Fri May  4 20:44:08 2012
New Revision: 15992

URL: http://svn.gna.org/viewcvs/relax?rev=15992&view=rev
Log:
The user function data structure now accepts the 'display' boolean variable.

This is used to indicate that a user function would like to display some 
output to STDOUT.


Modified:
    branches/uf_redesign/user_functions/objects.py

Modified: branches/uf_redesign/user_functions/objects.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/objects.py?rev=15992&r1=15991&r2=15992&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/objects.py (original)
+++ branches/uf_redesign/user_functions/objects.py Fri May  4 20:44:08 2012
@@ -89,6 +89,8 @@
     @type kargs:                list of dict
     @ivar backend:              The user function back end.  This should be 
a string version with full module path of the function which executes the 
back end.  For example 'generic_fns.pipes.create'.  Note, this should be 
importable as __import__(backend)!
     @type backend:              executable object
+    @ivar display:              A flag specifying if the user function 
displays output to STDOUT.  This is used for certain UIs to display that 
output.
+    @type display:              str
     @ivar desc:                 The full, multi-paragraph description.
     @type desc:                 str
     @ivar additional:           Additional documentation, usually appended 
to the end of the description.
@@ -113,6 +115,7 @@
             'title_short',
             'kargs',
             'backend',
+            'display',
             'desc',
             'additional',
             'prompt_examples',
@@ -132,6 +135,7 @@
         self.title_short = None
         self.kargs = []
         self.backend = None
+        self.display = False
         self.desc = None
         self.additional = None
         self.prompt_examples = None