Automatic dialog creation working.

Author: aglavic

.settings/org.eclipse.core.resources.prefs

@@ -58,6 +58,7 @@ encoding//plot_script/parallel.py=utf-8
 encoding//plot_script/peakfinder.py=utf8
 encoding//plot_script/plotpy_info.py=utf-8
 encoding//plot_script/plotting_debug.py=utf-8
+encoding//plot_script/plugins/__init__.py=utf-8
 encoding//plot_script/read_data/__init__.py=utf-8
 encoding//plot_script/read_data/circle.py=utf-8
 encoding//plot_script/read_data/dns.py=utf-8
@@ -89,6 +90,8 @@ encoding//plot_script/sessions/squid.py=utf-8
 encoding//plot_script/sessions/templates.py=utf-8
 encoding//plot_script/sessions/treff.py=utf-8
 encoding//sphinx/conf.py=utf-8
+encoding//tests/datatype.py=utf8
+encoding//tests/main_gui.py=utf8
 encoding/import_debug.py=utf-8
 encoding/plot.py=utf-8
 encoding/setup.py=utf-8

plot.py

@@ -7,6 +7,14 @@
 ##---add_python_path_here---## # Place holder to add installation directory to python path for non superuser installation.
 
 import plot_script
+import sys
+import os
 
 if __name__=='__main__':
-  plot_script._run()
+  if '--profile' in sys.argv:
+    # code profiling run
+    sys.argv.remove('--profile')
+    import cProfile
+    cProfile.run('plot_script._run()', os.path.join(os.path.split(__file__)[0], 'plot.py.profile'))
+  else:
+    plot_script._run()

plot_script/gtkgui/autodialogs.py

