Document and test async startup hooks - #2901
Open
roli-lpci wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The startup hook guide currently shows a synchronous function returning an async inner function. Datasette also accepts
async def startup(datasette)directly, so plugins can await initialization work without the wrapper.This updates the example and adds tests for direct async hooks, returned async functions, returned coroutines, and
StartupErrorpropagation after an awaited database query. It documents existing behavior and is scoped to the startup hook.Refs #2497.
Validation:
uv run pytest tests/test_plugins.py(154 passed, 4 skipped); strict Sphinx HTML build; Black and Ruff checks. Prepared with Codex assistance and reviewed with Claude and an independent Codex review.