flowserv.model.template.files module

Classes to maintain of workflow output file specifications.

class flowserv.model.template.files.WorkflowOutputFile(source: str, title: Optional[str] = None, key: Optional[str] = None, caption: Optional[str] = None, format: Optional[Dict] = None, widget: Optional[Dict] = None)

Bases: object

Information about workflow output files that are accessible as resources for successful workflow runs. The majority of properties that are defined for output files are intended to be used by applications that display the result of workflow runs. For each output file the following information may be specified:

  • source: relative path the the file in the run folder

  • key: Unique key that is assigned to the resource for dictionary access

  • title: optional title for display purposes

  • caption: optional caption for display purposes

  • format: optional format information for file contents.

  • widget: optional instructions for widget used to display file contents.

classmethod from_dict(doc, validate=True)

Create object instance from dictionary serialization.

Parameters

  • doc (dict) – Dictionary serialization for a workflow output file.

  • validate (bool, default=True) – Validate the serialization if True.

Return type

flowserv.model.template.files.WorkflowOutputFile

Raises

ValueError –

to_dict()

Get dictionary serialization for the output file specification.

Return type

dict