Rename bug when workspace variable is in Python

[Martyn Gigg]

• Run this is Python to produce a workspace called 'ws1'

  ws1 = Load('MAR11001.raw')
  

• Use the dock to rename the workspace to 'ws2'
• Rerun the above python snippet.
• Instead of producing a new ws1, it will produce ws2

[Nick Draper]

Although I'm not sure what the solution is here, as the implications of changing the underlying behaviour need to be carefully considered

[Martyn Gigg]

The current framework underneath tries to be clever with the naming so that you can do this:

def convert(workspace):
    # Replace the input workspace
    workspace = simpleapi.ConvertUnits(workspace, Target='Energy')
    return workspace
        
raw = simpleapi.LoadRaw('IRS21360.raw',SpectrumMax=1)
raw = convert(raw)

and still have it replace the workspace and not create a new one called 'workspace'.

I think the way forward is to move back to the simple approach of saying the workspace takes the LHS name and to replace in a function requires using the other syntax:

def convert(workspace):
    # Replace the input workspace
    simpleapi.ConvertUnits(InputWorkspace=workspace, OutputWorkspace=workspace,Target='Energy')
    return workspace
        
raw = simpleapi.LoadRaw('IRS21360.raw',SpectrumMax=1)
raw = convert(raw)

Changing the current behaviour will fix the more critical and confusing rename bug and anyone using the new-style function syntax will get an error when there workspace doesn't have the correct name.

[Martyn Gigg]

Fix rename bug in simpleapi. Refs #6108

Changeset: 86b95e8f80067c1766779f723146ddff18ea0554

[Martyn Gigg]

Tester: Check the steps in the first description now do the correct thing. Also play with the python in comment #2 and check that the output makes sense and that the workspace is correct.

[Stuart Campbell]

This ticket has been transferred to github issue ​6954