API Reference

flowser.domain

class flowser.domain.Domain(conn)

Represents a Simple Workflow domain.

Subclasses must set a name property. They may also set a retention_period property (defaults to ‘30’).

To register types, workflow_types and activity_types need to be set. They should be lists of types.Workflow and types.Activity subclasses.

activities(t)

High-level interface to iterate over activity tasks.

This method polls for new tasks of the given type indefinitely.

Parameters:t – Subclass of types.Type.

activity_types = None

decisions(t)

High-level interface to iterate over decision tasks.

This method polls for new tasks of the given type indefinitely.

Parameters:t – Subclass of types.Type.

register(raise_exists=False)

Register domain and associated types on AWS.

retention_period = '30'

start(t, input)

Start execution.

Internally, this method creates an instance of t and calls its start method with the given input.

Parameters:t – Subclass of types.Type.

workflow_types = None

flowser.types

class flowser.types.Activity(domain)

Base class for activity types.

Subclasses must set name, task_list and version properties and implement a schedule class method.

heartbeat_timeout = '3600'

classmethod schedule(input, control=None)

Called from subclasses’ schedule class method.

schedule_to_close_timeout = '3600'

schedule_to_start_timeout = '3600'

start_to_close_timeout = '3600'

class flowser.types.Type(domain)

Base class for Simple Workflow types (activities, workflows).

Subclasses must set name, version and task_list properties. They must also implement get_id_from_input.

static get_id_from_input(input)

Get id from input.

This class method is used to get unique workflow and activity ids.

A typical implementation may retrieve and id field from the input and append it to the class’s task list.

Parameters:input – Input used when starting and scheduling workflows and tasks.

class flowser.types.Workflow(domain)

Base class for workflow types.

Subclasses must set name and task_list properties and implement a start method and a start_child class method.

child_policy = 'TERMINATE'

default_filter_tag = None

default_tag_list = None

execution_start_to_close_timeout = '600'

classmethod start_child(input, control=None)

Start child workflow execution.

input is serialized and a workflow id is generated from it using get_id_from_input.

task_start_to_close_timeout = '120'

flowser.tasks

class flowser.tasks.Activity(result, caller)

Wrapper for “PollForActivityTask” results.

See http://docs.amazonwebservices.com/amazonswf/latest/apireference/API_PollForActivityTask.html.

cancel(details=None)

complete(result=None)

fail(details=None, reason=None)

class flowser.tasks.ActivityType(result)

Wrapper for the API data type.

See http://docs.amazonwebservices.com/amazonswf/latest/apireference/API_ActivityType.html.

class flowser.tasks.Decision(result, caller)

Wrapper for “PollForDecisionTask” results.

See http://docs.amazonwebservices.com/amazonswf/latest/apireference/API_PollForDecisionTask.html.

This class assumes that history events are in reverse order (most recent first).

complete(context=None)

events

fail(details=None, reason=None)

filter(event_type)

mark(name, details=None)

Adds a RecordMarker decision.

most_recent(event_type)

schedule(activity_type, *args, **kwargs)

Schedule activity.

Internally, this method calls the schedule classmethod on the activity type with the given args and kwargs.

Parameters:activity_type – Subclass of types.Activity.

start_child(workflow_type, *args, **kwargs)

Start child workflow.

Internally, this method calls the start_child classmethod on the workflow type with the given args and kwargs.

Parameters:workflow_type – Subclass of types.Workflow.

start_input

Get start input as a python object.

This method iterates over the event history to find the WorkflowExecutionStarted event and unserializes its input attribute. The result is cached.

class flowser.tasks.WorkflowExecution(result, caller)

Wrapper for the API data type.

See http://docs.amazonwebservices.com/amazonswf/latest/apireference/API_WorkflowExecution.html.

abandon(details=None, reason=None)

complete(result, context=None)

Complete workflow execution.

This can only be called from a decision task.

request_cancel()

signal(name, input=None)

terminate(details=None, reason=None)

terminate_request_cancel(details=None, reason=None)

class flowser.tasks.WorkflowType(result)

Wrapper for the API data type.

See http://docs.amazonwebservices.com/amazonswf/latest/apireference/API_WorkflowType.html.

flowser.exceptions

exception flowser.exceptions.EmptyTaskPollResult

exception flowser.exceptions.Error

exception flowser.exceptions.LastPage