Adding custom filtering for relationships ModelConverterBase._prepare_select_options
Checklist
- There are no similar issues or pull requests for this yet.
Is your feature related to a problem? Please describe.
I want to filter relationships in a query, but I can't because the ModelConverterBase._prepare_select_options function generates the query in a hardcode.
Describe the solution you would like.
class CustomModelConverter(ModelConverter):
select_option_stmts = {
'field': select(Model).where(Model.level > 1)
}
class ModelBaseConverter:
select_option_stmts: Dict[str, Select]
async def _prepare_select_options(
self,
prop: RelationshipProperty,
session_maker: sessionmaker,
) -> list[tuple[str, Any]]:
target_model = prop.mapper.class_
if prop.key in self.select_option_stmts:
stmt = self.select_option_stmts[prop.key]
else:
stmt = select(target_model)
if is_async_session_maker(session_maker):
async with session_maker() as session:
objects = await session.execute(stmt)
return [
(str(self._get_identifier_value(obj)), str(obj))
for obj in objects.scalars().unique().all()
]
else:
with session_maker() as session:
objects = await anyio.to_thread.run_sync(session.execute, stmt)
return [
(str(self._get_identifier_value(obj)), str(obj))
for obj in objects.scalars().unique().all()
]
class View(ModelView, model=Model):
form_converter = CustomModelConverterDescribe alternatives you considered
There is an option to inherit from ModelConverter and override the _prepare_select_options method in CustomModelConverter. But it looks like a huge crutch.
class CustomModelConverter(ModelConverter):
async def _prepare_select_options(
self,
prop: RelationshipProperty,
session_maker: sessionmaker,
) -> list[tuple[str, Any]]:
target_model = prop.mapper.class_
stmt = <custom query>
if is_async_session_maker(session_maker):
async with session_maker() as session:
objects = await session.execute(stmt)
return [
(str(self._get_identifier_value(obj)), str(obj))
for obj in objects.scalars().unique().all()
]
else:
with session_maker() as session:
objects = await anyio.to_thread.run_sync(session.execute, stmt)
return [
(str(self._get_identifier_value(obj)), str(obj))
for obj in objects.scalars().unique().all()
]
class View(ModelView, model=Model):
form_converter = CustomModelConverterAdditional context
No response
aminalaee / sqladmin
SQLAlchemy Admin for FastAPI and Starlette
1.9k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too