Re #10137. Reverting to version from master to fix unit test.

Code/Mantid/Framework/PythonInterface/test/python/mantid/SimpleAPITest.py

@@ -16,16 +16,16 @@ class TemporaryPythonAlgorithm(object):
     """
     def __init__(self, name, code):
         from mantid import config
-
+        
         plugin_dirs = config['python.plugins.directories'].split(";")
         if len(plugin_dirs) == 0:
             raise RuntimeError("No Python algorithm directories defined")
-
+        
         self._pyfile = os.path.join(plugin_dirs[0], name + ".py")
         alg_file = open(self._pyfile, "w")
         alg_file.write(code)
         alg_file.close()
-
+        
     def __del__(self):
         try:
             os.remove(self._pyfile)
@@ -40,29 +40,29 @@ class SimpleAPITest(unittest.TestCase):
 
     def tearDown(self):
         mtd.clear()
-
+        
     def test_version_number_equals_2(self):
         self.assertEquals(simpleapi.apiVersion(), 2)
-
+    
     def test_module_dict_seems_to_be_correct_size(self):
         # Check that the module has at least the same number
         # of attributes as unique algorithms
         module_dict = dir(simpleapi)
         all_algs = AlgorithmFactory.getRegisteredAlgorithms(True)
         self.assertTrue( len(module_dict) > len(all_algs) )
-
+        
     def test_alg_has_expected_doc_string(self):
         # Test auto generated string, Load is manually written
         expected_doc = \
         """Rebins data with new X bin boundaries. For EventWorkspaces, you can very quickly rebin in-place by keeping the same output name and PreserveEvents=true.
 
-Property descriptions:
+Property descriptions: 
 
 InputWorkspace(Input:req) *MatrixWorkspace*       Workspace containing the input data
 
 OutputWorkspace(Output:req) *MatrixWorkspace*       The name to give the output workspace
 
-Params(Input:req) *dbl list*       A comma separated list of first bin boundary, width, last bin boundary. Optionally this can be followed by a comma and more widths and last boundary pairs. Optionally this can also be a single number, which is the bin width. In this case, the boundary of binning will be determined by minimum and maximum TOF values among all events, or previous binning boundary, in case of event Workspace, or non-event Workspace, respectively. Negative width values indicate logarithmic binning.
+Params(Input:req) *dbl list*       A comma separated list of first bin boundary, width, last bin boundary. Optionally this can be followed by a comma and more widths and last boundary pairs. Optionally this can also be a single number, which is the bin width. In this case, the boundary of binning will be determined by minimum and maximum TOF values among all events, or previous binning boundary, in case of event Workspace, or non-event Workspace, respectively. Negative width values indicate logarithmic binning. 
 
 PreserveEvents(Input) *boolean*       Keep the output workspace as an EventWorkspace, if the input has events. If the input and output EventWorkspace names are the same, only the X bins are set, which is very quick. If false, then the workspace gets converted to a Workspace2D histogram.
 
@@ -71,39 +71,39 @@ def test_alg_has_expected_doc_string(self):
         doc = simpleapi.rebin.__doc__
         self.assertTrue(len(doc) > 0 )
         self.assertEquals(doc, expected_doc)
-
+        
     def test_function_call_executes_correct_algorithm_when_passed_correct_args(self):
         wsname = 'test_function_call_executes_correct_algorithm_when_passed_correct_args'
         data = [1.0,2.0,3.0,4.0,5.0]
         simpleapi.CreateWorkspace(data,data,OutputWorkspace=wsname,NSpec=1,UnitX='Wavelength')
         self.assertTrue( wsname in mtd )
-
+        
     def test_function_call_executes_with_output_workspace_on_lhs(self):
         data = [1.0,2.0,3.0,4.0,5.0]
         wavelength = simpleapi.CreateWorkspace(data,data,NSpec=1,UnitX='Wavelength')
         wsname = 'wavelength'
         self.assertTrue( wsname in mtd )
