✨ Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) #2944

uSpike · 2021-03-13T05:08:38Z

This adds support for the lifespan argument to the application and router, which was added in starlette.

I tidied up some of the event tests as well to promote reuse.

Fixes #2943

github-actions · 2021-03-13T05:12:26Z

📝 Docs preview for commit 8c33c94 at: https://604c4976cfdb60814a49803c--fastapi.netlify.app

codecov · 2021-03-13T05:28:20Z

Codecov Report

Patch coverage: 100.00% and no project coverage change

Comparison is base (cf73051) 100.00% compared to head (12e924d) 100.00%.

❗ Current head 12e924d differs from pull request most recent head 6adb554. Consider uploading reports for the commit 6adb554 to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##            master     #2944      /-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files          540       243    -297     
  Lines        13969      7441   -6528     
===========================================
- Hits         13969      7441   -6528

Impacted Files	Coverage Δ
fastapi/routing.py	`100.00% <ø> (ø)`
fastapi/applications.py	`100.00% <100.00%> (ø)`
tests/test_router_events.py	`100.00% <100.00%> (ø)`
fastapi/params.py	`100.00% <0.00%> (ø)`
fastapi/encoders.py	`100.00% <0.00%> (ø)`
tests/test_query.py	`100.00% <0.00%> (ø)`
fastapi/responses.py	`100.00% <0.00%> (ø)`
fastapi/exceptions.py	`100.00% <0.00%> (ø)`
fastapi/websockets.py	`100.00% <0.00%> (ø)`
... and 342 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

github-actions · 2021-03-13T05:30:02Z

📝 Docs preview for commit 12e924d at: https://604c4d9c53c6988fd2efed45--fastapi.netlify.app

nesb1 · 2021-10-21T08:31:28Z

Hi, we really need this fix, can i help with PR? There is a conflict @uSpike

meshantz · 2021-11-05T17:43:08Z

I rebased, dealt with the commit conflicts and updated a test in #4147

Kludex · 2021-11-05T17:46:49Z

@meshantz There's no need for that. If @uSpike is not able to rebase, @tiangolo will eventually see this PR and rebase himself. 😗

meshantz · 2021-11-05T18:00:42Z

One of the tests that was added was failing due to a starlette update. Saw that nothing had happened in the last 15 days, and was hoping to lend a hand.

I'd also like to see this get implemented, as it's much nicer than referencing the global app from inside of a startup or shutdown handler.

…n-context

generator lifespans were deprectated in starlette 0.16.0 https://github.com/encode/starlette/releases/tag/0.16.0

uSpike · 2021-12-19T15:53:13Z

Hi, sorry I've been out of the loop for a bit. I've rebased and cherry-picked @meshantz commit f5f1bfc into this PR.

uSpike · 2021-12-19T17:29:13Z

I've fixed typing, formatting, and updated the docs to communicate that lifespan should be an AsyncContextManager. Should be ready for review now.

mortbauer · 2022-02-13T09:58:45Z

@tiangolo this seems like a straight forward PR, please have a look if you can, would be great!!

generator lifespans were deprectated in starlette 0.16.0 https://github.com/encode/starlette/releases/tag/0.16.0

github-actions · 2023-03-06T17:35:04Z

📝 Docs preview for commit 5ae6547 at: https://64062412c1f3f7106eff7bd8--fastapi.netlify.app

github-actions · 2023-03-06T17:46:52Z

📝 Docs preview for commit 8b6dd1a at: https://640626d9f5524310c7db8154--fastapi.netlify.app

tiangolo · 2023-03-07T15:45:12Z

Thank you @uSpike! 🙇 🍰

I updated the docs to include more info and make this the recommended way from now on.

I also took the updates in #5503, thanks @JonathanPlasse ! ☕

And I added tests for the new example in the docs.

This will be available in FastAPI 0.93.0, released in the next few hours. 🎉

Sorry for the long delay! 🙈 I wanted to personally address each issue/PR and they piled up through time, but now I'm checking each one in order.

