t.f.wrap : module documentation

Part of twisted.flow View Source


This module provides the wrap() function in the flow module and the private classes used for its implementation.
Function wrap Wraps various objects for use within a flow
Class _String Wrapper for a string object; don't create directly use flow.wrap
Class _List Wrapper for lists and tuple objects; don't create directly
Class _DeferredInstruction Undocumented
Class _Iterable Wrapper for iterable objects, pass in a next() function
Class _Deferred Wraps a Deferred object into a stage; create with flow.wrap
def wrap(obj, *trap): (source)

Wraps various objects for use within a flow

The following example illustrates many different ways in which regular objects can be wrapped by the flow module to behave in a cooperative manner.

For example:
   # required imports
   from __future__ import generators
   from twisted.flow import flow
   from twisted.internet import reactor, defer

   # save this function, it is used everwhere
   def printFlow(source):
       def printer(source):
           source = flow.wrap(source)
           while True:
               yield source
               print source.next()
       d = flow.Deferred(printer(source))
       d.addCallback(lambda _: reactor.stop())

   source = "string"

   source = ["one",flow.Cooperate(1),"two"]

   def source():
       yield "aeye"
       yield flow.Cooperate()
       yield "capin"

   source = Deferred()
   reactor.callLater(1, lambda: source.callback("howdy"))
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.