Skip to content

fix: Inlcude FKs when creating marshmallow-sqlalchemy schemas #2443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mschmo wants to merge 4 commits into
base: master
Choose a base branch
from
+18 −2
Open

fix: Inlcude FKs when creating marshmallow-sqlalchemy schemas #2443

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c36847c
Inlcude FKs when creating marshmallow-sqlalchemy schemas
mschmo Mar 19, 2026
8bf8baf
Add include_fk parameter to convert
mschmo Mar 20, 2026
2073337
Update BaseModel2SchemaConverter.convert to appease linter
mschmo Mar 20, 2026
f3c2af3
Merge branch 'master' into fix-marshmallow-schema-fk-key-error
mschmo Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions flask_appbuilder/api/convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ def convert(
columns: List[str],
model: Optional[Type[Model]] = None,
nested: bool = True,
include_fk: bool = True,
parent_schema_name: Optional[str] = None,
) -> SQLAlchemyAutoSchema:
pass
Expand Down Expand Up @@ -105,6 +106,7 @@ def _meta_schema_factory(
columns: List[str],
model: Optional[Type[Model]],
class_mixin: Type[Schema],
include_fk: bool = False,
parent_schema_name: Optional[str] = None,
) -> Type[SQLAlchemyAutoSchema]:
"""
Expand All @@ -113,16 +115,19 @@ def _meta_schema_factory(
:param columns: a list of columns to mix
:param model: Model
:param class_mixin: a marshamallow Schema to mix
:param include_fk: Include foreign keys
:return: ModelSchema
"""
_model = model
_parent_schema_name = parent_schema_name
_include_fk = include_fk
if columns:

class MetaSchema(SQLAlchemyAutoSchema, class_mixin): # type: ignore
class Meta:
model = _model
fields = columns
include_fk = _include_fk
load_instance = True
sqla_session = current_app.appbuilder.session
# The parent_schema_name is useful to humanize nested schema names
Expand All @@ -134,6 +139,7 @@ class Meta:
class MetaSchema(SQLAlchemyAutoSchema, class_mixin): # type: ignore
class Meta:
model = _model
include_fk = _include_fk
load_instance = True
sqla_session = current_app.appbuilder.session
# The parent_schema_name is useful to humanize nested schema names
Expand Down Expand Up @@ -171,7 +177,11 @@ def _column2relation(
nested_model = datamodel.get_related_model(column.name)
lst = [item.name for item in column.children]
nested_schema = self.convert(
lst, nested_model, nested=False, parent_schema_name=parent_schema_name
lst,
nested_model,
nested=False,
include_fk=False,
parent_schema_name=parent_schema_name,
)
if datamodel.is_relation_many_to_one(column.name):
many = False
Expand Down Expand Up @@ -242,6 +252,7 @@ def convert(
columns: List[str],
model: Optional[Type[Model]] = None,
nested: bool = True,
include_fk: bool = True,
parent_schema_name: Optional[str] = None,
) -> SQLAlchemyAutoSchema:
"""
Expand All @@ -251,6 +262,7 @@ def convert(
:param columns: List with columns to include, if empty converts all on model
:param model: Override Model to convert
:param nested: Generate relation with nested schemas
:param include_fk: Include foreign keys
:return: ModelSchema object
"""
super(Model2SchemaConverter, self).convert(
Expand All @@ -276,5 +288,9 @@ class SchemaMixin:
for k, v in ma_sqla_fields_override.items():
setattr(SchemaMixin, k, v)
return self._meta_schema_factory(
_columns, _model, SchemaMixin, parent_schema_name=parent_schema_name
_columns,
_model,
SchemaMixin,
include_fk=include_fk,
parent_schema_name=parent_schema_name,
)()
Loading