Runner

class Runner(
    *,
    tasks: list[type[Task]] | None = None,
    cache: JobCache | None = None,
    context: type[RunnerContext] | None = None,
)

Copy

Define task registrations for a Python workflow project.

A Runner object is a reusable definition. Use it for direct execution by connecting it to a Client, or reference it from tilebox.workflow.toml so release runners can load the same task registrations from a workflow release.

Parameters

tasks list[type[Task]] | None

A list of task classes this runner can execute.

cache JobCache | None

Optional job cache used by tasks executed by this runner.

context type[RunnerContext] | None

Optional runner context class to instantiate for tasks executed by this runner.

Example

Python

from tilebox.workflows import Runner
from tilebox.workflows.cache import LocalFileSystemCache

from my_workflow.tasks import MyRootTask, MySubtask


runner = Runner(
    tasks=[MyRootTask, MySubtask],
    cache=LocalFileSystemCache(),
)

Copy

You can also register tasks after creating a runner:

Python

runner = Runner(cache=LocalFileSystemCache())
runner.register(MyRootTask)
runner.register(MySubtask)

Copy

Use the same object for direct execution:

Python

from tilebox.workflows import Client

from my_workflow.runner import runner


runner.connect_to(Client(), cluster="dev-cluster").run_forever()

Copy

Or reference it from tilebox.workflow.toml for release execution:

[workflow]
slug = "my-workflow"
root = "."
runner = "my_workflow.runner:runner"

Copy