迭代sqlalchemy模型的已定义列的方法？

Question

我一直在试图弄清楚如何迭代SQLAlchemy模型中定义的列列表.我希望它能为一些模型编写一些序列化和复制方法.我不能只迭代obj.__dict__它,因为它包含很多特定于SA的项目.

任何人都知道如何从以下获取id和desc名称？

class JobStatus(Base):
    __tablename__ = 'jobstatus'

    id = Column(Integer, primary_key=True)
    desc = Column(Unicode(20))

在这个小案例中,我可以轻松创建:

def logme(self):
    return {'id': self.id, 'desc': self.desc}

但我更喜欢自动生成的东西dict(对于较大的对象).

谢谢你的帮助.

Answer 1

您可以使用以下功能:

def __unicode__(self):
    return "[%s(%s)]" % (self.__class__.__name__, ', '.join('%s=%s' % (k, self.__dict__[k]) for k in sorted(self.__dict__) if '_sa_' != k[:4]))

它将排除SA 魔术属性,但不会排除关系.所以基本上它可能会加载依赖项,父项,子项等,这绝对是不可取的.

但它实际上要容易得多,因为如果你继承Base,你有一个__table__属性,所以你可以这样做:

for c in JobStatus.__table__.columns:
    print c

for c in JobStatus.__table__.foreign_keys:
    print c

请参阅如何从SQLAlchemy映射对象中发现表属性 - 类似的问题.

由Mike编辑:请参阅Mapper.c和Mapper.mapped_table等功能.如果使用0.8和更高版本也可以看到Mapper.attrs和相关函数.

Mapper.attrs的示例:

from sqlalchemy import inspect
mapper = inspect(JobStatus)
for column in mapper.attrs:
    print column.key

Answer 2

您可以从映射器中获取已定义属性的列表.对于您的情况,您只对ColumnProperty对象感兴趣.

from sqlalchemy.orm import class_mapper
import sqlalchemy

def attribute_names(cls):
    return [prop.key for prop in class_mapper(cls).iterate_properties
        if isinstance(prop, sqlalchemy.orm.ColumnProperty)]

Answer 3

我意识到这是一个老问题,但我只是遇到了同样的要求,并希望为未来的读者提供替代解决方案.

正如Josh所说,将返回完整的SQL字段名称JobStatus.__table__.columns,因此您将获得jobstatus.id而不是原始字段名称 ID.没有那么有用.

获取最初定义的字段名称列表的解决方案是查看_data包含完整数据的列对象上的属性.如果我们看一下JobStatus.__table__.columns._data,它看起来像这样:

{'desc': Column('desc', Unicode(length=20), table=<jobstatus>),
 'id': Column('id', Integer(), table=<jobstatus>, primary_key=True, nullable=False)}

从这里你可以简单地打电话JobStatus.__table__.columns._data.keys()给你一个漂亮,干净的清单:

['id', 'desc']

Answer 4

self.__table__.columns将"仅"为您提供该特定类中定义的列,即没有继承的列.如果你需要所有,请使用self.__mapper__.columns.在你的例子中,我可能会使用这样的东西:

class JobStatus(Base):

    ...

    def __iter__(self):
        values = vars(self)
        for attr in self.__mapper__.columns.keys():
            if attr in values:
                yield attr, values[attr]

    def logme(self):
        return dict(self)

Answer 5

为了as_dict在我的所有类上获得一个方法,我使用了一个Mixin使用Ants Aasma描述的技术的类.

class BaseMixin(object):                                                                                                                                                                             
    def as_dict(self):                                                                                                                                                                               
        result = {}                                                                                                                                                                                  
        for prop in class_mapper(self.__class__).iterate_properties:                                                                                                                                 
            if isinstance(prop, ColumnProperty):                                                                                                                                                     
                result[prop.key] = getattr(self, prop.key)                                                                                                                                           
        return result

然后在课堂上使用它

class MyClass(BaseMixin, Base):
    pass

这样你就可以在一个实例上调用以下内容MyClass.

> myclass = MyClass()
> myclass.as_dict()

希望这可以帮助.

我已经对此进行了更多的讨论,我实际上需要将我的实例渲染为HAL对象dict的形式,并将其链接到相关对象.所以我在这里添加了这个小魔法,它将爬过类的所有属性,与上面相同,不同之处在于我将更深入地抓取属性并自动生成这些属性.Relaionshiplinks

请注意,这仅适用于具有单个主键的关系

from sqlalchemy.orm import class_mapper, ColumnProperty
from functools import reduce


def deepgetattr(obj, attr):
    """Recurses through an attribute chain to get the ultimate value."""
    return reduce(getattr, attr.split('.'), obj)


class BaseMixin(object):
    def as_dict(self):
        IgnoreInstrumented = (
            InstrumentedList, InstrumentedDict, InstrumentedSet
        )
        result = {}
        for prop in class_mapper(self.__class__).iterate_properties:
            if isinstance(getattr(self, prop.key), IgnoreInstrumented):
                # All reverse relations are assigned to each related instances
                # we don't need to link these, so we skip
                continue
            if isinstance(prop, ColumnProperty):
                # Add simple property to the dictionary with its value
                result[prop.key] = getattr(self, prop.key)
            if isinstance(prop, RelationshipProperty):
                # Construct links relaions
                if 'links' not in result:
                    result['links'] = {}

                # Get value using nested class keys
                value = (
                    deepgetattr(
                        self, prop.key + "." + prop.mapper.primary_key[0].key
                    )
                )
                result['links'][prop.key] = {}
                result['links'][prop.key]['href'] = (
                    "/{}/{}".format(prop.key, value)
                )
        return result

Answer 6

假设您正在使用SQLAlchemy的声明性映射，则可以使用__mapper__attribute来获取类映射器。要获取所有映射的属性（包括关系）：

obj.__mapper__.attrs.keys()

如果需要严格的列名，请使用obj.__mapper__.column_attrs.keys()。有关其他视图，请参见文档。

https://docs.sqlalchemy.org/zh_CN/latest/orm/mapping_api.html#sqlalchemy.orm.mapper.Mapper.attrs