Ticket #11128 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Algorithm history script generation gives output parameters a value

Reported by: Dan Nixon Owned by: Dan Nixon
Priority: major Milestone: Release 3.4
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester: Federico M Pouzols

Description (last modified by Dan Nixon) (diff)

Running the following script:

grouping_ws = CreateGroupingWorkspace(InstrumentName='IRIS', FixedGroupCount=10, ComponentName='graphite')

Gives the following script when exported to Python via the history dialog:

CreateGroupingWorkspace(InstrumentName='IRIS', FixedGroupCount=10, ComponentName='graphite', OutputWorkspace='grouping_ws', NumberGroupedSpectraResult=50, NumberGroupsResult=10)

This is attempting to assign values to two output properties: NumberGroupedSpectraResult and NumberGroupsResult.

This does not affect the algorithm but could be confusing to users, the only output properties that should be included in the script are workspace properties that define the name of the output workspace.

Change History

comment:1 Changed 6 years ago by Dan Nixon

  • Description modified (diff)

comment:2 Changed 6 years ago by Dan Nixon

  • Description modified (diff)

comment:3 Changed 6 years ago by Dan Nixon

  • Status changed from new to assigned
  • Owner set to Dan Nixon

comment:4 Changed 6 years ago by Dan Nixon

  • Status changed from assigned to inprogress

Ignore non workspace output properties in ScriptBuilder

Refs #11128

Changeset: 2178ddfce445989313f536f84911327b61baa0f6

comment:5 Changed 6 years ago by Dan Nixon

Extend unit test to test the original failure case

Adds an output parameter set by the algorithm which would have previously been added to the script output.

Refs #11128

Changeset: 77a79f6fec5155161cc85e6f3c957c821208867e

comment:6 Changed 6 years ago by Dan Nixon

  • Status changed from inprogress to verify
  • Resolution set to fixed

This is being verified as pull request #265.

comment:7 Changed 6 years ago by Dan Nixon

  • Milestone changed from Backlog to Release 3.4

comment:8 Changed 6 years ago by Dan Nixon

Ran clang format on modified files

Refs #11128

Changeset: 0f3c593260db8d9f768757d268f0196fcbcea07f

comment:9 Changed 6 years ago by Federico M Pouzols

  • Status changed from verify to verifying
  • Tester set to Federico M Pouzols

comment:10 Changed 6 years ago by Federico M Pouzols

It works, after the changes, NumberGroupedSpectraResult, and NumberGroupsResult are not included in the script generated. OutputWorkspace is still there as it should.

comment:11 Changed 6 years ago by Dan Nixon

Ignore non workspace output properties in ScriptBuilder

Refs #11128

Changeset: 2178ddfce445989313f536f84911327b61baa0f6

comment:12 Changed 6 years ago by Dan Nixon

Extend unit test to test the original failure case

Adds an output parameter set by the algorithm which would have previously been added to the script output.

Refs #11128

Changeset: 77a79f6fec5155161cc85e6f3c957c821208867e

comment:13 Changed 6 years ago by Dan Nixon

Ran clang format on modified files

Refs #11128

Changeset: 0f3c593260db8d9f768757d268f0196fcbcea07f

comment:14 Changed 6 years ago by Federico M Pouzols

  • Status changed from verifying to closed

Merge pull request #265 from mantidproject/11128_algorithm_history_script_ignore_non_ws_output_props

Algorithm history script generation should ignore non WS output properties

Full changeset: b4c62ec14f73195ef15b71984db2f1d5e8485fbf

comment:15 Changed 5 years ago by Nick Draper

Somehow these slipped through without a resolution. Set to Fixed.

comment:16 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 11967

Note: See TracTickets for help on using tickets.