it-roy-ru.com

Как сериализовать SqlAlchemy результат в JSON?

В Django есть несколько хороших автоматических сериализаций моделей ORM, возвращаемых из DB в формат JSON.

Как сериализовать результат запроса SQLAlchemy в формат JSON? 

Я пытался jsonpickle.encode, но он сам кодирует объект запроса . Я пробовал json.dumps(items), но он возвращает

TypeError: <Product('3', 'some name', 'some desc')> is not JSON serializable

Неужели так сложно сериализовать объекты SQLAlchemy ORM в JSON/XML? Нет ли для этого сериализатора по умолчанию? В настоящее время очень распространена задача сериализации результатов запроса ORM.

Что мне нужно, это просто вернуть JSON или XML представление данных результата запроса SQLAlchemy.

Результат запроса объектов SQLAlchemy в формате JSON/XML необходим для использования в javascript datagird (JQGrid http://www.trirand.com/blog/ )

132
Zelid

Плоская реализация

Вы можете использовать что-то вроде этого:

from sqlalchemy.ext.declarative import DeclarativeMeta

class AlchemyEncoder(json.JSONEncoder):

    def default(self, obj):
        if isinstance(obj.__class__, DeclarativeMeta):
            # an SQLAlchemy class
            fields = {}
            for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata']:
                data = obj.__getattribute__(field)
                try:
                    json.dumps(data) # this will fail on non-encodable values, like other classes
                    fields[field] = data
                except TypeError:
                    fields[field] = None
            # a json-encodable dict
            return fields

        return json.JSONEncoder.default(self, obj)

а затем преобразовать в JSON, используя:

c = YourAlchemyClass()
print json.dumps(c, cls=AlchemyEncoder)

Он будет игнорировать поля, которые не кодируются (установите для них значение «Нет»).

Он не расширяет отношения автоматически (поскольку это может привести к самоссылке и циклу навсегда).

Рекурсивная, некруглая реализация

Однако, если вы предпочитаете цикл навсегда, вы можете использовать:

from sqlalchemy.ext.declarative import DeclarativeMeta

def new_alchemy_encoder():
    _visited_objs = []

    class AlchemyEncoder(json.JSONEncoder):
        def default(self, obj):
            if isinstance(obj.__class__, DeclarativeMeta):
                # don't re-visit self
                if obj in _visited_objs:
                    return None
                _visited_objs.append(obj)

                # an SQLAlchemy class
                fields = {}
                for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata']:
                    fields[field] = obj.__getattribute__(field)
                # a json-encodable dict
                return fields

            return json.JSONEncoder.default(self, obj)

    return AlchemyEncoder

А затем кодировать объекты с помощью:

print json.dumps(e, cls=new_alchemy_encoder(), check_circular=False)

Это закодирует всех детей, и всех их детей, и всех их детей ... Потенциально, в основном, закодируйте всю вашу базу данных. Когда он достигнет чего-то, что было закодировано ранее, он закодирует его как «Нет».

Рекурсивная, возможно круговая, выборочная реализация

Другая альтернатива, возможно, лучше, это возможность указать поля, которые вы хотите расширить:

def new_alchemy_encoder(revisit_self = False, fields_to_expand = []):
    _visited_objs = []

    class AlchemyEncoder(json.JSONEncoder):
        def default(self, obj):
            if isinstance(obj.__class__, DeclarativeMeta):
                # don't re-visit self
                if revisit_self:
                    if obj in _visited_objs:
                        return None
                    _visited_objs.append(obj)

                # go through each field in this SQLalchemy class
                fields = {}
                for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata']:
                    val = obj.__getattribute__(field)

                    # is this field another SQLalchemy object, or a list of SQLalchemy objects?
                    if isinstance(val.__class__, DeclarativeMeta) or (isinstance(val, list) and len(val) > 0 and isinstance(val[0].__class__, DeclarativeMeta)):
                        # unless we're expanding this field, stop here
                        if field not in fields_to_expand:
                            # not expanding this field: set it to None and continue
                            fields[field] = None
                            continue

                    fields[field] = val
                # a json-encodable dict
                return fields

            return json.JSONEncoder.default(self, obj)

    return AlchemyEncoder

Теперь вы можете позвонить с помощью:

print json.dumps(e, cls=new_alchemy_encoder(False, ['parents']), check_circular=False)

Например, чтобы расширить только поля SQLAlchemy, называемые «родители».

107
Sasha B

Вы могли бы просто вывести свой объект как dict:

class User:
   def as_dict(self):
       return {c.name: getattr(self, c.name) for c in self.__table__.columns}

А затем вы используете User.as_dict () для сериализации вашего объекта.

Как объясняется в Конвертировать объект строки sqlalchemy в python dict

207
charlax

Вы можете конвертировать RowProxy в dict следующим образом:

 d = dict(row.items())

Затем сериализуйте это в JSON (вам нужно будет указать кодировщик для таких вещей, как значения datetime) Это не так сложно, если вы просто хотите одну запись (а не полную иерархию связанных записей).

json.dumps([(dict(row.items())) for row in rs])
43
Nick Perkins

Я рекомендую использовать недавно появившуюся библиотеку Marshmallow . Это позволяет создавать сериализаторы для представления экземпляров вашей модели с поддержкой отношений и вложенных объектов.

Посмотрите на пример SQLAlchemy .

34
Yasir Hantoush

Flask-JsonTools package имеет реализацию JsonSerializableBase Base для ваших моделей.

Использование:

from sqlalchemy.ext.declarative import declarative_base
from flask.ext.jsontools import JsonSerializableBase

Base = declarative_base(cls=(JsonSerializableBase,))

class User(Base):
    #...

Теперь модель User магически сериализуема.

Если ваш фреймворк не Flask, вы можете просто получить код

14
kolypto

Из соображений безопасности вы никогда не должны возвращать все поля модели. Я предпочитаю выборочно выбирать их.

Json-кодировка Flask теперь поддерживает UUID, datetime и отношения (и добавлены query и query_class для класса flask_sqlalchemy db.Model). Я обновил кодировщик следующим образом:

приложение/json_encoder.py

    from sqlalchemy.ext.declarative import DeclarativeMeta
    from flask import json


    class AlchemyEncoder(json.JSONEncoder):
        def default(self, o):
            if isinstance(o.__class__, DeclarativeMeta):
                data = {}
                fields = o.__json__() if hasattr(o, '__json__') else dir(o)
                for field in [f for f in fields if not f.startswith('_') and f not in ['metadata', 'query', 'query_class']]:
                    value = o.__getattribute__(field)
                    try:
                        json.dumps(value)
                        data[field] = value
                    except TypeError:
                        data[field] = None
                return data
            return json.JSONEncoder.default(self, o)

app/__init__.py

# json encoding
from app.json_encoder import AlchemyEncoder
app.json_encoder = AlchemyEncoder

При этом я могу при желании добавить свойство __json__, которое возвращает список полей, которые я хочу кодировать:

app/models.py

class Queue(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    song_id = db.Column(db.Integer, db.ForeignKey('song.id'), unique=True, nullable=False)
    song = db.relationship('Song', lazy='joined')
    type = db.Column(db.String(20), server_default=u'audio/mpeg')
    src = db.Column(db.String(255), nullable=False)
    created_at = db.Column(db.DateTime, server_default=db.func.now())
    updated_at = db.Column(db.DateTime, server_default=db.func.now(), onupdate=db.func.now())

    def __init__(self, song):
        self.song = song
        self.src = song.full_path

    def __json__(self):
        return ['song', 'src', 'type', 'created_at']

Я добавляю @jsonapi в свое представление, возвращаю список результатов, а затем получаю следующий вывод:

[

{

    "created_at": "Thu, 23 Jul 2015 11:36:53 GMT",
    "song": 

        {
            "full_path": "/static/music/Audioslave/Audioslave [2002]/1 Cochise.mp3",
            "id": 2,
            "path_name": "Audioslave/Audioslave [2002]/1 Cochise.mp3"
        },
    "src": "/static/music/Audioslave/Audioslave [2002]/1 Cochise.mp3",
    "type": "audio/mpeg"
}

]
11
Tjorriemorrie

Вы можете использовать самоанализ SqlAlchemy так: 

mysql = SQLAlchemy()
from sqlalchemy import inspect

class Contacts(mysql.Model):  
    __table= 'CONTACTS'
    id = mysql.Column(mysql.Integer, primary_key=True)
    first_name = mysql.Column(mysql.String(128), nullable=False)
    last_name = mysql.Column(mysql.String(128), nullable=False)
    phone = mysql.Column(mysql.String(128), nullable=False)
    email = mysql.Column(mysql.String(128), nullable=False)
    street = mysql.Column(mysql.String(128), nullable=False)
    Zip_code = mysql.Column(mysql.String(128), nullable=False)
    city = mysql.Column(mysql.String(128), nullable=False)
    def toDict(self):
        return { c.key: getattr(self, c.key) for c in inspect(self).mapper.column_attrs }

@app.route('/contacts',methods=['GET'])
def getContacts():
    contacts = Contacts.query.all()
    contactsArr = []
    for contact in contacts:
        contactsArr.append(contact.toDict()) 
    return jsonify(contactsArr)

@app.route('/contacts/<int:id>',methods=['GET'])
def getContact(id):
    contact = Contacts.query.get(id)
    return jsonify(contact.toDict())

Получите вдохновение от ответа здесь: Конвертировать объект строки sqlalchemy в python dict

8
phico

Более подробное объяснение. В вашей модели добавьте: 

def as_dict(self):
       return {c.name: str(getattr(self, c.name)) for c in self.__table__.columns}

str() предназначен для python 3, поэтому при использовании python 2 используйте unicode(). Это должно помочь десериализировать даты. Вы можете удалить его, если не имеете дела с ними.

Теперь вы можете запросить базу данных, как это

some_result = User.query.filter_by(id=current_user.id).first().as_dict()

First() необходима, чтобы избежать странных ошибок. as_dict() теперь десериализует результат. После десериализации он готов к обращению в json

jsonify(some_result)
4
Patrick Mutuku

Это не так просто. Я написал код для этого. Я все еще работаю над этим, и он использует фреймворк MochiKit. Он в основном транслирует составные объекты между Python и Javascript, используя прокси и зарегистрированные конверторы JSON. 

Сторона браузера для объектов базы данных - db.js Требуется базовый источник прокси Python в proxy.js .

На стороне Python есть базовый прокси-модуль . Затем, наконец, объект-кодировщик SqlAlchemy в webserver.py . Это также зависит от экстракторов метаданных, найденных в models.py файл.

3
Keith

Вот решение, которое позволяет вам выбрать отношения, которые вы хотите включить в свой вывод, настолько глубоко, насколько вы хотели бы зайти ........ ПРИМЕЧАНИЕ. Это полная перезапись, в которой в качестве аргумента используется аргумент dict/str, а не список. , исправляет некоторые вещи ..

def deep_dict(self, relations={}):
    """Output a dict of an SA object recursing as deep as you want.

    Takes one argument, relations which is a dictionary of relations we'd
    like to pull out. The relations dict items can be a single relation
    name or deeper relation names connected by sub dicts

    Example:
        Say we have a Person object with a family relationship
            person.deep_dict(relations={'family':None})
        Say the family object has homes as a relation then we can do
            person.deep_dict(relations={'family':{'homes':None}})
            OR
            person.deep_dict(relations={'family':'homes'})
        Say homes has a relation like rooms you can do
            person.deep_dict(relations={'family':{'homes':'rooms'}})
            and so on...
    """
    mydict =  dict((c, str(a)) for c, a in
                    self.__dict__.items() if c != '_sa_instance_state')
    if not relations:
        # just return ourselves
        return mydict

    # otherwise we need to go deeper
    if not isinstance(relations, dict) and not isinstance(relations, str):
        raise Exception("relations should be a dict, it is of type {}".format(type(relations)))

    # got here so check and handle if we were passed a dict
    if isinstance(relations, dict):
        # we were passed deeper info
        for left, right in relations.items():
            myrel = getattr(self, left)
            if isinstance(myrel, list):
                mydict[left] = [rel.deep_dict(relations=right) for rel in myrel]
            else:
                mydict[left] = myrel.deep_dict(relations=right)
    # if we get here check and handle if we were passed a string
    Elif isinstance(relations, str):
        # passed a single item
        myrel = getattr(self, relations)
        left = relations
        if isinstance(myrel, list):
            mydict[left] = [rel.deep_dict(relations=None)
                                 for rel in myrel]
        else:
            mydict[left] = myrel.deep_dict(relations=None)

    return mydict

так, например, используя человек/семью/дома/комнаты ... превращая его в JSON все, что вам нужно, это

json.dumps(person.deep_dict(relations={'family':{'homes':'rooms'}}))
2
tahoe

В то время как первоначальный вопрос уходит в прошлое, количество ответов здесь (и мой собственный опыт) позволяют предположить, что это нетривиальный вопрос с множеством разных подходов различной сложности с различными компромиссами.

Вот почему я создал библиотеку SQLAthanor , которая расширяет декларативную ORM SQLAlchemy с настраиваемой поддержкой сериализации/десериализации, на которую вы, возможно, захотите взглянуть.

Библиотека поддерживает:

  • Python 2.7, 3.4, 3.5 и 3.6.
  • SQLAlchemy версии 0.9 и выше
  • сериализация/десериализация в/из JSON, CSV, YAML и Python dict
  • сериализация/десериализация столбцов/атрибутов, отношений, гибридных свойств и прокси-серверов ассоциаций
  • включение и отключение сериализации для определенных форматов и столбцов/отношений/атрибутов (например, вы хотите поддерживать значение inboundpassword, но никогда не включать значение outbound)
  • обработка перед сериализацией и после десериализации (для проверки или приведения типа)
  • довольно простой синтаксис, который является и Pythonic и полностью совместим с собственным подходом SQLAlchemy

Вы можете ознакомиться с (я надеюсь!) Исчерпывающими документами здесь: https://sqlathanor.readthedocs.io/en/latest

Надеюсь это поможет!

2
Chris Modzelewski

Пользовательские сериализация и десериализация.

"from_json" (метод класса) строит объект Model на основе данных json.

"десериализация" может быть вызвана только в экземпляре и объединить все данные из json в экземпляр модели.

"сериализация" - рекурсивная сериализация

_WRITE_ONLY_свойство необходимо для определения свойств только для записи (например, "password_hash").

class Serializable(object):
    __exclude__ = ('id',)
    __include__ = ()
    __write_only__ = ()

    @classmethod
    def from_json(cls, json, selfObj=None):
        if selfObj is None:
            self = cls()
        else:
            self = selfObj
        exclude = (cls.__exclude__ or ()) + Serializable.__exclude__
        include = cls.__include__ or ()
        if json:
            for prop, value in json.iteritems():
                # ignore all non user data, e.g. only
                if (not (prop in exclude) | (prop in include)) and isinstance(
                        getattr(cls, prop, None), QueryableAttribute):
                    setattr(self, prop, value)
        return self

    def deserialize(self, json):
        if not json:
            return None
        return self.__class__.from_json(json, selfObj=self)

    @classmethod
    def serialize_list(cls, object_list=[]):
        output = []
        for li in object_list:
            if isinstance(li, Serializable):
                output.append(li.serialize())
            else:
                output.append(li)
        return output

    def serialize(self, **kwargs):

        # init write only props
        if len(getattr(self.__class__, '__write_only__', ())) == 0:
            self.__class__.__write_only__ = ()
        dictionary = {}
        expand = kwargs.get('expand', ()) or ()
        prop = 'props'
        if expand:
            # expand all the fields
            for key in expand:
                getattr(self, key)
        iterable = self.__dict__.items()
        is_custom_property_set = False
        # include only properties passed as parameter
        if (prop in kwargs) and (kwargs.get(prop, None) is not None):
            is_custom_property_set = True
            iterable = kwargs.get(prop, None)
        # loop trough all accessible properties
        for key in iterable:
            accessor = key
            if isinstance(key, Tuple):
                accessor = key[0]
            if not (accessor in self.__class__.__write_only__) and not accessor.startswith('_'):
                # force select from db to be able get relationships
                if is_custom_property_set:
                    getattr(self, accessor, None)
                if isinstance(self.__dict__.get(accessor), list):
                    dictionary[accessor] = self.__class__.serialize_list(object_list=self.__dict__.get(accessor))
                # check if those properties are read only
                Elif isinstance(self.__dict__.get(accessor), Serializable):
                    dictionary[accessor] = self.__dict__.get(accessor).serialize()
                else:
                    dictionary[accessor] = self.__dict__.get(accessor)
        return dictionary
2
Артем Федоров
def alc2json(row):
    return dict([(col, str(getattr(row,col))) for col in row.__table__.columns.keys()])

Я думал, что поиграю в маленький гольф с этим. 

К вашему сведению: я использую automap_base , поскольку у нас есть отдельно разработанная схема в соответствии с требованиями бизнеса. Я только что начал использовать SQLAlchemy сегодня, но в документации говорится, что automap_base является расширением декларативной_базы, которая, кажется, является типичной парадигмой в ORM SQLAlchemy, поэтому я считаю, что это должно работать.

Ему не нравятся следующие внешние ключи для решения Tjorriemorrie , но он просто сопоставляет столбцы со значениями и обрабатывает типы Python с помощью str () - значений столбцов. Наши значения состоят из Python datetime.time и decimal.Decimal, результаты типа класса, поэтому он выполняет свою работу.

Надеюсь, это поможет любому прохожему!

1
hpatel71

следующий код будет сериализовать результат sqlalchemy в json.

import json
from collections import OrderedDict


def asdict(self):
    result = OrderedDict()
    for key in self.__mapper__.c.keys():
        if getattr(self, key) is not None:
            result[key] = str(getattr(self, key))
        else:
            result[key] = getattr(self, key)
    return result


def to_array(all_vendors):
    v = [ ven.asdict() for ven in all_vendors ]
    return json.dumps(v) 

Вызывая веселье,

def all_products():
    all_products = Products.query.all()
    return to_array(all_products)
1
Chirag Vora

AlchemyEncoder замечательный, но иногда терпит неудачу с десятичными значениями. Вот улучшенный кодер, который решает десятичную проблему -

class AlchemyEncoder(json.JSONEncoder):
# To serialize SQLalchemy objects 
def default(self, obj):
    if isinstance(obj.__class__, DeclarativeMeta):
        model_fields = {}
        for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata']:
            data = obj.__getattribute__(field)
            print data
            try:
                json.dumps(data)  # this will fail on non-encodable values, like other classes
                model_fields[field] = data
            except TypeError:
                model_fields[field] = None
        return model_fields
    if isinstance(obj, Decimal):
        return float(obj)
    return json.JSONEncoder.default(self, obj)
1
vineet agarwal

Используйте встроенный сериализатор в SQLAlchemy:

from sqlalchemy.ext.serializer import loads, dumps
obj = MyAlchemyObject()
# serialize object
serialized_obj = dumps(obj)

# deserialize object
obj = loads(serialized_obj)

Если вы переносите объект между сеансами, не забудьте отсоединить объект от текущего сеанса с помощью session.expunge(obj). Чтобы присоединить его снова, просто выполните session.add(obj).

0
chribsen

Под Flask это работает и обрабатывает поля времени данных, преобразовывая поле типа
'time': datetime.datetime(2018, 3, 22, 15, 40) в
"time": "2018-03-22 15:40:00":

obj = {c.name: str(getattr(self, c.name)) for c in self.__table__.columns}

# This to get the JSON body
return json.dumps(obj)

# Or this to get a response object
return jsonify(obj)
0
belvederef

Встроенные дроссели сериализатора с utf-8 не могут декодировать недопустимый начальный байт для некоторых входов. Вместо этого я пошел с:

def row_to_dict(row):
    temp = row.__dict__
    temp.pop('_sa_instance_state', None)
    return temp


def rows_to_list(rows):
    ret_rows = []
    for row in rows:
        ret_rows.append(row_to_dict(row))
    return ret_rows


@website_blueprint.route('/api/v1/some/endpoint', methods=['GET'])
def some_api():
    '''
    /some_endpoint
    '''
    rows = rows_to_list(SomeModel.query.all())
    response = app.response_class(
        response=jsonplus.dumps(rows),
        status=200,
        mimetype='application/json'
    )
    return response
0
RobotHumans

Я знаю, что это довольно старый пост. Я принял решение, данное @SashaB, и изменил в соответствии с моими потребностями. 

Я добавил следующие вещи к нему:

  1. Список игнорируемых полей: список полей, которые нужно игнорировать при сериализации
  2. Список замены полей: словарь, содержащий имена полей, которые должны быть заменены значениями при сериализации.
  3. Удаленные методы и BaseQuery становятся сериализованными

Мой код выглядит следующим образом:

def alchemy_json_encoder(revisit_self = False, fields_to_expand = [], fields_to_ignore = [], fields_to_replace = {}):
   """
   Serialize SQLAlchemy result into JSon
   :param revisit_self: True / False
   :param fields_to_expand: Fields which are to be expanded for including their children and all
   :param fields_to_ignore: Fields to be ignored while encoding
   :param fields_to_replace: Field keys to be replaced by values assigned in dictionary
   :return: Json serialized SQLAlchemy object
   """
   _visited_objs = []
   class AlchemyEncoder(json.JSONEncoder):
      def default(self, obj):
        if isinstance(obj.__class__, DeclarativeMeta):
            # don't re-visit self
            if revisit_self:
                if obj in _visited_objs:
                    return None
                _visited_objs.append(obj)

            # go through each field in this SQLalchemy class
            fields = {}
            for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata' and x not in fields_to_ignore]:
                val = obj.__getattribute__(field)
                # is this field method defination, or an SQLalchemy object
                if not hasattr(val, "__call__") and not isinstance(val, BaseQuery):
                    field_name = fields_to_replace[field] if field in fields_to_replace else field
                    # is this field another SQLalchemy object, or a list of SQLalchemy objects?
                    if isinstance(val.__class__, DeclarativeMeta) or \
                            (isinstance(val, list) and len(val) > 0 and isinstance(val[0].__class__, DeclarativeMeta)):
                        # unless we're expanding this field, stop here
                        if field not in fields_to_expand:
                            # not expanding this field: set it to None and continue
                            fields[field_name] = None
                            continue

                    fields[field_name] = val
            # a json-encodable dict
            return fields

        return json.JSONEncoder.default(self, obj)
   return AlchemyEncoder

Надеюсь, это поможет кому-то!

0
srahul07