Background Tasks -`BackgroundTasks`¶

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

You can import it directly fromfastapi:

fromfastapiimportBackgroundTasks

fastapi.BackgroundTasks¶

BackgroundTasks(tasks=None)

Bases:BackgroundTasks

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

Read more about it in theFastAPI docs for Background Tasks.

Example¶

fromfastapiimportBackgroundTasks,FastAPIapp=FastAPI()defwrite_notification(email:str,message=""):withopen("log.txt",mode="w")asemail_file:content=f"notification for{email}:{message}"email_file.write(content)@app.post("/send-notification/{email}")asyncdefsend_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 instarlette/background.py

3233	`def__init__(self,tasks:typing.Sequence[BackgroundTask]\|None=None):self.tasks=list(tasks)iftaskselse[]`

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)iftaskselse[]

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 theFastAPI 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 infastapi/background.py

38394041424344454647484950515253545556575859

defadd_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.tiangolo.com/tutorial/background-tasks/).    """returnsuper().add_task(func,*args,**kwargs)

Movatterモバイル変換

Background Tasks -BackgroundTasks¶

fastapi.BackgroundTasks¶

Example¶

funcinstance-attribute¶

argsinstance-attribute¶

kwargsinstance-attribute¶

is_asyncinstance-attribute¶