-
-
Notifications
You must be signed in to change notification settings - Fork 953
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document the lifespan event handler parameter #1110
Conversation
#799 added support for the `lifespan` parameter, but it was not reflected in the documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lifespan now takes an async context manager factory, eg an async generator function decorated with @contextlib(2).asynccontextmanager
Update docs according to changes in #1227.
docs/events.md
Outdated
async with anyio.create_task_group() as app.tg: | ||
try: | ||
yield | ||
finally: | ||
with anyio.CancelScope(shield=True): | ||
# release async resources |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry I lead you wrong here - the TaskGroup context manager will capture any CancelledError for you
async with anyio.create_task_group() as app.tg: | |
try: | |
yield | |
finally: | |
with anyio.CancelScope(shield=True): | |
# release async resources | |
async with anyio.create_task_group() as app.tg: | |
yield | |
# release async resources |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do want to somehow document that yield
can now throw CancelledError
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we should have the main documentation for lifespan be setting app.tg
. That could be a separate topic, but I think the initial introduction to "make a lifespan" example should be as simple as possible.
@contextlib.asynccontextmanager
async def lifespan(app):
async with some_async_resource():
yield
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's fair
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the simple lifespan example; we can also add a link to anyio documentation on task groups and cancellation.
Blocks #1233 |
Simplify asynccontextmanager example, and add a link to anyio docs.
Thanks! Apologies for dragging this one off topic in my original review |
#799 added support for the
lifespan
parameter, but it was not reflected in the documentation.