Changeset 439420f9 in sasview for src/sas/perspectives/calculator/model_editor.py

Timestamp:

Apr 5, 2015 7:01:01 PM (9 years ago)

Author:

butler

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

18ac46b

Parents:

7b1f4e3

Message:

use Regular text module to check for valid python name when creating a
custom model from composite model editor (sum|multi(p1,p2)). also
refactor checking code and made notes for future extraction of non GUI
code.

File:

• src/sas/perspectives/calculator/model_editor.py (modified) (4 diffs)

src/sas/perspectives/calculator/model_editor.py

@@ -283 +283 @@
     def check_name(self, event=None):
         """
-        Check name if exist already
-        """
+        Check that proposed new model name is a valid Python module name 
+        and that it does not already exist. If not show error message and
+        pink background in text box else call on_apply
+        
+        :TODO this should be separated out from the GUI code.  For that we
+        need to pass it the name (or if we want to keep the default name 
+        option also need to pass the self._operator attribute) We just need
+        the function to return an error code that the name is good or if 
+        not why (not a valid name, name exists already).  The rest of the 
+        error handling should be done in this module. so on_apply would then
+        start by checking the name and then either raise errors or do the
+        deed.
+        """
+        #Get the function/file name
         mname = M_NAME
         self.on_change_name(None)
-        list_fnames = os.listdir(self.plugin_dir)
-        # fake existing regular model name list
-        m_list = [model + ".py" for model in self.model_list]
-        list_fnames.append(m_list)
-        # function/file name
         title = self.name_tcl.GetValue().lstrip().rstrip()
         if title == '':
@@ -303 +310 @@
         self.name = title
         t_fname = title + '.py'
-        if not self.overwrite_name:
+
+        #First check if the name is a valid Python name
+        if re.match('^[A-Za-z0-9_]*$',title):
+            self.good_name = True
+        else: 
+            self.good_name = False
+            msg = ("%s is not a valid Python name. Only alphanumeric \n" \
+                "and underscore allowed" % self.name)
+ 
+        #Now check if the name already exists
+        if not self.overwrite_name and self.good_name:
+            #Create list of existing model names for comparison
+            list_fnames = os.listdir(self.plugin_dir)
+            # fake existing regular model name list
+            m_list = [model + ".py" for model in self.model_list]
+            list_fnames.append(m_list)
             if t_fname in list_fnames and title != mname:
-                self.name_tcl.SetBackgroundColour('pink')
                 self.good_name = False
-                info = 'Error'
                 msg = "Name exists already."
-                wx.MessageBox(msg, info)
-                self._notes = msg
-                color = 'red'
-                self._msg_box.SetLabel(msg)
-                self._msg_box.SetForegroundColour(color)
-                return self.good_name
+
+        if self.good_name == False:
+            self.name_tcl.SetBackgroundColour('pink')
+            info = 'Error'
+            wx.MessageBox(msg, info)
+            self._notes = msg
+            color = 'red'
+            self._msg_box.SetLabel(msg)
+            self._msg_box.SetForegroundColour(color)
+            return self.good_name
         self.fname = os.path.join(self.plugin_dir, t_fname)
         s_title = title
@@ -435 +459 @@
         """
 
-        self._type = type
         name = ''
 
-        if self._type == '*':
+        if type == '*':
             name = 'Multi'
             factor = 'BackGround'
@@ -448 +471 @@
 
         self.factor = factor
-        self._operator = self._type
+        self._operator = type
         self.explanation = "  Custom Model = %s %s (model1 %s model2)\n" % \
                     (self.factor, f_oper, self._operator)