Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cpython/Lib/asyncio/queues.py at v3.5.3 · python/cpython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
python
/
cpython
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
35.4k
Star
77.2k
Code
Issues
5k+
Pull requests
2.6k
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
v3.5.3
Breadcrumbs
cpython
/
Lib
/
asyncio
/
queues.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
253 lines (197 loc) · 7.64 KB
v3.5.3
Breadcrumbs
cpython
/
Lib
/
asyncio
/
queues.py
Copy path
Top
File metadata and controls
Code
Blame
253 lines (197 loc) · 7.64 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
"""Queues"""
__all__
=
[
'Queue'
,
'PriorityQueue'
,
'LifoQueue'
,
'QueueFull'
,
'QueueEmpty'
]
import
collections
import
heapq
from
.
import
compat
from
.
import
events
from
.
import
locks
from
.
coroutines
import
coroutine
class
QueueEmpty
(
Exception
):
"""Exception raised when Queue.get_nowait() is called on a Queue object
which is empty.
"""
pass
class
QueueFull
(
Exception
):
"""Exception raised when the Queue.put_nowait() method is called on a Queue
object which is full.
"""
pass
class
Queue
:
"""A queue, useful for coordinating producer and consumer coroutines.
If maxsize is less than or equal to zero, the queue size is infinite. If it
is an integer greater than 0, then "yield from put()" will block when the
queue reaches maxsize, until an item is removed by get().
Unlike the standard library Queue, you can reliably know this Queue's size
with qsize(), since your single-threaded asyncio application won't be
interrupted between calling qsize() and doing an operation on the Queue.
"""
def
__init__
(
self
,
maxsize
=
0
,
*
,
loop
=
None
):
if
loop
is
None
:
self
.
_loop
=
events
.
get_event_loop
()
else
:
self
.
_loop
=
loop
self
.
_maxsize
=
maxsize
# Futures.
self
.
_getters
=
collections
.
deque
()
# Futures.
self
.
_putters
=
collections
.
deque
()
self
.
_unfinished_tasks
=
0
self
.
_finished
=
locks
.
Event
(
loop
=
self
.
_loop
)
self
.
_finished
.
set
()
self
.
_init
(
maxsize
)
# These three are overridable in subclasses.
def
_init
(
self
,
maxsize
):
self
.
_queue
=
collections
.
deque
()
def
_get
(
self
):
return
self
.
_queue
.
popleft
()
def
_put
(
self
,
item
):
self
.
_queue
.
append
(
item
)
# End of the overridable methods.
def
_wakeup_next
(
self
,
waiters
):
# Wake up the next waiter (if any) that isn't cancelled.
while
waiters
:
waiter
=
waiters
.
popleft
()
if
not
waiter
.
done
():
waiter
.
set_result
(
None
)
break
def
__repr__
(
self
):
return
'<{} at {:#x} {}>'
.
format
(
type
(
self
).
__name__
,
id
(
self
),
self
.
_format
())
def
__str__
(
self
):
return
'<{} {}>'
.
format
(
type
(
self
).
__name__
,
self
.
_format
())
def
_format
(
self
):
result
=
'maxsize={!r}'
.
format
(
self
.
_maxsize
)
if
getattr
(
self
,
'_queue'
,
None
):
result
+=
' _queue={!r}'
.
format
(
list
(
self
.
_queue
))
if
self
.
_getters
:
result
+=
' _getters[{}]'
.
format
(
len
(
self
.
_getters
))
if
self
.
_putters
:
result
+=
' _putters[{}]'
.
format
(
len
(
self
.
_putters
))
if
self
.
_unfinished_tasks
:
result
+=
' tasks={}'
.
format
(
self
.
_unfinished_tasks
)
return
result
def
qsize
(
self
):
"""Number of items in the queue."""
return
len
(
self
.
_queue
)
@
property
def
maxsize
(
self
):
"""Number of items allowed in the queue."""
return
self
.
_maxsize
def
empty
(
self
):
"""Return True if the queue is empty, False otherwise."""
return
not
self
.
_queue
def
full
(
self
):
"""Return True if there are maxsize items in the queue.
Note: if the Queue was initialized with maxsize=0 (the default),
then full() is never True.
"""
if
self
.
_maxsize
<=
0
:
return
False
else
:
return
self
.
qsize
()
>=
self
.
_maxsize
@
coroutine
def
put
(
self
,
item
):
"""Put an item into the queue.
Put an item into the queue. If the queue is full, wait until a free
slot is available before adding item.
This method is a coroutine.
"""
while
self
.
full
():
putter
=
self
.
_loop
.
create_future
()
self
.
_putters
.
append
(
putter
)
try
:
yield
from
putter
except
:
putter
.
cancel
()
# Just in case putter is not done yet.
if
not
self
.
full
()
and
not
putter
.
cancelled
():
# We were woken up by get_nowait(), but can't take
# the call. Wake up the next in line.
self
.
_wakeup_next
(
self
.
_putters
)
raise
return
self
.
put_nowait
(
item
)
def
put_nowait
(
self
,
item
):
"""Put an item into the queue without blocking.
If no free slot is immediately available, raise QueueFull.
"""
if
self
.
full
():
raise
QueueFull
self
.
_put
(
item
)
self
.
_unfinished_tasks
+=
1
self
.
_finished
.
clear
()
self
.
_wakeup_next
(
self
.
_getters
)
@
coroutine
def
get
(
self
):
"""Remove and return an item from the queue.
If queue is empty, wait until an item is available.
This method is a coroutine.
"""
while
self
.
empty
():
getter
=
self
.
_loop
.
create_future
()
self
.
_getters
.
append
(
getter
)
try
:
yield
from
getter
except
:
getter
.
cancel
()
# Just in case getter is not done yet.
if
not
self
.
empty
()
and
not
getter
.
cancelled
():
# We were woken up by put_nowait(), but can't take
# the call. Wake up the next in line.
self
.
_wakeup_next
(
self
.
_getters
)
raise
return
self
.
get_nowait
()
def
get_nowait
(
self
):
"""Remove and return an item from the queue.
Return an item if one is immediately available, else raise QueueEmpty.
"""
if
self
.
empty
():
raise
QueueEmpty
item
=
self
.
_get
()
self
.
_wakeup_next
(
self
.
_putters
)
return
item
def
task_done
(
self
):
"""Indicate that a formerly enqueued task is complete.
Used by queue consumers. For each get() used to fetch a task,
a subsequent call to task_done() tells the queue that the processing
on the task is complete.
If a join() is currently blocking, it will resume when all items have
been processed (meaning that a task_done() call was received for every
item that had been put() into the queue).
Raises ValueError if called more times than there were items placed in
the queue.
"""
if
self
.
_unfinished_tasks
<=
0
:
raise
ValueError
(
'task_done() called too many times'
)
self
.
_unfinished_tasks
-=
1
if
self
.
_unfinished_tasks
==
0
:
self
.
_finished
.
set
()
@
coroutine
def
join
(
self
):
"""Block until all items in the queue have been gotten and processed.
The count of unfinished tasks goes up whenever an item is added to the
queue. The count goes down whenever a consumer calls task_done() to
indicate that the item was retrieved and all work on it is complete.
When the count of unfinished tasks drops to zero, join() unblocks.
"""
if
self
.
_unfinished_tasks
>
0
:
yield
from
self
.
_finished
.
wait
()
class
PriorityQueue
(
Queue
):
"""A subclass of Queue; retrieves entries in priority order (lowest first).
Entries are typically tuples of the form: (priority number, data).
"""
def
_init
(
self
,
maxsize
):
self
.
_queue
=
[]
def
_put
(
self
,
item
,
heappush
=
heapq
.
heappush
):
heappush
(
self
.
_queue
,
item
)
def
_get
(
self
,
heappop
=
heapq
.
heappop
):
return
heappop
(
self
.
_queue
)
class
LifoQueue
(
Queue
):
"""A subclass of Queue that retrieves most recently added entries first."""
def
_init
(
self
,
maxsize
):
self
.
_queue
=
[]
def
_put
(
self
,
item
):
self
.
_queue
.
append
(
item
)
def
_get
(
self
):
return
self
.
_queue
.
pop
()
if
not
compat
.
PY35
:
JoinableQueue
=
Queue
"""Deprecated alias for Queue."""
__all__
.
append
(
'JoinableQueue'
)
You can’t perform that action at this time.