Allow model columns to bear the same name as reserved wtforms.BaseForm attributes #658
Conversation
This file contains 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
aminalaee
reviewed
Oct 27, 2023
brouberol
force-pushed
the
wtforms-reserved-attributes
branch
4 times, most recently
from
6c78992 to
4fb49fa
Compare
For example, a Model with a mapped column named `data` would collide with the [`wtforms.Form.data`](https://github.com/aminalaee/sqladmin/blob/main/sqladmin/forms.py#L619-L634) property, which would generate errors when processing or rendering the form. What we do here is silently rename the column when entering and leaving WTForms territory. Taking the example of a column named `data`, the associated `Field` object will: - be listed under the form key `data_` - be passed a `name='data'` kwarg so that it is still displayed with the `data` label in the admin web UI Instead of directly passing `form.data` to `model_view.insert_model` or `model_view.update_model`, we first restore the original name (e.g. `data_` to `data`) so that the underlying SQLAlchemy can them work on the originalcolumn. > **Note**: this is a bit crude and I think the naming could be improved. Feel free to refactor at will. Fixes aminalaee#656
brouberol
force-pushed
the
wtforms-reserved-attributes
branch
from
4fb49fa to
5fcf7d8
Compare
|
I've added some tests as well to satisfy the codecov job. Feel free to refactor things around if you want to. |
brouberol
changed the title
aminalaee
approved these changes
Nov 8, 2023
Merged
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.
For example, a Model with a mapped column named
datawould collide with thewtforms.Form.dataproperty, which would generate errors when processing or rendering the form, as reported in #656.What we do here is silently rename the column when entering and leaving WTForms territory. Taking the example of a column named
data, the associatedFieldobject will:data_name='data'kwarg so that it is still displayed with thedatalabel in the admin web UIInstead of directly passing
form.datatomodel_view.insert_modelormodel_view.update_model, we first restore the original name (e.g.data_todata) so that the underlying SQLAlchemy can them work on the original column.Fixes #656