Algorithms called from a Python Algorithm should not log themselves in history

[Mathieu Doucet]

Sub-algorithms called from a C++ algorithm don't log themselves into the workspace history. Algorithms called from python algorithms do. There should be a way to turn that off so that only the calling algorithm is logged. The calling algorithm is currently not logged.

[Mathieu Doucet]

(In [9015]) Exposed createSubAlgorithm to python. Re #2270

[Mathieu Doucet]

(In [9034]) Added an executeSubAlg() method to PythonAlgorithm. It creates and runs a sub-alg with the provided parameters. Re #2270

[Mathieu Doucet]

(In [9035]) Fix bad error message. Re #2270

[Mathieu Doucet]

(In [9036]) Fixed minor bug/typo Re #2270

[Mathieu Doucet]

(In [9052]) Properly convert pars to string. Re #2270

[Mathieu Doucet]

(In [9054]) Added test for new python alg functionality. Re #2270

[Mathieu Doucet]

PythonAlgorithms can now execute a sub-algo that will behave like those called from a C++ Algorithm (among other things, they won't log themselves). Private methods have been added to transfer ownership of the intermediate workspaces. Those could eventually go away if we add the functionality to get/set Algorithm properties in their correct type instead of using strings.

Example code from PythonAlgorithm.PyExec:

a = self.executeSubAlg(CreateWorkspace, OutputWorkspace=output_ws, DataX=[0,1,2], DataY=[0,1,2], DataE=[0,0,0])
self._setWorkspaceProperty("OutputWorkspace", a._getWorkspaceProperty("OutputWorkspace"))

See test/PythonAlgorithmTest.py for unit tests.

[Mathieu Doucet]

(In [9056]) skip test until I figure out why it fails. Re #2270

[Mathieu Doucet]

(In [9058]) Fixing test. Re #2270

[Mathieu Doucet]

(In [9059]) Fixing test. Re #2270

[Mathieu Doucet]

(In [9061]) skip test until I figure out why it fails. Re #2270

[Mathieu Doucet]

(In [9065]) Fix issue with older version of python. Re #2270

[Mathieu Doucet]

(In [9066]) This now should pass... finally. Re #2270

[Mathieu Doucet]

(In [9091]) Small change to allow a PythonAlg to call a PythonAlg as a sub-alg. Re #2270

[Martyn Gigg]

Tested in 1.1.9533

Tested with

class SubAlgTest(PythonAlgorithm):
	
	def PyInit(self):
		self.declareProperty("Value",1,Direction=Direction.Input)
		self.declareWorkspaceProperty("OutputWorkspace","",Direction=Direction.Output)
		
	def PyExec(self):
		value = self.getProperty("Value")
		child = self.executeSubAlg(CreateWorkspace,DataX=[value],DataY=[value],DataE=[value])
		self.setProperty("OutputWorkspace", child._getWorkspaceProperty("OutputWorkspace"))
		
mtd.registerPyAlgorithm(SubAlgTest())

Verified that CreateWorkspace did not log or store it's workspace in the ADS.

[Stuart Campbell]

This ticket has been transferred to github issue ​3117