@@ -66,12 +66,13 @@ def _analyze_function(self, function):
       defaults and types.
     '''
     argspec=inspect.getargspec(function)
-    if argspec.args[0]!='dataset' or len(argspec.args)!=(1+len(argspec.defaults)):
+    skip_items=len(argspec.args)-len(argspec.defaults)
+    if skip_items==0:
       raise ValueError, "function does not have the right form"
     parameters=[]
     doc_lines=function.__doc__.splitlines()
     doc_lines=map(str.strip, doc_lines)
-    for arg, default in zip(argspec.args[1:], argspec.defaults):
+    for arg, default in zip(argspec.args[skip_items:], argspec.defaults):
       item={'arg':arg, 'name': arg, 'description': '',
             'type': type(default), 'default': default,
             'numrange': (-1e30, 1e30)}
@@ -134,3 +135,115 @@ def get_result(self):
       elif item['type'] is list:
         result[item['arg']]=entry.list_link
     return result
+
+class FunctionHandler(object):
+  '''
+    Class to store and process functions to be used with AutoDialog creation.
+    The class is not instantiated, calling it will add a function to as
+    the FunctionHandler.add_function method does.
+    
+    Functions are added using:
+      FunctionHandler.add_function(function, menu_entry=None,
+                                   description=None, shortcut=None)
+  '''
+  # for easier reading of the code, the convention using cls for classmethods
+  # is replaced by using self instead
+  registered_functions=[]
+  main_gui=None
+
+  def __new__(self, function, menu_entry=None, description=None, shortcut=None):
+    return self.add_function(function, menu_entry, description, shortcut)
+
+  @classmethod
+  def add_function(self, function, menu_entry=None, description=None, shortcut=None):
+    '''
+      Add a function to the list of available objects.
+    '''
+    if menu_entry is None:
+      # if no menu entry is supplied, use the functions name
+      # replacing underscores with spaces and using the first letter
+      # in upper case
+      fname=function.__name__
+      menu_entry=fname[0].upper()+fname[1:].replace('_', ' ')+'...'
+    if not self.check_function(function):
+      raise ValueError, 'function does not have the right format'
+    if function.__doc__ is None:
+      function.__doc__=''
+    self.registered_functions.append((function, menu_entry, description, shortcut))
+
+  @classmethod
+  def check_function(self, function):
+    '''
+      Check the validity of the function argument specifications.
+    '''
+    argspec=inspect.getargspec(function)
+    args=argspec.args
+    if args[0]=='dataset':
+      if len(args)!=(1+len(argspec.defaults)):
+        return False
+      return True
+    elif args[0]=='datasets':
+      if args[1]!='d_index' or len(args)!=(2+len(argspec.defaults)):
+        return False
+      return True
+    else:
+      return False
+
+  @classmethod
+  def get_menu_string(self):
+    if len(self.registered_functions)==0:
+      return ''
+    else:
+      output='''        </menu>
+        <menu action='UserAddedMenu'>
+    '''
+      for function, ignore, ignore, ignore in self.registered_functions:
+        output+='''          <menuitem action='%s'/>
+        '''%function.__name__.replace('_', '')
+      return output
+
+
+  @classmethod
+  def get_menu_actions(self):
+    if len(self.registered_functions)==0:
+      return ()
+    else:
+      output=[("UserAddedMenu", None, "User-Func.", None, None, None), ]
+      for function, menu_entry, ignore, shortcut in self.registered_functions:
+        output.append(
+                      (function.__name__.replace('_', ''), None,
+                       menu_entry, shortcut,
+                       None, self.call_function)
+                      )
+      return tuple(output)
+
+  @classmethod
+  def call_function(self, action, main_window):
+    '''
+      Open AutoDialog and run the function with the given parameters.
+    '''
+    action_name=action.get_name()
+    action_names=[item[0].__name__.replace('_', '') for item in self.registered_functions]
+    action_index=action_names.index(action_name)
+    function, menu_entry, description, ignore=self.registered_functions[action_index]
+    dialog=AutoDialog(function, description_text=description, title=menu_entry)
+    result=dialog.run()
+    if result:
+      datasets=main_window.active_session.active_file_data
+      d_index=main_window.index_mess
+      argspec=inspect.getargspec(function)
+      if argspec.args[0]=='dataset':
+        result=function(datasets[d_index], **dialog.get_result())
+      else:
+        result=function(datasets, d_index, **dialog.get_result())
+      if result is None:
+        main_window.rebuild_menus()
+        main_window.replot()
+      else:
+        datasets.append(result)
+        main_window.index_mess=len(datasets)-1
+        main_window.rebuild_menus()
+        main_window.replot()
+    dialog.destroy()
+
+

plot_script/gtkgui/main_window.py

@@ -579,8 +579,9 @@ def main_quit(self, action=None, store_config=True):
     # exit persistent gnuplot instances
     persistent_plot_instances=measurement_data_plotting.persistent_plot_instances
     for p in persistent_plot_instances:
-      p.stdin.write('quit\n')
-      p.stdin.flush()
+      if p.stdin.is_open():
+        p.stdin.write('quit\n')
+        p.stdin.flush()
       p.communicate()
     # save settings to ini file
     if store_config:

plot_script/gtkgui/main_window_actions.py

@@ -366,7 +366,7 @@ def add_multiplot(self, action):
         self.do_add_multiplot(self.index_mess)
     elif action.get_name()=='AddMultiplot':
       self.multiplot.sort_add()
-  
+
   def toggle_multiplot_copymode(self, action):
     '''
       Toggle between copy and non-copy mode in multiplot.
@@ -552,7 +552,7 @@ def action_history(self, action):
 
   def open_tabdialog(self, action=None):
     dia=NotebookDialog(self, title='Plot.py Notebook')
-    dia.set_default_size(600,400)
+    dia.set_default_size(600, 400)
     dia.show()
 
   def open_ipy_console(self, action=None, commands=[], show_greetings=True):
@@ -575,6 +575,7 @@ def open_ipy_console(self, action=None, commands=[], show_greetings=True):
       scipy=None
     from glob import glob
     from plot_script.fit_data import new_function
