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.
Add
get_or_abortandone_or_abortmethods (and async variants), which will return a single row or callflask.abort(404). These are similar toget_or_404etc from Flask-SQLAlchemy. They take arguments to customize the query execution as well as the abort call.I decided not to port
first_or_404because these methods seem intended for detail pages, wherefirstwould not catch that the result may not be unique.one_or_abortcovers that case.getwill always return a model instance, butoneworks on any select statement, which returns a tuple result. I added ascalarargument to control whether to return a single item or the tuple result. It defaults to true since the common use case will be to query a model rather than a tuple of columns. It's possible to introspect the select statement to determine whether a single model is being queried, but I felt explicitly passingscalar=Falsewas preferable.For the first release of Flask-SQLAlchemy-Lite, I wanted to keep it as simple as possible, waiting to see what may be needed from Flask-SQLAlchemy. These helper methods handle a really common pattern in web applications, and go beyond just tweaking SQLAlchemy to actually integrate with Flask. So I felt it was appropriate to have these in this "light" extension.