Python Function Decorator

In addition to the taskbadger.Task class and utility functions, there is also a function decorator that can be used to automatically create a task when a function is called.

from taskbadger import track

@track("my task")
def my_function():
    pass

Using the decorator will create a task with the name provided and automatically update the task status to success when the function completes or error if an exception is raised.

The decorator also applies the taskbadger.Session context manager to the function. See connection management.

When the function raises, the exception is recorded on the task data along with any context from the configured context providers.

Nested tasks

Since v2.5.0

Tasks tracked by another integration while a decorated function is running are nested under its task via the parent field. That means other @track decorated functions called from the body, as well as Celery and Procrastinate tasks enqueued from it. A bare Task.create in the function body is not nested unless you pass parent yourself.

Each integration carves out some exceptions — Celery, for instance, doesn't nest chain successors, link callbacks, or canvas primitives running on a worker. The Celery and Procrastinate pages list what does and doesn't get nested.

Tasks nest a single level deep, so anything created by a decorated function that is itself a child becomes a sibling of that child rather than a grandchild. Passing parent to the decorator explicitly overrides the automatic nesting.

API Docs

taskbadger.track

track(
    func=None,
    *,
    name: str = None,
    monitor_id: str = None,
    max_runtime: int = None,
    **task_kwargs,
)

Decorator to track a function as a task.

Usage:

import taskbadger

@taskbadger.track
def test(arg):
    print(arg)

Parameters:

Name	Type	Description	Default
name	str	The name of the task. Defaults to the fully qualified name of the function.	None
monitor_id	str	The ID of the monitor to associate the task with.	None
max_runtime	int	The maximum runtime of the task in seconds. If the task takes longer than this, it will be marked as an error.	None
**kwargs		See taskbadger.create_task	required