1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
"""Contains a queue based channel implementation"""
from Queue import (
Queue,
Empty,
Full
)
#{ Classes
class Channel(object):
"""A channel is similar to a file like object. It has a write end as well as one or
more read ends. If Data is in the channel, it can be read, if not the read operation
will block until data becomes available.
If the channel is closed, any read operation will result in an exception
This base class is not instantiated directly, but instead serves as constructor
for RWChannel pairs.
Create a new channel """
__slots__ = tuple()
def __new__(cls, *args):
if cls is Channel:
max_items = 0
if len(args) == 1:
max_items = args[0]
if len(args) > 1:
raise ValueError("Specify not more than the number of items the channel should take")
wc = WChannel(max_items)
rc = RChannel(wc)
return wc, rc
# END constructor mode
return object.__new__(cls)
class WChannel(Channel):
"""The write end of a channel"""
__slots__ = ('_closed', '_queue')
def __init__(self, max_items=0):
"""initialize this instance, able to hold max_items at once
Write calls will block if the channel is full, until someone reads from it"""
self._closed = False
self._queue = Queue(max_items)
#{ Interface
def write(self, item, block=True, timeout=None):
"""Send an item into the channel, it can be read from the read end of the
channel accordingly
:param item: Item to send
:param block: If True, the call will block until there is free space in the
channel
:param timeout: timeout in seconds for blocking calls.
:raise IOError: when writing into closed file
:raise EOFError: when writing into a non-blocking full channel
:note: may block if the channel has a limited capacity"""
if self._closed:
raise IOError("Cannot write to a closed channel")
try:
self._queue.put(item, block, timeout)
except Full:
raise EOFError("Capacity of the channel was exeeded")
# END exception handling
def size(self):
""":return: approximate number of items that could be read from the read-ends
of this channel"""
return self._queue.qsize()
def close(self):
"""Close the channel. Multiple close calls on a closed channel are no
an error"""
self._closed = True
@property
def closed(self):
""":return: True if the channel was closed"""
return self._closed
#} END interface
class RChannel(Channel):
"""The read-end of a corresponding write channel"""
__slots__ = '_wc'
def __init__(self, wchannel):
"""Initialize this instance from its parent write channel"""
self._wc = wchannel
#{ Interface
def read(self, count=0, block=True, timeout=None):
"""read a list of items read from the channel. The list, as a sequence
of items, is similar to the string of characters returned when reading from
file like objects.
:param count: given amount of items to read. If < 1, all items will be read
:param block: if True, the call will block until an item is available
:param timeout: if positive and block is True, it will block only for the
given amount of seconds.
:return: single item in a list if count is 1, or a list of count items.
If the channel was empty and count was 1, an empty list will be returned.
If count was greater 1, a list with less than count items will be
returned.
If count was < 1, a list with all items that could be read will be
returned."""
# if the channel is closed for writing, we never block
if self._wc.closed:
block = False
out = list()
try:
if count == 1:
out.append(self._wc._queue.get(block, timeout))
elif count < 1:
while True:
out.append(self._wc._queue.get(block, timeout))
# END for each item
return out
else:
for i in xrange(count):
out.append(self._wc._queue.get(block, timeout))
# END for each item
# END handle count
except Empty:
pass
# END handle exceptions
return out
#} END interface
#} END classes
|
