subparser for choices module

[redrn]

Implement CLI subparser for choices module, functionalities include but not limited to:

• define choices
• edit choices
• remove choices
• apply choices to parts

[redrn]

Specific CLI subcommand interface:

Add a new chooser:

stepcvt choices add-chooser [--type TYPE] TEXT VARNAME (TEXT:VARNAME[:COND])+

• Specify chooser type, options are {single, multi, boolean} default is a SingleChooser
• Specify text and varname of the Chooser
• Specify a list of ChoiceValue, in the format of TEXT:VARNAME[:COND]
  • text:varname:condition are fields of ChoiceValue separated by :, condition is optional

Add a new choice effect:

stepcvt choices add-effect --partid PARTID --type TYPE --value VALUE --cond COND

• Specify partid of the part info for this choice effect to be added
• Specify type of the choice effect, available choices are {select, relative-count, absolute-count}
• Value argument for the choice effect, for example, count_delta for relative-count choice effect. Not required for select choice effect since that type only relies on condition
• Specify a condition, or a choice variable dependency for this choice effect to apply.

Replace a component of a chooser:

stepcvt choices edit VARNAME [--choice-value TEXT] (TEXT:VARNAME[:COND])+

• Specify varname of the Chooser to edit
• Optionally, specify value of the ChoiceValue in the specified Chooser to replace
  • If --choice-value is not set, replace the entire ChoiceValue array in the specified Chooser
• Provide list of replacement ChoiceValue, in the format TEXT:VARNAME[:COND]

Remove a chooser or a component of it

stepcvt choices remove VARNAME [--choice-value TEXT] [--cond]

• Specify varname of the chooser to remove
• Optionally, specify text of a ChoiceValue to remove the ChoiceValue instead of the chooser
• Optionally, specify --cond to indicate removing the condition of the ChoiceValue.

Apply user choices

stepcvt choices apply (VARNAME=VALUE(,EXTRA_VALUES)*)+

• User choices are specified in the format of varname=value(,extra_values)*
  • varname specifies the name of the chooser
  • value(,extra_values) is the value the user provided for the given chooser. This could be a comma separated list.

Examples

stepcvt -j file.json choices add-chooser --choice-type single "Printer Options" "options" "HEPA filter":"Filter" "Build area lights":"Lights":"version=='V6'"

Add a SingleChooser with potential values of 'Filter' and 'Lights' that requires 'version == V6'.

stepcvt -j file.json choices add-effect --partid SB_V6_TH_Front --type relative-count --value 2 --cond version=='V6'

Add a relative count choice effect for the part SB_V6_TH_Front, dependent on choice variable version=='V6'.

stepcvt -j file.json choices edit "options" --choice-value "Lights" "Build area lights":"Lights":"version=='V4'"

Change the 'Lights' choice value in the 'options' chooser to have a different version requirement.

stepcvt -j file.json choices remove "options" --choice-value "Lights" --cond

Remove the precondition requirement for the 'Lights' option.

stepcvt -j file.json choices apply Version=V6 Options=Lights,Filter

Apply user choices of version 'V6' and 'Lights' and 'Filter' options enabled

[redrn]

TODO: add support for ChoiceEffect classes

[sree314]

Roy, could you add examples for each of the command line options above. That may help clarify what the command is supposed to do, and how to use it.

[redrn]

Roy, could you add examples for each of the command line options above. That may help clarify what the command is supposed to do, and how to use it.

Updated the documentation to include examples, pulled from comments in the code.

[redrn]

TODO: change apply subcommand to prompt the user for selecting choices and then either 1) export all based on user chocices 2) apply choices calculation and strip all choices information for the new json config

Edit: Finished and merged in cli in commit d6b434d

[redrn]

All intended functionalities are completed and tested. We can work on simplifying the interface later. Closing as of now