…rtup` and `shutdown` events) (fastapi#2944) Co-authored-by: Mike Shantz <[email protected]> Co-authored-by: Jonathan Plasse <13716151 [email protected]> Co-authored-by: Sebastián Ramírez <[email protected]>

uSpike added 3 commits March 12, 2021 22:56

Add lifespan context argument

bb2ec92

Add tests for lifespan context and refactor router event tests

4620732

Add lifespan docs

8c33c94

uSpike added 4 commits March 12, 2021 23:21

Fix lifespan typing

ecd6d27

Fix lifespan doc highlight

c736405

Fix event tests repeated code

bc1f5fa

Fix import sorting

12e924d

meshantz mentioned this pull request Nov 5, 2021

Add lifespan context v2 #4147

Closed

uSpike and others added 2 commits December 19, 2021 09:48

Merge branch 'master' of github.com:tiangolo/fastapi into add-lifespa…

c78ba44

…n-context

update lifespan to be an async context manager

c3a3d25

generator lifespans were deprectated in starlette 0.16.0 https://github.com/encode/starlette/releases/tag/0.16.0

uSpike added 3 commits December 19, 2021 09:58

Fix formatting

8b1dfd5

Fix type of lifespan to AsyncContextManager[Any]

48fdb76

Fix docs for lifespan asynccontextmanager

92897b3

bharathanr mentioned this pull request Jan 30, 2022

Further develop startup and shutdown events #617

Open

BilalAlpaslan approved these changes Mar 27, 2022

View reviewed changes

frederikaalund mentioned this pull request Oct 15, 2022

Simplify and extend usage documentation empicano/aiomqtt#131

Merged

JonathanPlasse mentioned this pull request Oct 16, 2022

Add lifespan context v3 #5503

Closed

yezz123 approved these changes Oct 16, 2022

View reviewed changes

tiangolo added the investigate label Nov 8, 2022

Add lifespan context argument

6f9ebea

uSpike and others added 15 commits January 17, 2023 15:32

Add tests for lifespan context and refactor router event tests

edef8c0

Add lifespan docs

76968ca

Fix lifespan typing

0dbcb35

Fix lifespan doc highlight

2712fb6

Fix event tests repeated code

d15df2d

Fix import sorting

9665645

update lifespan to be an async context manager

628aa71

generator lifespans were deprectated in starlette 0.16.0 https://github.com/encode/starlette/releases/tag/0.16.0

Fix formatting

f612d74

Fix type of lifespan to AsyncContextManager[Any]

f13274c

Fix docs for lifespan asynccontextmanager

0eed654

Use @asynccontextmanager for lifespan for test

81591ba

Use FastAPI instead of Starlette for lifespan

d60f9b8

Replace lifespan AsyncIterator by AsyncGenerator

2c05463

🔀 Merge master

5ae6547

Merge branch 'master' into add-lifespan-context-v3

0ef7cfa

🔀 Merge PR fastapi#5503 from @JonathanPlasse with updated types

8b6dd1a

tiangolo added 2 commits March 7, 2023 16:37

📝 Update docs for Lifespan events

c842bdd

✅ Add tests for new lifespan event docs

6adb554

tiangolo changed the title ~~Add lifespan context option~~ ✨ Add support for lifespan async context managers (superseding startup and shutdown events) Mar 7, 2023

tiangolo added feature New feature or request and removed investigate labels Mar 7, 2023

tiangolo merged commit cc9a73c into fastapi:master Mar 7, 2023

uSpike deleted the add-lifespan-context branch March 7, 2023 16:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) #2944

✨ Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) #2944

uSpike commented Mar 13, 2021 •

edited

Loading

github-actions bot commented Mar 13, 2021

codecov bot commented Mar 13, 2021 •

edited

Loading

github-actions bot commented Mar 13, 2021

nesb1 commented Oct 21, 2021 •

edited

Loading

meshantz commented Nov 5, 2021

Kludex commented Nov 5, 2021

meshantz commented Nov 5, 2021 •

edited

Loading

uSpike commented Dec 19, 2021 •

edited

Loading

uSpike commented Dec 19, 2021

mortbauer commented Feb 13, 2022

github-actions bot commented Mar 6, 2023

github-actions bot commented Mar 6, 2023

tiangolo commented Mar 7, 2023

✨ Add support for lifespan async context managers (superseding startup and shutdown events) #2944

✨ Add support for lifespan async context managers (superseding startup and shutdown events) #2944

Conversation

uSpike commented Mar 13, 2021 • edited Loading

github-actions bot commented Mar 13, 2021

codecov bot commented Mar 13, 2021 • edited Loading

Codecov Report

github-actions bot commented Mar 13, 2021

nesb1 commented Oct 21, 2021 • edited Loading

meshantz commented Nov 5, 2021

Kludex commented Nov 5, 2021

meshantz commented Nov 5, 2021 • edited Loading

uSpike commented Dec 19, 2021 • edited Loading

uSpike commented Dec 19, 2021

mortbauer commented Feb 13, 2022

github-actions bot commented Mar 6, 2023

github-actions bot commented Mar 6, 2023

tiangolo commented Mar 7, 2023

✨ Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) #2944

✨ Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) #2944

uSpike commented Mar 13, 2021 •

edited

Loading

codecov bot commented Mar 13, 2021 •

edited

Loading

nesb1 commented Oct 21, 2021 •

edited

Loading

meshantz commented Nov 5, 2021 •

edited

Loading

uSpike commented Dec 19, 2021 •

edited

Loading