在 Flask 中对 SQLAlchemy 结果集进行 jsonify [重复]

问题描述：

我正在尝试在 Flask/Python 中将 SQLAlchemy 结果集 jsonify 化。

Flask 邮件列表建议以下方法http://librelist.com/browser//flask/2011/2/16/jsonify-sqlalchemy-pagination-collection-result/#04a0754b63387f87e59dda564bde426e：

return jsonify(json_list = qryresult)

但是我收到了以下错误：

TypeError: <flaskext.sqlalchemy.BaseQuery object at 0x102c2df90> 
is not JSON serializable

我在这里忽略了什么？

我发现了这个问题：如何将 SqlAlchemy 结果序列化为 JSON？这看起来非常相似，但是我不知道 Flask 是否有一些魔力可以使其变得更容易，正如邮件列表帖子所建议的那样。

编辑：为了澄清起见，这是我的模型的样子

class Rating(db.Model):

    __tablename__ = 'rating'

    id = db.Column(db.Integer, primary_key=True)
    fullurl = db.Column(db.String())
    url = db.Column(db.String())
    comments = db.Column(db.Text)
    overall = db.Column(db.Integer)
    shipping = db.Column(db.Integer)
    cost = db.Column(db.Integer)
    honesty = db.Column(db.Integer)
    communication = db.Column(db.Integer)
    name = db.Column(db.String())
    ipaddr = db.Column(db.String())
    date = db.Column(db.String())

    def __init__(self, fullurl, url, comments, overall, shipping, cost, honesty, communication, name, ipaddr, date):
        self.fullurl = fullurl
        self.url = url
        self.comments = comments
        self.overall = overall
        self.shipping = shipping
        self.cost = cost
        self.honesty = honesty
        self.communication = communication
        self.name = name
        self.ipaddr = ipaddr
        self.date = date

解决方案 1：

看来您实际上尚未执行查询。请尝试以下操作：

return jsonify(json_list = qryresult.all())

[编辑]：jsonify 的问题在于，通常无法自动对对象进行 jsonify。甚至 Python 的 datetime 也失败了 ;)

我过去所做的是serialize向需要序列化的类添加额外的属性（如）。

def dump_datetime(value):
    """Deserialize datetime object into string form for JSON processing."""
    if value is None:
        return None
    return [value.strftime("%Y-%m-%d"), value.strftime("%H:%M:%S")]

class Foo(db.Model):
    # ... SQLAlchemy defs here..
    def __init__(self, ...):
       # self.foo = ...
       pass

    @property
    def serialize(self):
       """Return object data in easily serializable format"""
       return {
           'id'         : self.id,
           'modified_at': dump_datetime(self.modified_at),
           # This is an example how to deal with Many2Many relations
           'many2many'  : self.serialize_many2many
       }
    @property
    def serialize_many2many(self):
       """
       Return object's relations in easily serializable format.
       NB! Calls many2many's serialize property.
       """
       return [ item.serialize for item in self.many2many]

现在我可以这样做：

return jsonify(json_list=[i.serialize for i in qryresult.all()])

[编辑 2019]：如果您有更复杂的对象或循环引用，请使用像marshmallow这样的库）。

解决方案 2：

这对我来说通常就足够了：

我创建了一个序列化 mixin，用于我的模型。序列化函数基本上会获取 SQLAlchemy 检查器公开的任何属性并将其放入字典中。

from sqlalchemy.inspection import inspect

class Serializer(object):

    def serialize(self):
        return {c: getattr(self, c) for c in inspect(self).attrs.keys()}

    @staticmethod
    def serialize_list(l):
        return [m.serialize() for m in l]

现在所需要的只是使用Serializermixin 类来扩展 SQLAlchemy 模型。

如果您不想公开某些字段，或者需要特殊格式，只需重写serialize()模型子类中的函数即可。

class User(db.Model, Serializer):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String)
    password = db.Column(db.String)

    # ...

    def serialize(self):
        d = Serializer.serialize(self)
        del d['password']
        return d

在您的控制器中，您所要做的就是对结果调用该serialize()函数（或者serialize_list(l)查询结果显示在列表中）：

def get_user(id):
    user = User.query.get(id)
    return json.dumps(user.serialize())

def get_users():
    users = User.query.all()
    return json.dumps(User.serialize_list(users))

解决方案 3：

我有同样的需求，需要序列化为 json。看看这个问题。它展示了如何以编程方式发现列。因此，我创建了下面的代码。它对我有用，我将在我的 Web 应用程序中使用它。

