zc.twist 1.3.1

Twist：在Twisted反应器调用中与ZODB通信

twist包包含一些函数和类，但主要是为在可调用的持久对象上或持久对象的某个方法上进行延迟调用而提供的一个辅助工具。这可以让Twisted反应器调用或Twisted延迟回调影响ZODB。所有操作都可以在主线程中完成，因此可以实现完全的Twisted使用，而无需线程。还有一些重要的“陷阱”：请参阅下面的陷阱部分以获取详细信息。

主要的API是Partial。您可以传递一个可调用的持久对象、持久对象的某个方法或一个普通非持久可调用对象，以及相同类型的任何参数或关键字参数。不要使用持久对象的非持久数据结构（如列表）作为数据库连接的参数。这是您的责任。

如果没有持久对象，partial将不会麻烦获取连接，并将按正常方式运行。

>>> from zc.twist import Partial
>>> def demo():
...     return 42
...
>>> Partial(demo)()
42

现在让我们想象一个持久并属于数据库连接的一部分的演示对象。它有一个从0开始的count属性，一个增加计数（默认为1）的__call__方法，以及一个减少计数（默认为1）的decrement方法 [1]。一切都会返回计数的当前值。

>>> demo.count
0
>>> demo()
1
>>> demo(2)
3
>>> demo.decrement()
2
>>> demo.decrement(2)
0
>>> import transaction
>>> transaction.commit()

现在我们可以使用这些示例进行一些延迟调用。我们将使用 transaction.begin() 来同步我们的连接与延迟调用中发生的情况。请注意，我们需要为这些适配器设置一些适配器才能使其工作。Twist模块包括它们的实现，我们假设它们已经被安装了。[2]。

>>> call = Partial(demo)
>>> demo.count # hasn't been called yet
0
>>> deferred = call()
>>> demo.count # we haven't synced yet
0
>>> t = transaction.begin() # sync the connection
>>> demo.count # ah-ha!
1

我们可以使用从调用返回的延迟来做一些与返回值相关的事情。在这种情况下，延迟已经完成，所以添加回调会立即执行。

>>> def show_value(res):
...     print res
...
>>> ignore = deferred.addCallback(show_value)
1

我们也可以传递方法。

>>> call = Partial(demo.decrement)
>>> deferred = call()
>>> demo.count
1
>>> t = transaction.begin()
>>> demo.count
0

这同样适用于槽方法。

>>> import BTrees
>>> tree = root['tree'] = BTrees.family32.OO.BTree()
>>> transaction.commit()
>>> call = Partial(tree.__setitem__, 'foo', 'bar')
>>> deferred = call()
>>> len(tree)
0
>>> t = transaction.begin()
>>> tree['foo']
'bar'

参数会传递过去。

>>> call = Partial(demo)
>>> deferred = call(2)
>>> t = transaction.begin()
>>> demo.count
2
>>> call = Partial(demo.decrement)
>>> deferred = call(amount=2)
>>> t = transaction.begin()
>>> demo.count
0

它们也可以在实例化期间设置。

>>> call = Partial(demo, 3)
>>> deferred = call()
>>> t = transaction.begin()
>>> demo.count
3
>>> call = Partial(demo.decrement, amount=3)
>>> deferred = call()
>>> t = transaction.begin()
>>> demo.count
0

参数本身可以是持久对象。让我们假设一个新的demo2对象。

>>> demo2.count
0
>>> def mass_increment(d1, d2, value=1):
...     d1(value)
...     d2(value)
...
>>> call = Partial(mass_increment, demo, demo2, value=4)
>>> deferred = call()
>>> t = transaction.begin()
>>> demo.count
4
>>> demo2.count
4
>>> demo.count = demo2.count = 0 # cleanup
>>> transaction.commit()

ConflictErrors会导致重试。

为了有模拟ConflictError的机会，这次想象我们有一个可以切换执行从调用到我们代码的运行器，使用pause、retry和resume（这只是为了测试–记住，在非线程Twisted中使用的调用应该是非阻塞的！）[3]。

