Background Tasks - BackgroundTasks

You can declare a parameter in a path operation function or dependency function with the type BackgroundTasks, and then you can use it to schedule the execution of background tasks after the response is sent.

You can import it directly from readyapi:

from readyapi import BackgroundTasks

readyapi.BackgroundTasks

BackgroundTasks(tasks=None)

Bases: BackgroundTasks

A collection of background tasks that will be called after a response has been sent to the client.

Read more about it in the ReadyAPI docs for Background Tasks.

Example

from readyapi import BackgroundTasks, ReadyAPI

app = ReadyAPI()


def write_notification(email: str, message=""):
    with open("log.txt", mode="w") as email_file:
        content = f"notification for {email}: {message}"
        email_file.write(content)


@app.post("/send-notification/{email}")
async def send_notification(email: str, background_tasks: BackgroundTasks):
    background_tasks.add_task(write_notification, email, message="some notification")
    return {"message": "Notification sent in the background"}

PARAMETER	DESCRIPTION
tasks	TYPE: Sequence[BackgroundTask] | None DEFAULT: None

Source code in starlette/background.py

def __init__(self, tasks: typing.Sequence[BackgroundTask] | None = None):
    self.tasks = list(tasks) if tasks else []

func instance-attribute

func = func

args instance-attribute

args = args

kwargs instance-attribute

kwargs = kwargs

is_async instance-attribute

is_async = is_async_callable(func)

tasks instance-attribute

tasks = list(tasks) if tasks else []

add_task

add_task(func, *args, **kwargs)

Add a function to be called in the background after the response is sent.

Read more about it in the ReadyAPI docs for Background Tasks.

PARAMETER	DESCRIPTION
func	The function to call after the response is sent. It can be a regular def function or an async def function. TYPE: Callable[P, Any]
*args	TYPE: args DEFAULT: ()
**kwargs	TYPE: kwargs DEFAULT: {}

Source code in readyapi/background.py

def add_task(
    self,
    func: Annotated[
        Callable[P, Any],
        Doc(
            """
            The function to call after the response is sent.

            It can be a regular `def` function or an `async def` function.
            """
        ),
    ],
    *args: P.args,
    **kwargs: P.kwargs,
) -> None:
    """
    Add a function to be called in the background after the response is sent.

    Read more about it in the
    [ReadyAPI docs for Background Tasks](https://readyapi.github.io/tutorial/background-tasks/).
    """
    return super().add_task(func, *args, **kwargs)