def to_json(inst, cls):
    """
    Jsonify the sql alchemy query result.
    """
    convert = dict()
    # add your coversions for things like datetime's 
    # and what-not that aren't serializable.
    d = dict()
    for c in cls.__table__.columns:
        v = getattr(inst, c.name)
        if c.type in convert.keys() and v is not None:
            try:
                d[c.name] = convert[c.type](v)
            except:
                d[c.name] = "Error:  Failed to covert using ", str(convert[c.type])
        elif v is None:
            d[c.name] = str()
        else:
            d[c.name] = v
    return json.dumps(d)

class Person(base):
    __tablename__ = 'person'
    id = Column(Integer, Sequence('person_id_seq'), primary_key=True)
    first_name = Column(Text)
    last_name = Column(Text)
    email = Column(Text)

    @property
    def json(self):
        return to_json(self, self.__class__)

解决方案 4：

这是我的方法：
https://github.com/n0nSmoker/SQLAlchemy-serializer

pip install SQLAlchemy-serializer

您可以轻松地将 mixin 添加到您的模型中，然后只需
.to_dict()在其实例上调用方法即可。

您也可以在此基础上编写自己的mixin SerializerMixin。

解决方案 5：

对于平面查询（无连接），您可以这样做

@app.route('/results/')
def results():
    data = Table.query.all()
    result = [d.__dict__ for d in data]
    return jsonify(result=result)

如果你只想从数据库返回某些列，你可以这样做

@app.route('/results/')
def results():
    cols = ['id', 'url', 'shipping']
    data = Table.query.all()
    result = [{col: getattr(d, col) for col in cols} for d in data]
    return jsonify(result=result)

解决方案 6：

好的，我已经研究了几个小时，并且开发出了我认为迄今为止最符合 Python 风格的解决方案。以下代码片段是 Python3，但如果您需要的话，反向移植应该不会太麻烦。

我们要做的第一件事是从一个混合开始，它使你的数据库模型表现得有点像dict：

from sqlalchemy.inspection import inspect

class ModelMixin:
    """Provide dict-like interface to db.Model subclasses."""

    def __getitem__(self, key):
        """Expose object attributes like dict values."""
        return getattr(self, key)

    def keys(self):
        """Identify what db columns we have."""
        return inspect(self).attrs.keys()

现在我们要定义我们的模型，继承mixin：

class MyModel(db.Model, ModelMixin):
    id = db.Column(db.Integer, primary_key=True)
    foo = db.Column(...)
    bar = db.Column(...)
    # etc ...

这就是将一个实例传递给并从中获取一个真实实例所需的全部内容MyModel()，这让我们对理解它有了很大的帮助dict()。接下来，我们需要扩展以完成剩下的工作：dict`jsonify()`JSONEncoder

from flask.json import JSONEncoder
from contextlib import suppress

class MyJSONEncoder(JSONEncoder):
    def default(self, obj):
        # Optional: convert datetime objects to ISO format
        with suppress(AttributeError):
            return obj.isoformat()
        return dict(obj)

app.json_encoder = MyJSONEncoder

加分点：如果您的模型包含计算字段（即您希望 JSON 输出包含实际上未存储在数据库中的字段），这也很容易。只需将您的计算字段定义为@propertys，然后keys()像这样扩展方法：

class MyModel(db.Model, ModelMixin):
    id = db.Column(db.Integer, primary_key=True)
    foo = db.Column(...)
    bar = db.Column(...)

    @property
    def computed_field(self):
        return 'this value did not come from the db'

    def keys(self):
        return super().keys() + ['computed_field']

现在 jsonify 就很简单了：

@app.route('/whatever', methods=['GET'])
def whatever():
    return jsonify(dict(results=MyModel.query.all()))

解决方案 7：

如果您正在使用，flask-restful则可以使用marshal：

from flask.ext.restful import Resource, fields, marshal

topic_fields = {
    'title':   fields.String,
    'content': fields.String,
    'uri':     fields.Url('topic'),
    'creator': fields.String,
    'created': fields.DateTime(dt_format='rfc822')
}

class TopicListApi(Resource):
    def get(self):
        return {'topics': [marshal(topic, topic_fields) for topic in DbTopic.query.all()]}

您需要明确列出要返回的内容及其类型，无论如何，对于 api，我更喜欢这样做。序列化很容易处理（不需要jsonify），日期也不是问题。请注意，字段的内容uri是根据topic端点和 id 自动生成的。

解决方案 8：

如果您使用声明性基础，这是我的答案（借助一些已经发布的答案）：

