SQLAlchemy中json列的自定义json序列化程序

Question

我有以下ORM对象（简化）：

import datetime as dt

from sqlalchemy import create_engine, Integer, Column, DateTime
from sqlalchemy.dialects.postgresql import JSONB
from sqlalchemy.orm import Session, declarative_base

Base = declarative_base()

class Metrics(Base):
    __tablename__ = 'metrics'

    id = Column(Integer, primary_key=True)
    ts = Column(DateTime, default=dt.datetime.now())
    computed_values = Column(JSONB)
    dates = Column(JSONB)

    calculated_values = 
    entry = Metrics(computed_values={'foo': 12.3, 'bar':45.6},
                    dates=[datetime.date.today()])

    engine = create_engine('postgresql://postgres:postgres@localhost:5432/my_schema')
    with Session(engine, future=True) as session:
        session.add(entry)
        session.commit()

每行有：

• id主键
• ts插入行时的时间戳
computed_values要存储的实际JSONB数据
• 日期JSONB来存储计算数据的日期列表。

虽然我对computed_values列没有问题，但是datetime。默认情况下，dates列中列表中的date对象不能被SQLAlchemy JSON序列化程序序列化。

我的想法是为该列重新定义date对象的序列化程序行为。要做到这一点，我必须定义自己的自定义JSON序列化程序，或者使用一些现成的序列化程序，比如orjson。因为我可能会在项目中遇到许多其他JSON序列化问题，所以我更喜欢后者。

深入研究JSONB类和它的超类，我认为下面应该可以做到这一点：

class Metrics(Base):
    __tablename__ = 'metrics'

    # ---%<--- snip ---%<---
    dates = Column(JSONB(json_serializer=lambda obj: orjson.dumps(obj, option=orjson.OPT_NAIVE_UTC)))

    # ---%<--- snip ---%<---

但事实并非如此：

File "metrics.py", line 30, in Metrics
    dates = Column(JSONB(json_serializer=lambda obj: orjson.dumps(obj, option=orjson.OPT_NAIVE_UTC)))
TypeError: __init__() got an unexpected keyword argument 'json_serializer'

我做错了什么，以及如何为JSON（和JSONB）列正确定义自定义SQLAlchemy序列化程序？

Answer 1

看起来你应该能够通过修改你的create_engine语句得到你想要的。

来自SQLAlchemy中的文档字符串：

Custom serializers and deserializers are specified at the dialect level,
that is using :func:`_sa.create_engine`.  The reason for this is that when
using psycopg2, the DBAPI only allows serializers at the per-cursor
or per-connection level.   E.g.::
    engine = create_engine("postgresql://scott:tiger@localhost/test",
                            json_serializer=my_serialize_fn,
                            json_deserializer=my_deserialize_fn
                    )

因此，生成的代码应如下所示：

import datetime as dt

import orjson

from sqlalchemy import create_engine, Integer, Column, DateTime
from sqlalchemy.dialects.postgresql import JSONB
from sqlalchemy.orm import Session, declarative_base

Base = declarative_base()

class Metrics(Base):
    __tablename__ = 'metrics'

    id = Column(Integer, primary_key=True)
    ts = Column(DateTime, default=dt.datetime.now())
    computed_values = Column(JSONB)
    dates = Column(JSONB)

    calculated_values = 
    entry = Metrics(computed_values={'foo': 12.3, 'bar':45.6},
                    dates=[datetime.date.today()])

    def orjson_serializer(obj):
        """
            Note that `orjson.dumps()` return byte array, while sqlalchemy expects string, thus `decode()` call.
        """
        return orjson.dumps(obj, option=orjson.OPT_SERIALIZE_NUMPY | orjson.OPT_NAIVE_UTC).decode()
    

    engine = create_engine('postgresql://postgres:postgres@localhost:5432/my_schema', json_serializer=orjson_serializer, json_deserializer=orjson.loads)
    with Session(engine, future=True) as session:
        session.add(entry)
        session.commit()