Mention that filters_from_request can return an async function - #2866
Open
cycsmail wants to merge 1 commit into
Open
Mention that filters_from_request can return an async function#2866cycsmail wants to merge 1 commit into
cycsmail wants to merge 1 commit into
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
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.
Closes:
filters_from_requestplugin hook docs should mention that returning an async function is allowed #1638The
filters_from_requesthook can return anasync deffunction (Datasette calls it and awaits the result viaawait_me_maybe), so you can run SQL or other async work while building your filters. The docs didn't mention this, so I added a short note to thefilters_from_requestsection pointing it out and linking to the default implementations indatasette/filters.py.Also added a small
test_docs.pycheck that the documented section mentionsasync def; it fails without the doc change and passes with it.