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

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

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

from fastapi import BackgroundTasks

fastapi.BackgroundTasks

BackgroundTasks(tasks=None)

ベース: 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: 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)

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

FastAPIのバックグラウンドタスクに関するドキュメントで詳細を読むことができます。

パラメータ	説明
func	レスポンス送信後に呼び出す関数。 通常のdef関数でもasync def関数でも構いません。 型: 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)