# in your models definition where you define and extend declarative_base()
from sqlalchemy.ext.declarative import declarative_base
...
Base = declarative_base()
Base.query = db_session.query_property()
...

# define a new class (call "Model" or whatever) with an as_dict() method defined
class Model():
    def as_dict(self):
        return { c.name: getattr(self, c.name) for c in self.__table__.columns }

# and extend both the Base and Model class in your model definition, e.g.
class Rating(Base, Model):
    ____tablename__ = 'rating'
    id = db.Column(db.Integer, primary_key=True)
    fullurl = db.Column(db.String())
    url = db.Column(db.String())
    comments = db.Column(db.Text)
    ...

# then after you query and have a resultset (rs) of ratings
rs = Rating.query.all()

# you can jsonify it with
s = json.dumps([r.as_dict() for r in rs], default=alchemyencoder)
print (s)

# or if you have a single row
r = Rating.query.first()

# you can jsonify it with
s = json.dumps(r.as_dict(), default=alchemyencoder)

# you will need this alchemyencoder where your are calling json.dumps to handle datetime and decimal format
# credit to Joonas @ http://codeandlife.com/2014/12/07/sqlalchemy-results-to-json-the-easy-way/
def alchemyencoder(obj):
    """JSON encoder function for SQLAlchemy special classes."""
    if isinstance(obj, datetime.date):
        return obj.isoformat()
    elif isinstance(obj, decimal.Decimal):
        return float(obj)

解决方案 9：

Flask-Restful 0.3.6 Request Parsing推荐 marshmallow

marshmallow 是一个 ORM/ODM/框架无关的库，用于在复杂数据类型（例如对象）和本机 Python 数据类型之间进行转换。

下面是一个简单的棉花糖示例。

from marshmallow import Schema, fields

class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    created_at = fields.DateTime()

from marshmallow import pprint

user = User(name="Monty", email="monty@python.org")
schema = UserSchema()
result = schema.dump(user)
pprint(result)
# {"name": "Monty",
#  "email": "monty@python.org",
#  "created_at": "2014-08-17T14:54:16.049594+00:00"}

核心功能包括

声明模式

序列化对象（“转储”）

反序列化对象（“加载”）

处理对象集合

验证

指定属性名称

指定序列化 / 反序列化键

重构：隐式字段创建

排序输出

“只读”和“只写”字段

指定默认序列化 / 反序列化值

嵌套模式

自定义字段

解决方案 10：

这里有一种方法可以为每个类添加一个 as_dict() 方法，以及您想要在每个类上添加的任何其他方法。不确定这是否是理想的方法，但它确实有效...

class Base(object):
    def as_dict(self):
        return dict((c.name,
                     getattr(self, c.name))
                     for c in self.__table__.columns)


Base = declarative_base(cls=Base)

解决方案 11：

我已经研究这个问题一天中的大部分时间了，下面是我得出的结论（感谢https://stackoverflow.com/a/5249214/196358为我指明了方向）。

（注意：我使用的是 flask-sqlalchemy，所以我的模型声明格式与直接 sqlalchemy 有点不同）。

在我的models.py档案中：

import json

class Serializer(object):
  __public__ = None
  "Must be implemented by implementors"

  def to_serializable_dict(self):
    dict = {}
    for public_key in self.__public__:
      value = getattr(self, public_key)
      if value:
        dict[public_key] = value
    return dict

class SWEncoder(json.JSONEncoder):
  def default(self, obj):
    if isinstance(obj, Serializer):
      return obj.to_serializable_dict()
    if isinstance(obj, (datetime)):
      return obj.isoformat()
    return json.JSONEncoder.default(self, obj)


def SWJsonify(*args, **kwargs):
  return current_app.response_class(json.dumps(dict(*args, **kwargs), cls=SWEncoder, indent=None if request.is_xhr else 2), mimetype='application/json')
  # stolen from https://github.com/mitsuhiko/flask/blob/master/flask/helpers.py

我的所有模型对象看起来都像这样：

class User(db.Model, Serializer):
  __public__ = ['id','username']
  ... field definitions ...

在我看来，我在需要调用 的地方调用了 SWJsonify Jsonify，如下所示：

@app.route('/posts')
def posts():
  posts = Post.query.limit(PER_PAGE).all()
  return SWJsonify({'posts':posts })

似乎效果不错。甚至在人际关系方面也是如此。我还没有取得很大进展，所以 YMMV，但到目前为止，我觉得它相当“合适”。

欢迎提出建议。

