flowserv.client.cli.parameter module

Helper methods for reading workflow template parameters.

flowserv.client.cli.parameter.read(parameters: List[flowserv.model.parameter.base.Parameter], scanner: Optional[flowserv.scanner.Scanner] = None, files: Optional[Tuple[str, str, str]] = None) → Dict

Read values for each of the template parameters using a given input scanner. If no scanner is given, values are read from standard input.

The optional list of file handles is used for convenience when the user is asked to input the identifier of an uploaded file. It allows to display the identifier of available files for easy copy and paste.

Returns a dictionary of argument values that can be passed to the workflow execution engine to run a parameterized workflow.

Parameters

  • parameters (list(flowserv.model.parameter.base.Parameter)) – List of workflow template parameter declarations

  • scanner (flowserv.scanner.Scanner) – Input scanner to read parameter values

  • files (list, default=None) – List of tuples representing uploaded files. Each tuple has three elements: file_id, name, timestamp.

Return type

dict

flowserv.client.cli.parameter.read_file(para: flowserv.model.parameter.base.Parameter, scanner: flowserv.scanner.Scanner, files: Optional[Tuple[str, str, str]] = None)

Read value for a file parameter.

Parameters

  • para (flowserv.model.parameter.base.Parameter) – Workflow template parameter declaration

  • scanner (flowserv.scanner.Scanner) – Input scanner.

  • files (list, default=None) – List of tuples representing uploaded files. Each tuple has three elements: file_id, name, timestamp.

flowserv.client.cli.parameter.read_parameter(para: flowserv.model.parameter.base.Parameter, scanner: flowserv.scanner.Scanner, files: Optional[Tuple[str, str, str]] = None) → Any

Read value for a given template parameter declaration. Prompts the user to enter a value for the given parameter and returns the converted value that was entered by the user.

Parameters

  • para (flowserv.model.parameter.base.Parameter) – Workflow template parameter declaration

  • scanner (flowserv.scanner.Scanner) – Input scanner.

  • files (list, default=None) – List of tuples representing uploaded files. Each tuple has three elements: file_id, name, timestamp.

Return type

bool or float or int or string or tuple(string, string)