hpcflow.app.TaskSchema#

class hpcflow.app.TaskSchema(objective, actions=None, method=None, implementation=None, inputs=None, outputs=None, version=None, _hash_value=None)#

Bases: TaskSchema

Class to represent the inputs, outputs and implementation mechanism of a given task.

Parameters:

  • objective (TaskObjective | str) – This is a string representing the objective of the task schema.

  • actions (List[Action]) – A list of Action objects whose commands are to be executed by the task.

  • method (str | None) – An optional string to label the task schema by its method.

  • implementation (str | None) – An optional string to label the task schema by its implementation.

  • inputs (List[Parameter | SchemaInput] | None) – A list of SchemaInput objects that define the inputs to the task.

  • outputs (List[Parameter | SchemaOutput] | None) – A list of SchemaOutput objects that define the outputs of the task.

  • version (str | None) –

  • _hash_value (str | None) –

Methods

from_json_like

get_by_key

Get a config-loaded task schema from a key.

get_key

get_parameter_dependence

Find if/where a given parameter is used by the schema's actions.

ignore_invalid_actions

make_persistent

to_dict

to_json_like

Attributes

app

info

Show attributes of the task schema.

input_types

name

output_types

provides_parameters

task_template

app = BaseApp(name='hpcFlow', version='0.2.0a97')#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:

  • json_like (Union[Dict, List]) –

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

classmethod get_by_key(key)#

Get a config-loaded task schema from a key.

get_key()#
get_parameter_dependence(parameter)#

Find if/where a given parameter is used by the schema’s actions.

Parameters:

parameter (SchemaParameter) –

classmethod ignore_invalid_actions()#
property info#

Show attributes of the task schema.

property input_types#
make_persistent(workflow, source)#
Parameters:
Return type:

List[int]

property name#
property output_types#
property provides_parameters: Tuple[Tuple[str, str]]#
property task_template#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#