100 lines
3.3 KiB
Python
100 lines
3.3 KiB
Python
"""ORM 基类与几个跨模块复用的小工具。
|
||
|
||
列类型工厂集中在这里,是为了让"同一套模型在 MySQL 上拿到最贴合的列类型"这件事只写一次:
|
||
主键统一无符号 BIGINT、时间统一 DATETIME(3)、金额统一 DECIMAL,避免各模块各写一套
|
||
导致同一张表在两套代码里对不上。
|
||
"""
|
||
|
||
from __future__ import annotations
|
||
|
||
from datetime import datetime
|
||
from decimal import Decimal, InvalidOperation
|
||
|
||
from sqlalchemy import BigInteger, Date, DateTime, Numeric, func
|
||
from sqlalchemy.dialects.mysql import BIGINT, DATETIME, TINYINT
|
||
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
|
||
|
||
|
||
class Base(DeclarativeBase):
|
||
"""所有表的基类。"""
|
||
|
||
|
||
def timestamp_col():
|
||
"""DATETIME(3);非 MySQL 方言退回普通 DATETIME。"""
|
||
return DateTime().with_variant(DATETIME(fsp=3), "mysql")
|
||
|
||
|
||
def date_col():
|
||
"""DATE:项目计划起止这类"精确到月/日但没有时刻"的列。"""
|
||
return Date()
|
||
|
||
|
||
def u_bigint():
|
||
"""无符号 BIGINT:主键与外键统一用它,避免有符号/无符号混用让索引失效。"""
|
||
return BigInteger().with_variant(BIGINT(unsigned=True), "mysql")
|
||
|
||
|
||
def u_tinyint():
|
||
return TINYINT(unsigned=True)
|
||
|
||
|
||
def money(precision: int = 18, scale: int = 4):
|
||
"""金额列。
|
||
|
||
库里保留 4 位小数而不是 2 位:老系统明细单价是 5 位、含税总额是 4 位,只存 2 位
|
||
会在重算时对不上账。展示层再按 :mod:`app.service.calc` 的口径舍入到 2 位。
|
||
"""
|
||
return Numeric(precision, scale)
|
||
|
||
|
||
def percent(scale: int = 6):
|
||
"""比率列(百分数本身,13 表示 13%)。
|
||
|
||
宽度给到 18 而不是 10:比率都是"金额 ÷ 金额 × 100"算出来的,分子分母都是
|
||
DECIMAL(18,4),分母一小(老库里就有 contract_amount = 1.00 的试算项目)结果就能
|
||
冲出 ±9999。DECIMAL(10,6) 遇到这种值不是报错就是截断——重算写入时抛 1264,
|
||
导数时整条项目插不进去。列宽换 4 个字节,比丢数或炸库便宜。
|
||
"""
|
||
return Numeric(18, scale)
|
||
|
||
|
||
class TimestampMixin:
|
||
"""创建/更新时间,交给数据库兜底,避免应用时钟不一致。"""
|
||
|
||
created_at: Mapped[datetime] = mapped_column(
|
||
timestamp_col(),
|
||
default=datetime.now,
|
||
server_default=func.current_timestamp(3),
|
||
nullable=False,
|
||
comment="创建时间",
|
||
)
|
||
updated_at: Mapped[datetime] = mapped_column(
|
||
timestamp_col(),
|
||
default=datetime.now,
|
||
onupdate=datetime.now,
|
||
server_default=func.current_timestamp(3),
|
||
nullable=False,
|
||
comment="最后更新时间",
|
||
)
|
||
|
||
|
||
class SoftDeleteMixin:
|
||
"""软删除。老系统几乎每张表都有 is_deleted,这里统一成一个布尔位。"""
|
||
|
||
is_deleted: Mapped[bool] = mapped_column(
|
||
u_tinyint(), default=False, server_default="0", nullable=False, index=True,
|
||
comment="软删除 0=有效 1=已删除",
|
||
)
|
||
|
||
|
||
def to_decimal(value: object) -> Decimal:
|
||
"""把数据库/JSON 回来的杂七杂八类型折成 Decimal,None 视作 0。"""
|
||
if value is None or value == "":
|
||
return Decimal("0")
|
||
if isinstance(value, Decimal):
|
||
return value
|
||
try:
|
||
return Decimal(str(value))
|
||
except (InvalidOperation, ValueError):
|
||
return Decimal("0")
|