Python __repr__ 和 None

Question

我对 Python 还很陌生，目前我需要一个 SqlAlchemy 类的 __repr__ 。 我有一个可以接受 Null 值的整数列，SqlAlchemy 将其转换为 None 。 例如：

class Stats(Base):
   __tablename__ = "stats"
   description = Column(String(2000))
   mystat = Column(Integer, nullable=True)

当 SqlAlchemy 返回 None 时，在 __repr__ 函数中表示“mystat”字段的正确方法是什么？

Answer 1

__repr__ 应返回描述该对象的字符串。如果可能，它应该是一个计算结果为相等对象的有效 Python 表达式。对于 int 或 str 等内置类型来说也是如此：

>>> x = 'foo'
>>> eval(repr(x)) == x
True

如果不可能，它应该是 '<...>' 唯一描述对象的字符串。默认的 __repr__ 就是一个例子：

>>> class Foo(object):
        pass
>>>
>>> repr(Foo())
'<__main__.Foo object at 0x02A74E50>'

它使用对象在内存中的地址来唯一标识它。当然，地址并不能告诉我们太多有关该对象的信息，因此重写 __repr__ 并返回描述对象状态的字符串很有用。

对象的状态由它包含的其他对象定义，因此将它们的 repr 包含在您的状态中是有意义的。这正是 list 或 dict 所做的：

>>> repr(['bar', Foo()])
"['bar', <__main__.Foo object at 0x02A74710>]"

在您的情况下，状态位于您的 Column 属性中，因此您想使用它们的 代表。您可以为此使用 %r 格式，它会插入参数的 repr()：

def __repr__(self):
    return '<Stats: description=%r, mystat=%r>' % (self.description, self.mystat)

使用新格式的等效项：

def __repr__(self):
    return '<Stats: description={0.description!r}, mystat={0.mystat!r}>'.format(self)

Answer 2

我试图找到一个可以在任何 SQLAlchemy 对象上使用的通用 __repr__ 方法，但只找到了这个页面。因此，我决定编写自己的代码，这就是我所做的：

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()

if __debug__:
    # monkey-patch in useful repr() for all objects, but only in dev
    def tablerepr(self):
        return "<{}({})>".format(
            self.__class__.__name__,
            ', '.join(
                ["{}={}".format(k, repr(self.__dict__[k]))
                    for k in sorted(self.__dict__.keys())
                    if k[0] != '_']
            )
        )
    Base.__repr__ = tablerepr

这扩展了 Base 类以打印出特定实例的内容。因此，现在我创建的每个扩展 Base 的对象都将具有一个 __repr__ 方法，该方法不仅仅打印类名和实例哈希。

编辑：我添加了一个if __debug__，因为此更改可能会导致您可能不希望在生产环境中泄漏的信息泄漏。我还添加了一个sorted，以便显示保持一致。

Answer 3

不是 sqlalchemy 的 generic_repr 装饰器-utils 提供适合您需求的基于社区的解决方案吗？

它将其保留为“无”。

Answer 4

也许 repr(mystat) 就是你想要的？

Answer 5

如果 mystat 是 None else mystat，则为“Null”

Answer 6

前面的答案显示了如何覆盖 Base.__repr__ 正是我所需要的。谢谢你！这里它是用 Python 3.7+ 的 f 字符串重写的，并覆盖了 Flask-sqlalchemy db.Model。

def override_default_repr(self):
    class_name = self.__class__.__name__
    attribs = ", ".join(
        [
            f"{k}={self.__dict__[k]!r}"
            for k in sorted(self.__dict__.keys())
            if k[0] != "_"
        ]
    )
    return f"<{class_name}({attribs})>"

db.Model.__repr__ = override_default_repr