解决方案 12：

我正在寻找类似于 ActiveRecord to_json 中使用的 rails 方法，在对其他建议不满意后，我使用这个 Mixin 实现了类似的东西。它处理嵌套模型，并包含或排除顶级或嵌套模型的属性。

class Serializer(object):

    def serialize(self, include={}, exclude=[], only=[]):
        serialized = {}
        for key in inspect(self).attrs.keys():
            to_be_serialized = True
            value = getattr(self, key)
            if key in exclude or (only and key not in only):
                to_be_serialized = False
            elif isinstance(value, BaseQuery):
                to_be_serialized = False
                if key in include:
                    to_be_serialized = True
                    nested_params = include.get(key, {})
                    value = [i.serialize(**nested_params) for i in value]

            if to_be_serialized:
                serialized[key] = value

        return serialized

然后，为了使 BaseQuery 可序列化，我扩展了 BaseQuery

class SerializableBaseQuery(BaseQuery):

    def serialize(self, include={}, exclude=[], only=[]):
        return [m.serialize(include, exclude, only) for m in self]

适用于以下型号

class ContactInfo(db.Model, Serializer):
    id = db.Column(db.Integer, primary_key=True)
    user_id = db.Column(db.Integer, db.ForeignKey('user.id'))
    full_name = db.Column(db.String())
    source = db.Column(db.String())
    source_id = db.Column(db.String())

    email_addresses = db.relationship('EmailAddress', backref='contact_info', lazy='dynamic')
    phone_numbers = db.relationship('PhoneNumber', backref='contact_info', lazy='dynamic')


class EmailAddress(db.Model, Serializer):
    id = db.Column(db.Integer, primary_key=True)
    email_address = db.Column(db.String())
    type = db.Column(db.String())
    contact_info_id = db.Column(db.Integer, db.ForeignKey('contact_info.id'))


class PhoneNumber(db.Model, Serializer):
    id = db.Column(db.Integer, primary_key=True)
    phone_number = db.Column(db.String())
    type = db.Column(db.String())
    contact_info_id = db.Column(db.Integer, db.ForeignKey('contact_info.id'))

    phone_numbers = db.relationship('Invite', backref='phone_number', lazy='dynamic')

你可以做类似的事情

@app.route("/contact/search", methods=['GET'])
def contact_search():
    contact_name = request.args.get("name")
    matching_contacts = ContactInfo.query.filter(ContactInfo.full_name.like("%{}%".format(contact_name)))

    serialized_contact_info = matching_contacts.serialize(
        include={
            "phone_numbers" : {
                "exclude" : ["contact_info", "contact_info_id"]
            },
            "email_addresses" : {
                "exclude" : ["contact_info", "contact_info_id"]
            }
        }
    )

    return jsonify(serialized_contact_info)

解决方案 13：

我正在使用名为 jobDict 的 RowProxy 对象列表的 sql 查询 defaultdict 花了我一段时间才弄清楚对象的类型。

这是一种非常简单快捷的方法，只需将行转换为列表并最初用列表值定义字典即可解析一些干净的 jsonEncoding。

    jobDict = defaultdict(list)
    def set_default(obj):
        # trickyness needed here via import to know type
        if isinstance(obj, RowProxy):
            return list(obj)
        raise TypeError


    jsonEncoded = json.dumps(jobDict, default=set_default)

解决方案 14：

我只是想添加我的方法来做到这一点。

只需定义一个自定义 json 编码器即可序列化您的数据库模型。

class ParentEncoder(json.JSONEncoder):
    def default(self, obj):
        # convert object to a dict
        d = {}
        if isinstance(obj, Parent):
            return {"id": obj.id, "name": obj.name, 'children': list(obj.child)}
        if isinstance(obj, Child):
            return {"id": obj.id, "name": obj.name}

        d.update(obj.__dict__)
        return d

然后在你的视图函数中

parents = Parent.query.all()
dat = json.dumps({"data": parents}, cls=ParentEncoder)
resp = Response(response=dat, status=200, mimetype="application/json")
return (resp)

尽管父母之间有关系，但效果很好

解决方案 15：

已经有很多次了，并且有很多有效的答案，但是下面的代码块似乎有效：

my_object = SqlAlchemyModel()
my_serializable_obj = my_object.__dict__
del my_serializable_obj["_sa_instance_state"]
print(jsonify(my_serializable_object))

我知道这不是一个完美的解决方案，也不像其他解决方案那么优雅，但是对于那些想要快速解决问题的人来说，他们可能会尝试这个。