ORM列能否在SQLAlchemy中触发会话刷新？

Question

问题

在SQLAlchemy中，属性访问会触发会话刷新吗？我原本期待，比如通过column_property()或@hybrid_property附加到对象上的查询，能够像通过session.Query()进行的查询那样，自动触发会话刷新。但似乎并不是这样。

在下面这个简单的例子中，一个账户（Account）包含一个条目集合（Entry）。它还提供了一个“余额”（balance）属性，这个属性是用column_property()构建的，能够显示一个选择求和的查询。只有在明确调用session.flush()时，新条目才会出现在账户的余额中。

这种行为似乎不太理想：使用Account类的用户需要在代码中到处添加flush()调用，这样才能知道余额的内部实现。如果实现发生变化，比如“余额”之前是一个Python的@property，可能会引入错误，尽管Account的接口基本上是相同的。有没有其他的解决办法？

完整示例

import sys
import sqlalchemy as sa
import sqlalchemy.sql
import sqlalchemy.orm
import sqlalchemy.ext.declarative

Base = sa.ext.declarative.declarative_base()

class Entry(Base):
    __tablename__ = "entries"

    id = sa.Column(sa.Integer, primary_key=True)
    value = sa.Column(sa.Numeric, primary_key=True)
    account_id = sa.Column(sa.Integer, sa.ForeignKey("accounts.id"))
    account = sa.orm.relationship("Account", backref="entries")

class Account(Base):
    __tablename__ = "accounts"

    id = sa.Column(sa.Integer, primary_key=True)
    balance = sa.orm.column_property(
        sa.sql.select([sa.sql.func.sum(Entry.value)])
            .where(Entry.account_id == id)
        )

def example(database_url):
    # connect to the database and prepare the schema
    engine = sa.create_engine(database_url)
    session = sa.orm.sessionmaker(bind=engine)()

    Base.metadata.create_all(bind = engine)

    # add an entry to an account
    account = Account()

    account.entries.append(Entry(value = 42))

    session.add(account)

    # and look for that entry in the balance
    print "account.balance:", account.balance

    assert account.balance == 42

if __name__ == "__main__":
    example(sys.argv[1])

观察到的输出

$ python sa_column_property_example.py postgres:///za_test
account.balance: None
Traceback (most recent call last):
  File "sa_column_property_example.py", line 46, in <module>
    example(sys.argv[1])
  File "sa_column_property_example.py", line 43, in example
    assert account.balance == 42
AssertionError

期望的输出

我希望看到“account.balance: 42”，而不需要添加session.flush()的显式调用。

Answer 1

一个列属性（column_property）只有在查询的时候才会被计算，也就是说，当你执行查询（比如说查询账户信息）的时候，或者当这个属性过期的时候，比如你让会话过期某个账户的余额时。

如果想让某个属性每次都触发查询，我们可以使用@property（这里对脚本做了一些小修改，以便与sqlite兼容）：

import sys
import sqlalchemy as sa
import sqlalchemy.sql
import sqlalchemy.orm
import sqlalchemy.ext.declarative

Base = sa.ext.declarative.declarative_base()

class Entry(Base):
    __tablename__ = "entries"

    id = sa.Column(sa.Integer, primary_key=True)
    value = sa.Column(sa.Numeric)
    account_id = sa.Column(sa.Integer, sa.ForeignKey("accounts.id"))
    account = sa.orm.relationship("Account", backref="entries")

class Account(Base):
    __tablename__ = "accounts"

    id = sa.Column(sa.Integer, primary_key=True)

    @property
    def balance(self):
        return sqlalchemy.orm.object_session(self).query(
                    sa.sql.func.sum(Entry.value)
                ).filter(Entry.account_id == self.id).scalar()

def example(database_url):
    # connect to the database and prepare the schema
    engine = sa.create_engine(database_url, echo=True)
    session = sa.orm.sessionmaker(bind=engine)()

    Base.metadata.create_all(bind = engine)

    # add an entry to an account
    account = Account()

    account.entries.append(Entry(value = 42))

    session.add(account)

    # and look for that entry in the balance
    print "account.balance:", account.balance

    assert account.balance == 42

if __name__ == "__main__":
    example("sqlite://")

需要注意的是，“刷新”（flushing）本身通常不需要我们太担心；自动刷新功能会确保每次调用query()去数据库获取结果时都会进行刷新，所以这实际上是在确保查询的发生，这正是我们想要的。

解决这个问题的另一种方法是使用混合属性（hybrids）。我建议你阅读一下这三种方法的概述，链接在这里：SQL Expressions as Mapped Attributes，里面列出了每种方法的利弊。