Skip to content

Task Workers

Workers process queued tasks that cannot be handled by the web client.

Tasks can be created either via the Python API, for example in other workers, or via authenticated users.

By default, running the subfork worker command will pull tasks from a specified queue and process them.

$ subfork worker [--queue <queue> --func <pkg.mod.func>]

For example:

$ subfork worker --queue test --func subfork.worker.test

Will poll the test queue for new tasks, and run the function subfork.worker.test. Workers can also be defined in the subfork.yml file, and can contain more than one worker specification:

workers:
  worker1:
    queue: test
    function: subfork.worker.test
  worker2:
    queue: stress
    function: subfork.worker.stress

Creating tasks

To create a task, pass a function kwargs dict to a named task queue, for example, to pass t=3 to worker2 defined above:

sf = subfork.get_client()
task = sf.get_queue("test").create_task({"t": 3})

Getting results

To get the results of completed tasks:

task = sf.get_queue("test").get_task(taskid)
task.get_results()