-
+        
     def test_function_call_executes_when_algorithm_has_only_inout_workspace_props(self):
         data = [1.0,2.0,3.0,4.0,5.0, 6.0]
         wavelength = simpleapi.CreateWorkspace(data,data,NSpec=3,UnitX='Wavelength')
         simpleapi.MaskDetectors(wavelength,WorkspaceIndexList=[1,2])
-
+        
     def test_function_accepts_EnableLogging_keyword(self):
         # The test here is that the algorithm runs without falling over about the EnableLogging keyword being a property
         wsname = 'test_function_call_executes_correct_algorithm_when_passed_correct_args'
         data = [1.0,2.0,3.0,4.0,5.0]
         simpleapi.CreateWorkspace(data,data,OutputWorkspace=wsname,NSpec=1,UnitX='Wavelength',EnableLogging=False)
         self.assertTrue( wsname in mtd )
-
+    
     def test_function_call_raises_ValueError_when_passed_args_with_invalid_values(self):
         # lhs code bug means we can't do this "self.assertRaises(simpleapi.LoadNexus, 'DoesNotExist')" --> ticket #4186
         try:
             simpleapi.LoadNexus(Filename='DoesNotExist.nxs')
             self.fail("A ValueError was not thrown")
         except ValueError:
             pass
-
+        
     def test_function_call_raises_RuntimeError_when_passed_incorrect_args(self):
         try:
             simpleapi.LoadNexus(NotAProperty=1)
@@ -120,21 +120,21 @@ def test_function_call_raises_RuntimeError_if_num_of_ret_vals_doesnt_match_num_a
                 pass
             else:
                 self.fail("Exception was raised but it did not have the correct message: '%s'" % str(exc))
-
+        
     def test_function_returns_correct_args_when_extra_output_props_are_added_at_execute_time(self):
         ws1 = simpleapi.CreateWorkspace([1.5],[1.5],NSpec=1,UnitX='Wavelength')
         ws2 = simpleapi.CreateWorkspace([1.5],[1.5],NSpec=1,UnitX='Wavelength')
         # RenameWorkspaces defines extra properties for each workspace renamed at runtime
         ws1a,ws2a = simpleapi.RenameWorkspaces(InputWorkspaces="ws1,ws2",WorkspaceNames="ws1a,ws2a")
         self.assertTrue(isinstance(ws1a, MatrixWorkspace))
         self.assertTrue(isinstance(ws2a, MatrixWorkspace))
-
+        
     def test_function_uses_OutputWorkspace_keyword_over_lhs_var_name_if_provided(self):
         wsname = 'test_function_uses_OutputWorkspace_keyword_over_lhs_var_name_if_provided'
         data = [1.0,2.0,3.0,4.0,5.0]
         wkspace = simpleapi.CreateWorkspace(data,data,OutputWorkspace=wsname,NSpec=1,UnitX='Wavelength')
         self.assertTrue( wsname in mtd )
-
+    
     def test_function_returns_only_mandatory_workspace_when_optional_output_is_not_given(self):
         _demo = simpleapi.CreateMDHistoWorkspace(SignalInput='1,2,3,4,5',ErrorInput='1,1,1,1,1',
                                                 Dimensionality='1',Extents='-1,1',NumberOfBins='5',Names='A',Units='U')
@@ -152,13 +152,13 @@ def test_function_returns_both_mandatory_and_optional_workspaces_when_optional_o
         wsname_box = wsname + '_box'
         query = simpleapi.QueryMDWorkspace(InputWorkspace=_demo,OutputWorkspace=wsname,MaximumRows='500',
                                            Normalisation='volume',BoxDataTable=wsname_box)
-
+        
         self.assertTrue( wsname in mtd )
         self.assertTrue( wsname_box in mtd )
-
+        
         self.assertTrue( type(query) == tuple )
         self.assertEquals( 2, len(query) )
-
+        
         self.assertTrue( isinstance(query[0], ITableWorkspace) )
         self.assertTrue( isinstance(query[1], ITableWorkspace) )
 
