FastAPI Backend Development Bootcamp · レッスン

バックグラウンドタスクの実行

時間のかかる処理をバックグラウンドタスクに移し、APIのブロックを防いでユーザー体験を向上させる方法を学びます。

「バックグラウンドタスクの実行」はCoddyKit上の無料FastAPI Backend Development Bootcampレッスンです。これはレッスン3/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはFastAPI Backend Development Bootcamp学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 FastAPI Backend Development Bootcampコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Slow Endpoints & UX

Imagine your API needs to do something time-consuming, like sending an email or processing a large file, after a user request.

If your API waits for these tasks to finish before responding, the user experiences a slow, unresponsive application. This is called a blocking operation.

Bad user experience often leads to users abandoning your app!

Blocking vs. Non-Blocking APIs

Think of it like ordering food:

Blocking: You order, and the waiter waits for your food to be cooked, served, and eaten before taking the next order. (Terrible service!)
Non-Blocking: You order, the waiter takes your order to the kitchen, and immediately takes the next customer's order. Your food is prepared in the background.

We want our APIs to be non-blocking for a smooth user experience.

Meet FastAPI's BackgroundTasks

FastAPI provides a simple way to run operations in the 'background' after sending the HTTP response to the client. This is done using the BackgroundTasks dependency.

BackgroundTasks lets you add functions to a list that will be executed once the main API route has completed and the response has been delivered.

Injecting BackgroundTasks

To use background tasks, you simply declare a parameter with the type BackgroundTasks in your path operation function. FastAPI will automatically inject an instance of it.

Import BackgroundTasks from fastapi.
Declare a parameter, e.g., background_tasks: BackgroundTasks.
Use background_tasks.add_task() to schedule a function.

First Background Task Demo

Let's see a basic example. This task will print a message after the API response is sent. Remember to run uvicorn main:app --reload.

from fastapi import FastAPI, BackgroundTasks
import time

app = FastAPI()

def write_notification(email: str, message=""):
    time.sleep(2) # Simulate a long operation
    with open("log.txt", mode="a") as email_file:
        email_file.write(f"notification for {email}: {message}\n")
    print(f"Notification written for {email}")

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

Understanding Execution Flow

It's crucial to understand when background tasks execute:

The path operation function runs.
The HTTP response is sent back to the client.
Then, the functions added to BackgroundTasks are executed.

This means the client doesn't wait for these tasks to complete, improving perceived performance.

Passing Arguments to Tasks

You can pass any arguments your background function needs to add_task(). The first argument is the function itself, followed by its arguments.

Arguments can be positional or keyword arguments, just like calling a regular Python function.

For example: background_tasks.add_task(my_function, arg1, arg2=value).

Simulating Email Send

A common scenario for background tasks is sending emails. This can take a few seconds, which would block your user if done directly in the API route.

Here, we simulate sending an email to multiple recipients. Try it from the /docs UI!

from fastapi import FastAPI, BackgroundTasks
import asyncio # For async sleep

app = FastAPI()

async def send_email_async(recipients: list, subject: str, body: str):
    print(f"Starting email send to {recipients}...")
    await asyncio.sleep(3) # Simulate network delay for sending email
    print(f"Email '{subject}' sent to {recipients} with body: '{body}'")

@app.post("/send-marketing-email/")
async def marketing_campaign(
    recipients: list[str],
    subject: str,
    body: str,
    background_tasks: BackgroundTasks
):
    # The actual email sending is offloaded
    background_tasks.add_task(send_email_async, recipients, subject, body)
    return {"message": "Marketing email campaign initiated in background!"}

Important Considerations

While powerful, BackgroundTasks are not for everything:

Short-lived: Best for tasks that complete relatively quickly (seconds to a few minutes).
No persistence: If your FastAPI process crashes, scheduled tasks are lost.
No retry: They don't have built-in retry mechanisms for failed tasks.
Not for heavy computation: For very long-running, CPU-intensive, or fault-tolerant tasks, consider dedicated task queues like Celery, Redis Queue (RQ), or similar.

Background Task Check

You've learned about using BackgroundTasks. Which of the following statements about FastAPI's BackgroundTasks is true?

Recap: Background Tasks

We've explored how FastAPI's BackgroundTasks help keep your API responsive:

They run after the HTTP response is sent.
They're great for non-critical, relatively short-lived operations like sending notifications.
You declare them as a dependency and use add_task().
For truly long-running or critical tasks, consider external task queues.

By using background tasks, you ensure a smoother experience for your API users!

よくある質問

「バックグラウンドタスクの実行」レッスンは無料ですか？

はい。「バックグラウンドタスクの実行」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、FastAPI Backend Development Bootcampコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 FastAPI Backend Development Bootcampコースには全4レッスンが含まれています。

「バックグラウンドタスクの実行」で何を学びますか？

時間のかかる処理をバックグラウンドタスクに移し、APIのブロックを防いでユーザー体験を向上させる方法を学びます。ブラウザで直接実行するハンズオンコードでFastAPI Backend Development Bootcampを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

FastAPI Backend Development Bootcampを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのFastAPI Backend Development Bootcampは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン3/4です。

「バックグラウンドタスクの実行」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このFastAPI Backend Development Bootcampレッスンでコードを書いて実行できますか？

はい。すべてのFastAPI Backend Development Bootcampレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← FastAPI Backend Development Bootcampに戻る