weaver.processes.wps3_process

Module Contents

weaver.processes.wps3_process.LOGGER[source]
class weaver.processes.wps3_process.Wps3RemoteJobProgress[source]

Progress of a remotely monitored WPS-1 job process execution.

Note

Implementations can reuse same progress values or intermediate ones within the range of the relevant sections.

PROVIDER = 1[source]
PREPARE = 2[source]
DEPLOY = 3[source]
VISIBLE = 4[source]
READY = 5[source]
EXECUTION = 9[source]
MONITORING = 10[source]
FETCH_OUT = 90[source]
COMPLETED = 100[source]
class weaver.processes.wps3_process.Wps3Process(step_payload: Ellipsis, job_order: weaver.typedefs.CWL_RuntimeInputsMap, process: str, request: weaver.wps.service.WorkerRequest, update_status: weaver.typedefs.UpdateStatusPartialFunction)[source]

Common interface for WPS Process to be used for dispatching CWL jobs.

Multiple convenience methods are provided. Processes inheriting from this base should implement required abstract methods and override operations as needed.

Note

For expected operations details and their execution order, please refer to Workflow Step Operations.

See also

execute() for complete details of the operations and ordering.

resolve_data_source(step_payload: weaver.typedefs.CWL, job_order: weaver.typedefs.CWL_RuntimeInputsMap) Tuple[str, str, weaver.typedefs.JSON][source]
get_user_auth_header() weaver.typedefs.HeadersType[source]
get_auth_headers() weaver.typedefs.AnyHeadersContainer[source]

Add specific user access headers for ADES if provided in Configuration Settings.

is_deployed()[source]
is_visible() Union[bool, None][source]

Gets the process visibility.

Returns

True/False correspondingly for public/private if visibility is retrievable, False if authorized access but process cannot be found, None if forbidden access.

set_visibility(visibility)[source]
describe_process()[source]
deploy()[source]
prepare() None[source]

Implementation dependent operations to prepare the Process for Job execution.

This is an optional step that can be omitted entirely if not needed.

format_outputs(workflow_outputs: weaver.typedefs.JobOutputs) weaver.typedefs.JobOutputs[source]

Implementation dependent operations to configure expected outputs for Job execution.

This is an optional step that will simply pass down the outputs as is if no formatting is required. Otherwise, the implementing Process can override the step to reorganize workflow step outputs into the necessary format required for their dispatch() call.

dispatch(process_inputs: weaver.typedefs.JobInputs, process_outputs: weaver.typedefs.JobOutputs) Any[source]

Implementation dependent operations to dispatch the Job execution to the remote Process.

Returns

reference details that will be passed to monitor().

monitor(monitor_reference: str) bool[source]

Implementation dependent operations to monitor the status of the Job execution that was dispatched.

This step should block execute() until the final status of the remote Job (failed/success) can be obtained.

Returns

success status

get_job_status(job_status_uri: weaver.typedefs.JobMonitorReference, retry: Union[bool, int] = True) weaver.typedefs.JSON[source]

Obtains the contents from the Job status response.

get_results(monitor_reference: str) weaver.typedefs.JobResults[source]

Obtains produced output results from successful job status ID.