__str__() 实现的正确自动生成也适用于 sqlalchemy 类？

Question

我想干净整洁地显示/打印我的 sqlalchemy 课程。

在Is there a way to auto generate a __str__() implementation in python? 中，答案You can iterate instance attributes using vars, dir, ...:... 在简单类的情况下会有所帮助。

当我尝试将它应用到 Sqlalchemy 类（如来自 Introductory Tutorial of Python’s SQLAlchemy 的类 - 见下文）时，我得到 - 除了成员变量之外，还有以下条目作为成员变量：

_sa_instance_state=<sqlalchemy.orm.state.InstanceState object at 0x000000004CEBCC0>

如何避免此条目出现在__str__ 表示中？

为了完整起见，我也将链接的stackoverflow问题的解决方案放在下面。

import os
import sys
from sqlalchemy import Column, ForeignKey, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship
from sqlalchemy import create_engine

Base = declarative_base()

class Person(Base):
    __tablename__ = 'person'
    # Here we define columns for the table person
    # Notice that each column is also a normal Python instance attribute.
    id = Column(Integer, primary_key=True)
    name = Column(String(250), nullable=False)

如前所述，这是Is there a way to auto generate a __str__() implementation in python?的解决方案：

def auto_str(cls):
    def __str__(self):
        return '%s(%s)' % (
            type(self).__name__,
            ', '.join('%s=%s' % item for item in vars(self).items())
        )
    cls.__str__ = __str__
    return cls

@auto_str
class Foo(object):
    def __init__(self, value_1, value_2):
        self.attribute_1 = value_1
         self.attribute_2 = value_2

应用：

>>> str(Foo('bar', 'ping'))
'Foo(attribute_2=ping, attribute_1=bar)'

Answer 1

这是我用的：

def todict(obj):
    """ Return the object's dict excluding private attributes, 
    sqlalchemy state and relationship attributes.
    """
    excl = ('_sa_adapter', '_sa_instance_state')
    return {k: v for k, v in vars(obj).items() if not k.startswith('_') and
            not any(hasattr(v, a) for a in excl)}

class Base:

    def __repr__(self):
        params = ', '.join(f'{k}={v}' for k, v in todict(self).items())
        return f"{self.__class__.__name__}({params})"

Base = declarative_base(cls=Base)

从Base 继承的任何模型都将定义默认的__repr__() 方法，如果我需要做一些不同的事情，我可以覆盖该特定类的方法。

它不包括用前导下划线表示的任何私有属性的值、SQLAlchemy 实例状态对象以及字符串中的任何关系属性。我排除了关系属性，因为我通常不希望 repr 导致关系延迟加载，并且关系是双向的，包括关系属性会导致无限递归。

结果如下：ClassName(attr=val, ...)。

--编辑--

我上面提到的todict() 函数是我经常调用的一个助手，我经常调用它来从一个SQLA 对象中构造一个dict，主要用于序列化。我在这种情况下懒惰地使用它，但它不是很有效，因为它正在构造一个dict（在todict()）来构造一个dict（在__repr__()）。我已经修改了模式以调用生成器：

def keyvalgen(obj):
    """ Generate attr name/val pairs, filtering out SQLA attrs."""
    excl = ('_sa_adapter', '_sa_instance_state')
    for k, v in vars(obj).items():
        if not k.startswith('_') and not any(hasattr(v, a) for a in excl):
            yield k, v

那么基础 Base 是这样的：

class Base:

    def __repr__(self):
        params = ', '.join(f'{k}={v}' for k, v in keyvalgen(self))
        return f"{self.__class__.__name__}({params})"

todict() 函数也利用了keyvalgen() 生成器，但不再需要构造 repr。

Answer 2

我在我的基础模型上定义了这个__repr__ 方法：

def __repr__(self):
    fmt = '{}.{}({})'
    package = self.__class__.__module__
    class_ = self.__class__.__name__
    attrs = sorted(
        (k, getattr(self, k)) for k in self.__mapper__.columns.keys()
    )
    sattrs = ', '.join('{}={!r}'.format(*x) for x in attrs)
    return fmt.format(package, class_, sattrs)

该方法按字母顺序显示表中所有列的名称（但不显示关系）及其值的repr。我通常不定义__str__，除非我需要一个特定的形式——也许str(User(name='Alice')) 就是Alice——所以str(model_instance) 将调用__repr__ 方法。

示例代码

import datetime

import sqlalchemy as sa
from sqlalchemy.ext import declarative


class BaseModel(object):

    __abstract__ = True

    def __repr__(self):
        fmt = u'{}.{}({})'
        package = self.__class__.__module__
        class_ = self.__class__.__name__
        attrs = sorted(
            (k, getattr(self, k)) for k in self.__mapper__.columns.keys()
        )
        sattrs = u', '.join('{}={!r}'.format(*x) for x in attrs)
        return fmt.format(package, class_, sattrs)


Base = declarative.declarative_base(cls=BaseModel)


class MyModel(Base):

    __tablename__ = 'mytable'

    foo = sa.Column(sa.Unicode(32))
    bar = sa.Column('bar_id', sa.Integer, primary_key=True)
    baz = sa.Column(sa.DateTime)

>>> mm = models.MyModel(foo='Foo', bar=42, baz=datetime.datetime.now())
>>> mm
models.MyModel(bar=42, baz=datetime.datetime(2019, 1, 4, 7, 37, 59, 350432), foo='Foo')

---

此答案的原始版本使用模型的 __table__ 属性来访问列名。我已将其更改为使用模型的__mapper__，因为 SQLAlchemy 允许模型属性名称（存储在映射器中）与数据库中的列名称（存储在表中）不同。 MyModel.bar 演示了这一点。