tubes._siphon._SiphonDrain(_SiphonPiece) class documentation

Part of tubes._siphon (View In Hierarchy)

Implements interfaces: tubes.itube.IDrain

Implementation of IDrain for _Siphon.

Method __repr__ Nice string representation.
Method inputType Relay the tube's declared inputType.
Method flowingFrom This siphon will now have 'receive' called on it by the given fount.
Method receive An item was received. Pass it on to the tube for processing.
Method flowStopped No summary

Inherited from _SiphonPiece:

Method __init__ Undocumented
Method _tube Expose the siphon's _tube directly since many things will want to manipulate it.
def __repr__(self):

Nice string representation.

@property
def inputType(self):
from tubes.itube.IDrain

Relay the tube's declared inputType.

Returnssee IDrain.inputType
def flowingFrom(self, fount):
from tubes.itube.IDrain

This siphon will now have 'receive' called on it by the given fount.

Parametersfountsee IDrain.flowingFrom
Returnssee IDrain.flowingFrom
def receive(self, item):
from tubes.itube.IDrain

An item was received. Pass it on to the tube for processing.

Parametersiteman item to deliver to the tube.
def flowStopped(self, reason):
from tubes.itube.IDrain

This siphon's fount has communicated the end of the flow to this siphon. This siphon should finish yielding its current buffer, then yield the result of it's _tube's stopped method, then communicate the end of flow to its downstream drain.

Parametersreasonthe reason why our fount stopped the flow.
API Documentation for tubes, generated by pydoctor at 2016-01-18 07:46:47.