matflow.Command#

class matflow.Command(command: Optional[str] = None, executable: Optional[str] = None, arguments: Optional[List[str]] = None, variables: Optional[Dict[str, str]] = None, stdout: Optional[str] = None, stderr: Optional[str] = None, stdin: Optional[str] = None, rules: Optional[List[matflow.ActionRule]] = <factory>)#

Bases: Command

Methods

from_json_like

get_command_line

Return the resolved command line.

get_output_types

get_required_executables

Return executable labels required by this command.

process_std_stream

to_dict

to_json_like

Attributes

app

arguments

command

executable

stderr

stdin

stdout

variables

rules

Parameters:
  • command (str | None) –

  • executable (str | None) –

  • arguments (List[str] | None) –

  • variables (Dict[str, str] | None) –

  • stdout (str | None) –

  • stderr (str | None) –

  • stdin (str | None) –

  • rules (List[ActionRule] | None) –

app = App(name='MatFlow', version='0.3.0a129')#
arguments: List[str] | None = None#
command: str | None = None#
executable: str | None = None#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:
  • json_like (Union[Dict, List]) –

  • shared_data (Optional[Dict[str, ObjectList]]) –

get_command_line(EAR, shell, env)#

Return the resolved command line.

This is ordinarily called at run-time by Workflow.write_commands.

Return type:

Tuple[str, List[Tuple[str, str]]]

get_output_types()#
get_required_executables()#

Return executable labels required by this command.

Return type:

List[str]

process_std_stream(name, value, stderr)#
Parameters:
  • name (str) –

  • value (str) –

  • stderr (bool) –

rules: List[app.ActionRule] | None#
stderr: str | None = None#
stdin: str | None = None#
stdout: str | None = None#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
variables: Dict[str, str] | None = None#