aboutsummaryrefslogtreecommitdiffstats
path: root/thallium-backend/src/orm/base.py
blob: 5fd70d6a3b46cc99b664aade79a87c51e8890683 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
"""The base classes for ORM models."""

import re
from datetime import datetime
from uuid import UUID

from pydantic import BaseModel
from sqlalchemy.ext.asyncio import AsyncAttrs
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from sqlalchemy.schema import MetaData
from sqlalchemy.sql import func, text
from sqlalchemy.types import DateTime

NAMING_CONVENTIONS = {
    "ix": "%(column_0_label)s_ix",
    "uq": "%(table_name)s_%(column_0_name)s_uq",
    "ck": "%(table_name)s_%(constraint_name)s_ck",
    "fk": "%(table_name)s_%(column_0_name)s_%(referred_table_name)s_fk",
    "pk": "%(table_name)s_pk",
}
table_name_regexp = re.compile("((?<=[a-z0-9])[A-Z]|(?!^)[A-Z](?=[a-z]))")


class Base(AsyncAttrs, DeclarativeBase):
    """Classes that inherit this class will be automatically mapped using declarative mapping."""

    metadata = MetaData(naming_convention=NAMING_CONVENTIONS)

    def patch_from_pydantic(self, pydantic_model: BaseModel) -> None:
        """Patch this model using the given pydantic model, unspecified attributes remain the same."""
        for key, value in pydantic_model.model_dump(exclude_unset=True).items():
            setattr(self, key, value)


class UUIDBase:
    """Adds a pre-populated UUID as the tables PK."""

    id: Mapped[UUID] = mapped_column(server_default=text("gen_random_uuid()"), primary_key=True)


class AuditBase:
    """Common columns for a table with UUID PK and datetime audit columns."""

    created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), server_default=func.now())
    updated_at: Mapped[datetime] = mapped_column(
        DateTime(timezone=True),
        server_default=func.now(),
        onupdate=func.now(),
    )