バックグラウンドタスク - BackgroundTasks

パス操作関数 または依存関係関数で、型を BackgroundTasks としてパラメータを宣言できます。これにより、レスポンスが送信された後にバックグラウンドタスクの実行をスケジュールできます。

fastapiから直接インポートできます。

from fastapi import BackgroundTasks

fastapi.BackgroundTasks

BackgroundTasks(tasks=None)

Bases: BackgroundTasks

レスポンスがクライアントに送信された後に呼び出されるバックグラウンドタスクのコレクション。

詳細については、FastAPI のバックグラウンドタスクに関するドキュメントをお読みください。

例

from fastapi import BackgroundTasks, FastAPI

app = FastAPI()


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"}

starlette/background.py のソースコード

def __init__(self, tasks: 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)

レスポンス送信後にバックグラウンドで呼び出される関数を追加します。

詳細については、FastAPI のバックグラウンドタスクに関するドキュメントをお読みください。

パラメータ	説明
func	レスポンス送信後に呼び出される関数。 これは通常の def 関数でも async def 関数でも構いません。 TYPE: Callable[P, Any]

fastapi/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
    [FastAPI docs for Background Tasks](https://fastapi.dokyumento.jp/tutorial/background-tasks/).
    """
    return super().add_task(func, *args, **kwargs)