+    from plot_script.gtkgui.autodialogs import FunctionHandler
 
     if getattr(self, 'active_ipython', False):
       # if there is already an ipython console, show it and exit
@@ -607,15 +608,13 @@ def open_ipy_console(self, action=None, commands=[], show_greetings=True):
 
     Functions:
       replot \tFunction to replot the dataset
-      dataset \tFunction to get the active MeasurementData object
-      getxyz/\tReturn 3/all PhysicalProperty instances of the x,y and z columns 
-        getall\tfrom the active dataset
+      dataset \tGet the active MeasurementData object (see attributes x,y,z,data)
       newxyz/ \tCreate a new plot with changed columns, takes three/several lists or 
         newall\tarrays as input. For line plots the last parameter is 'None'.
-      mapdata \tApply a function to all datasets in the active file data
-      mapall  \tApply a function to all datasets from all files
+      mapdata \tApply a function to all datasets in the active file data (see mapall)
       newfit  \tAdd a function to the fit dialog functions, should be defined as
               \tither f(p,x) of f(p,x,y) for 2d or 3d datasets respectively.
+      newmenu \tAdd a menu entry which opens a dialog for parameter entry (see newmenu?)
       makefit \tClass which holds all fittable functions as properties. To fit
               \te.g. a linear regression to the current dataset use:
               \tmakefit.Linear_Regression([0.5, 2]) (-> parameters after fit)
@@ -626,7 +625,7 @@ def open_ipy_console(self, action=None, commands=[], show_greetings=True):
               \tThe data for the selected file is in session.active_file_data
       plot_gui \tThe window object with all window related funcitons
       macros  \tDictionary containing all functions which can be run as 'macros'
-      menus   \tAccess all GUI menus as properties of this object, e.g. "menus.File.Open_File()".
+      menus   \tAccess all GUI menus as properties of this object.
       action_history \tList of macros activated through the GUI (key, (parameters)).
     Modules:
       np \tNumpy
@@ -727,6 +726,38 @@ def mapall(function):
         for dataset in datasets:
           output[key].append(function(dataset))
       return output
