flowserv.view.workflow module

Serializer for workflow resources.

class flowserv.view.workflow.WorkflowSerializer(groups: Optional[flowserv.view.group.WorkflowGroupSerializer] = None, runs: Optional[flowserv.view.run.RunSerializer] = None)

Bases: object

Default serializer for workflow resource objects. Defines the methods that are used to serialize workflow descriptors, handles, and listing.

workflow_descriptor(workflow: flowserv.model.base.WorkflowObject) → Dict

Get dictionary serialization containing the descriptor of a workflow resource.

Parameters: workflow (flowserv.model.base.WorkflowObject) – Workflow descriptor.
Return type: dict

workflow_handle(workflow: flowserv.model.base.WorkflowObject, postproc: Optional[flowserv.model.base.RunObject] = None, groups: Optional[List[flowserv.model.base.GroupObject]] = None) → Dict

Get dictionary serialization containing the handle of a workflow resource.

Parameters

workflow (flowserv.model.base.WorkflowObject) – Workflow handle
postproc (flowserv.model.base.RunObject) – Handle for workflow post-porcessing run.
groups (list(flowserv.model.base.GroupObject), default=None) – Optional list of descriptors for workflow groups for an authenticated user.

Return type

dict

Get dictionary serialization for a workflow evaluation leaderboard.

Parameters

workflow (flowserv.model.base.WorkflowObject) – Workflow handle
leaderboard (flowserv.model.ranking.ResultRanking) – List of entries in the workflow evaluation leaderboard
postproc (flowserv.model.base.RunObject) – Handle for workflow post-porcessing run.

Return type

dict

workflow_listing(workflows: List[flowserv.model.base.WorkflowObject]) → Dict

Get dictionary serialization of a workflow listing.

Parameters: workflows (list(flowserv.model.base.WorkflowObject)) – List of workflow descriptors
Return type: dict