>>> import sys
>>> demo.count
0
>>> call = Partial(demo)
>>> runner = Runner(call) # it starts paused in the middle of an attempt
>>> call.attempt_count
1
>>> demo.count = 5 # now we will make a conflicting transaction...
>>> transaction.commit()
>>> runner.retry()
>>> call.attempt_count # so it has to retry
2
>>> t = transaction.begin()
>>> demo.count # our value hasn't changed...
5
>>> runner.resume() # but now call will be successful on the second attempt
>>> call.attempt_count
2
>>> t = transaction.begin()
>>> demo.count
6

默认情况下，在五次ConflictError重试后，部分失败，引发最后的ConflictError。这被返回到延迟中。延迟上的失败将有一个清洗过的堆栈跟踪。在这里，想象我们有一个从这样一个事件创建的延迟（命名为 deferred）[4]。

>>> res = None
>>> def get_result(r):
...     global res
...     res = r # we return None to quiet Twisted down on the command line
...
>>> d = deferred.addErrback(get_result)
>>> print res.getTraceback() # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
ZODB.POSException.ConflictError: database conflict error...

你可以通过设置 max_transaction_errors 属性来控制应该执行多少次ConflictError（以及其他事务错误）重试[5]。

ZEO ClientDisconnected错误始终重试，默认情况下，退避策略从5秒开始，永远不会超过60秒[6] [7] [8]。

其他错误以清洗过的失败形式返回到延迟中，例如事务错误超过了其可用的重试次数。

>>> call = Partial(demo)
>>> d = call('I do not add well with integers')
>>> d = d.addErrback(get_result)
>>> print res.getTraceback() # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
...TypeError: unsupported operand type(s) for +=: 'int' and 'str'

失败被清洗，即堆栈跟踪消失，帧值被转换为repr。如果你序列化失败，那么repr将被截断为最多20个字符加上“[…]”来指示截断[9]。

调用试图成为一个好的连接市民，等待连接如果池的大小达到最大。此代码依赖于twisted反应器；我们将使用一个 time_flies 函数，该函数以秒为单位前进，来模拟反应器中的时间流逝。

我们使用2的幂（例如，0.125）作为浮点数，以避免测试中发生的浮点数累加错误，当时使用了0.1等值。

>>> db.setPoolSize(1)
>>> db.getPoolSize()
1
>>> demo.count = 0
>>> transaction.commit()
>>> call = Partial(demo)
>>> res = None
>>> deferred = call()
>>> d = deferred.addCallback(get_result)
>>> call.attempt_count
0
>>> time_flies(.125) >= 1 # returns number of connection attempts
True
>>> call.attempt_count
0
>>> res # None
>>> db.setPoolSize(2)
>>> db.getPoolSize()
2
>>> time_flies(.25) >= 1
True
>>> call.attempt_count > 0
True
>>> res
1
>>> t = transaction.begin()
>>> demo.count
1

如果需要超过一秒或两秒，它最终会决定抓取一个。这种行为可能会改变。

>>> db.setPoolSize(1)
>>> db.getPoolSize()
1
>>> call = Partial(demo)
>>> res = None
>>> deferred = call()
>>> d = deferred.addCallback(get_result)
>>> call.attempt_count
0
>>> time_flies(.125) >= 1
True
>>> call.attempt_count
0
>>> res # None
>>> time_flies(2) >= 2 # for a total of at least 3
True
>>> res
2
>>> t = transaction.begin()
>>> demo.count
2

如果没有运行的反应器，这个功能将无法工作[10]。

你也可以使用 setReactor 为部分指定一个反应器，如果你不想使用twisted在 twisted.internet.reactor 中安装的标准反应器[11]。

脚注

如果需要超过一秒或两秒，它最终会决定抓取一个。这种行为可能会改变。

>>> db.setPoolSize(1)
>>> db.getPoolSize()
1
>>> call = Partial(demo).setReactor(faux)
>>> res = None
>>> deferred = call()
>>> d = deferred.addCallback(get_result)
>>> call.attempt_count
0
>>> time_flies(.125) >= 1
True
>>> call.attempt_count
0
>>> res # None
>>> time_flies(2) >= 2 # for a total of at least 3
True
>>> res
2
>>> t = transaction.begin()
>>> demo.count
2

更改