Mixins¶

You might have created some mixins which you use through out the project and also across multiple projects.

Here are some common mixins which you can reuse without building your own along with feature to rename column names.

Note

All mixins inherit from MappedAsDataclass to get maximum type hints while using SQLAlchemy 2.x

If you don't know what is MappedAsDataclass, This is similar to adding type hints features of SQLModel to our regular SQLAlchemy

All of the mixins are self explanatory so here's list of all:

MixinId
MixinCreatedAt
MixinUpdatedAt
MixinIsDeleted

Using all of the mixin is straight forward so here's minimal example for all of them:

from fastapi_battries.sa.mixins import MixinId

class Product(Base, MixinId):
    __tablename__ = "product"

    title: Mapped[str]

You can view source code of all mixins here.

`MixinFactory`¶

Sometime, You might want renamed column for example when using MixinUpdatedAt you'll get updated_at column but you want column name as last_modified_at or started_at to make it more meaningful according to your model. For this, MixinFactory allows you to generate renamed column from existing mixins.

from fastapi_batteries.sa.mixins import MixinFactory, MixinId, MixinCreatedAt

MixinStartedAt = MixinFactory.get_renamed(MixinCreatedAt, "started_at")

class Workflow(Base, MixinId, MixinStartedAt):
    __tablename__ = "workflow"

    title: Mapped[str]

As this is just utility you can also use it on your own mixins.

from fastapi_batteries.sa.mixins import MixinFactory

class YourMixin(Base):
    your_col_name: Mapped[str]

RenamedMixin = MixinFactory.get_renamed(YourMixin, "new_col_name")

class Workflow(Base, RenamedMixin): ...

Mixins¶

MixinFactory¶

`MixinFactory`¶