Can't save with a ModelView to a Model that has a column named data

[lorg]

Can't save with a ModelView to a Model that has a column named data

[brouberol]

I think I have a generic-enough solution, and it seems to be working. I still need to refine it and find out how to unit test it, and I need a bit more time for that.

[brouberol]

I'm hitting the same issue as well. As far as I can tell, the model data attributes overrides the wtforms.form.Baseform.data property. I haven't (yet) taken the time to see whether I can somehow circumvent this issue or not.

[brouberol]

Looking into the wtforms repo, I found this open issue: wtforms/wtforms#791, which points back to the sqladmin repo in the end.

[brouberol]

I've been able to circumvent this issue by:

• renaming the data sqlalchemy column to data_ while still providing a data hybrid property on the model to hide the renaming
• map the data_ column name to a data sqladmin column label

# models.py
+class DataPropertyMixin:
+    """Provide the .data property as an accessor to the data_ mapped column"""
+
+    @hybrid_property
+    def data(self):
+        return self.data_
+
+    @data.inplace.setter
+    def set_data(self, value):
+        self.data_ = value
+
+

-class Item(NameReprMixin, BaseModel):
+class Item(NameReprMixin, DataPropertyMixin, BaseModel):
     name: Mapped[str] = mapped_column(String(255), unique=True, index=True)
-    data: Mapped[str] = mapped_column(Json, name="json_data")
+    data_: Mapped[str] = mapped_column(Json, name="json_data")


# admin.py
class ItemAdmin(CustomModelView, model=Item):
-    column_labels = {"five_e_tools_url": "5e.tools URL"}
+    column_labels = {"five_e_tools_url": "5e.tools URL", Item.data_: "data"}

It's not ideal, as we'd have to repeat the process for any name collision that we get with wtforms.form.BaseForm but it works.

[aminalaee]

I'm open to add a condition for this specific column name (data) and have a proper comment to rename it to something else in wtforms to handle this. PRs are welcome.

[brouberol]

I'm happy to give it a go when I can.

I was thinking of adapting https://github.com/aminalaee/sqladmin/blob/main/sqladmin/forms.py#L619-L634 so that, for model columns specifically named data, we'd map them to Field objects named _data with an attribute name=data, as hinted at in wtforms/wtforms#791 (comment).

So we'd get field_dict['_data'] = Field(name='data', ...).

Was that what you had in mind?

[aminalaee]

Yeah and also here when we get the form data:

sqladmin/sqladmin/application.py

Line 660 in f62c38a

async def _handle_form_data(self, request: Request, obj: Any = None) -> FormData:

We should reverse that logic.