+    def newmenu(function, menu_entry=None, description=None, shortcut=None):
+      '''
+        Create an entry in the "User-Func." menu which opens a parameter
+        dialog and after that calls the function. The dialog is created
+        directly from function inspection so the function needs to have
+        one of the following two forms:
+        
+          my_function(dataset, param1=12., param2=23, param3='abc')
+          my_function(datasets, d_index, param1=12., param2=23, param3='abc')
+          
+        Where the naming convention of dataset/datasets/d_index is fixed
+        while the parameters can be named as desired. Parameters must be 
+        ither int, float, str or list of only one type of these. 
+        The docstring of the function can be used to further change the 
+        dialog appearance of the parameters by supplieng lines of type:
+        
+          :param param1: [lower_bound:upper_bound] - param item name - description
+          or
+          :param param1: param item name - description
+          or
+          :param param1: description
+        
+        If this is not supplied the dialog will use the parameter names and leave
+        empty descriptions.
+        
+        The optional arguments to newmenu can define the name of the menu item,
+        a descriptive text at the top of the dialog and a keystroke shortcut
+        as "<control>U".
+      '''
+      FunctionHandler.add_function(function, menu_entry, description, shortcut)
+      self.rebuild_menus()
+
     # add variables to ipython namespace
     ipview.updateNamespace({
                        'session': self.active_session,
@@ -750,6 +781,7 @@ def mapall(function):
                        'menus': MenuWrapper(self.menu_bar),
                        'newfit': new_function,
                        'makefit': FitWrapper(self, self.active_session),
+                       'newmenu': newmenu,
                        })
     # add common mathematic functions to the namespace
     math_functions=['exp', 'log', 'log10', 'pi',

plot_script/gtkgui/main_window_ui.py

@@ -8,6 +8,7 @@
 import gobject
 from main_window_actions import apihelp
 from plot_script.config import gui as gui_config
+from autodialogs import FunctionHandler
 
 
 __author__="Artur Glavic"
@@ -332,6 +333,8 @@ def build_menu(self):
         <menu action='PluginMenu'>
       '''+plugin_menu
       self.session_added_items=self.session_added_items+(("PluginMenu", None, "Plugins", None, None, None),)
+    output+=FunctionHandler.get_menu_string()
+    self.session_added_items=self.session_added_items+FunctionHandler.get_menu_actions()
     output+='''
       </menu>
     </menubar>
@@ -791,7 +794,7 @@ def replace_icon(self, item, imgfile):
     height=buf.get_height()
     scale=min(size/width, size/height)
     buf=buf.scale_simple(int(width*scale), int(height*scale), gtk.gdk.INTERP_BILINEAR)
-    
+
     for i in range(2):
       toolbutton=self.UIManager.get_widget('/ui/ToolBar%i/'%(i+1)+item)
       if toolbutton is not None:

tests/datatype.py

@@ -4,7 +4,7 @@
 '''
 
 from plot_script.measurement_data_structure import PhysicalProperty
-from numpy import *
+from numpy import array, ndarray, arange, float32, sqrt, zeros_like, ones_like, pi, sin
 import unittest
 
 class TestPhysicalProperty(unittest.TestCase):

tests/main_gui.py

@@ -0,0 +1,74 @@
+#-*- coding: utf8 -*-
+'''
+  Testing the main window.
+'''
+
+import unittest
+import os
+import sys
+import gtk
+from plot_script.sessions.circle import CircleSession
+from plot_script.gtkgui.main_window import ApplicationMainWindow
+
+class TestMainWindow(unittest.TestCase):
+  '''
+    Check the behavior of the base data holding array type.
+  '''
+
+  @classmethod
+  def setUpClass(self):
+    self.session=CircleSession(['/home/glavic/inplan_2plane_radial_scans.spec'])
+    self.gui=ApplicationMainWindow(self.session)
+
+  @classmethod
+  def tearDownClass(self):
+    self.gui.main_quit()
+    while gtk.events_pending():
+      gtk.main_iteration_do(block=False)
+
+  def setUp(self):
+    while gtk.events_pending():
+      gtk.main_iteration_do(block=False)
+
+  def tearDown(self):
+    while gtk.events_pending():
+      gtk.main_iteration_do(block=False)
+
+  def test_1show(self):
+    self.assertTrue(self.gui.get_visible(), 'GUI is not shown')
+    self.assertEqual(self.session, self.gui.active_session, 'Session not associated')
+
+  def test_2image_created(self):
+    image_file=self.session.TEMP_DIR+'plot_temp.png'
+    self.assertTrue(os.path.exists(image_file), 'Plot image not created')
+
+  def test_3persistent(self):
+    self.gui.plot_persistent()
+
+  def test_4ipython(self):
+    self.gui.open_ipy_console()
+    self.assertNotEqual(False, getattr(self.gui, 'active_ipython', False),
+                        'IPythonView not created')
+
+  def test_5ipython_close(self):
+    self.gui.active_ipython.destroy()
+    self.assertNotEqual(False, getattr(self.gui, 'ipython_user_namespace', False),
+                        'Namspace not saved')
+    self.assertNotEqual(False, getattr(self.gui, 'ipython_user_history', False),
+                        'History not saved')
+
+  def test_6opow(self):
+    self.gui.open_plot_options_window(None)
+
+  def test_7cpow(self):
+    self.gui.open_plot_options_window(None)
+
+  def test_8slpp(self):
+    self.gui.show_last_plot_params(None)
+
+
+if __name__=='__main__':
+  #unittest.main()
+  loader=unittest.TestLoader()
+  suite=loader.loadTestsFromTestCase(TestMainWindow)
+  unittest.TextTestRunner(verbosity=2).run(suite)