@@ -170,7 +170,7 @@ def test_function_attached_as_workpace_method_is_attached_to_correct_types(self)
     def test_function_attached_as_workpace_method_has_same_metainformation_as_free_function(self):
         self.assertEqual(MatrixWorkspace.rebin.__name__, simpleapi.Rebin.__name__)
         self.assertEqual(MatrixWorkspace.rebin.__doc__, simpleapi.Rebin.__doc__)
-
+        
         # Signature of method will have extra self argument
         freefunction_sig = simpleapi.rebin.func_code.co_varnames
         expected_method_sig = ['self']
@@ -201,13 +201,13 @@ def test_that_dialog_call_raises_runtime_error(self):
             msg = str(exc)
             if msg != "Can only display properties dialog in gui mode":
                 self.fail("Dialog function raised the correct exception type but the message was wrong")
-
+                
     def test_call_inside_function_uses_new_variable_name(self):
         def rebin(workspace):
             # Should replace the input workspace
             workspace = simpleapi.Rebin(workspace, Params=[1,0.1,10])
             return workspace
-
+        
         dataX=numpy.linspace(start=1,stop=3,num=11)
         dataY=numpy.linspace(start=1,stop=3,num=10)
         raw = simpleapi.CreateWorkspace(DataX=dataX,DataY=dataY,NSpec=1)
@@ -220,7 +220,7 @@ def rebin(workspace):
     def test_python_alg_can_use_other_python_alg_through_simple_api(self):
         """
         Runs a test in a separate process as it requires a reload of the
-        whole mantid module
+        whole mantid module 
         """
         src = """
 from mantid.api import PythonAlgorithm, AlgorithmFactory
@@ -234,7 +234,7 @@ def PyInit(self):
     def PyExec(self):
         %(execline1)s
         %(execline2)s
-
+        
 AlgorithmFactory.subscribe(%(name)s)
 """
         name1 = "SimpleAPIPythonAlgorithm1"
@@ -250,10 +250,10 @@ def PyExec(self):
             subprocess.check_call(cmd,shell=True)
         except subprocess.CalledProcessError, exc:
             self.fail("Error occurred running one Python algorithm from another: %s" % str(exc))
-
+        
         # Ensure the files are removed promptly
         del a,b
-
+        
     def test_optional_workspaces_are_ignored_if_not_present_in_output_even_if_given_as_input(self):
         # Test algorithm
         from mantid.api import AlgorithmManager,PropertyMode,PythonAlgorithm,MatrixWorkspaceProperty,WorkspaceFactory
@@ -262,14 +262,14 @@ class OptionalWorkspace(PythonAlgorithm):
             def PyInit(self):
                 self.declareProperty(MatrixWorkspaceProperty("RequiredWorkspace", "", Direction.Output))
                 self.declareProperty(MatrixWorkspaceProperty("OptionalWorkspace", "", Direction.Output, PropertyMode.Optional))
-
+ 
             def PyExec(self):
                 ws = WorkspaceFactory.create("Workspace2D", NVectors=1, YLength=1,XLength=1)
                 ws.dataY(0)[0] = 5
                 self.setProperty("RequiredWorkspace", ws)
                 self.getLogger().notice("done!")
         AlgorithmFactory.subscribe(OptionalWorkspace)
-
+        
         # temporarily attach it to simpleapi module
         name="OptionalWorkspace"
         algm_object = AlgorithmManager.createUnmanaged(name, 1)
@@ -281,13 +281,13 @@ def PyExec(self):
         self.assertTrue(isinstance(result, MatrixWorkspace))
         self.assertAlmostEqual(5, result.readY(0)[0], places=12)
         mtd.remove("required")
-
+        
         # Call with both outputs specified
         result = simpleapi.OptionalWorkspace(RequiredWorkspace="required",OptionalWorkspace="optional")
         self.assertTrue(isinstance(result, MatrixWorkspace))
         self.assertAlmostEqual(5, result.readY(0)[0], places=12)
         mtd.remove("required")
-
+        
         # Tidy up simple api function
         del simpleapi.OptionalWorkspace