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
|
========
queuelib
========
.. image:: https://img.shields.io/pypi/v/queuelib.svg
:target: https://pypi.python.org/pypi/queuelib
.. image:: https://img.shields.io/pypi/pyversions/queuelib.svg
:target: https://pypi.python.org/pypi/queuelib
.. image:: https://github.com/scrapy/queuelib/actions/workflows/tests-ubuntu.yml/badge.svg
:target: https://github.com/scrapy/queuelib/actions/workflows/tests-ubuntu.yml
.. image:: https://img.shields.io/codecov/c/github/scrapy/queuelib/master.svg
:target: http://codecov.io/github/scrapy/queuelib?branch=master
:alt: Coverage report
Queuelib is a Python library that implements object collections which are stored
in memory or persisted to disk, provide a simple API, and run fast.
Queuelib provides collections for queues_ (FIFO), stacks_ (LIFO), queues
sorted by priority and queues that are emptied in a round-robin_ fashion.
.. note:: Queuelib collections are not thread-safe.
Queuelib supports Python 3.9+ and has no dependencies.
.. _queues: https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)
.. _round-robin: https://en.wikipedia.org/wiki/Round-robin_scheduling
.. _stacks: https://en.wikipedia.org/wiki/Stack_(abstract_data_type)
Installation
============
You can install Queuelib either via the Python Package Index (PyPI) or from
source.
To install using pip::
$ pip install queuelib
To install using easy_install::
$ easy_install queuelib
If you have downloaded a source tarball you can install it by running the
following (as root)::
# python setup.py install
FIFO/LIFO disk queues
=====================
Queuelib provides FIFO and LIFO queue implementations.
Here is an example usage of the FIFO queue::
>>> from queuelib import FifoDiskQueue
>>> q = FifoDiskQueue("queuefile")
>>> q.push(b'a')
>>> q.push(b'b')
>>> q.push(b'c')
>>> q.pop()
b'a'
>>> q.close()
>>> q = FifoDiskQueue("queuefile")
>>> q.pop()
b'b'
>>> q.pop()
b'c'
>>> q.pop()
>>>
The LIFO queue is identical (API-wise), but importing ``LifoDiskQueue``
instead.
PriorityQueue
=============
A discrete-priority queue implemented by combining multiple FIFO/LIFO queues
(one per priority).
First, select the type of queue to be used per priority (FIFO or LIFO)::
>>> from queuelib import FifoDiskQueue
>>> qfactory = lambda priority: FifoDiskQueue('queue-dir-%s' % priority)
Then instantiate the Priority Queue with it::
>>> from queuelib import PriorityQueue
>>> pq = PriorityQueue(qfactory)
And use it::
>>> pq.push(b'a', 3)
>>> pq.push(b'b', 1)
>>> pq.push(b'c', 2)
>>> pq.push(b'd', 2)
>>> pq.pop()
b'b'
>>> pq.pop()
b'c'
>>> pq.pop()
b'd'
>>> pq.pop()
b'a'
RoundRobinQueue
===============
Has nearly the same interface and implementation as a Priority Queue except
that each element must be pushed with a (mandatory) key. Popping from the
queue cycles through the keys "round robin".
Instantiate the Round Robin Queue similarly to the Priority Queue::
>>> from queuelib import RoundRobinQueue
>>> rr = RoundRobinQueue(qfactory)
And use it::
>>> rr.push(b'a', '1')
>>> rr.push(b'b', '1')
>>> rr.push(b'c', '2')
>>> rr.push(b'd', '2')
>>> rr.pop()
b'a'
>>> rr.pop()
b'c'
>>> rr.pop()
b'b'
>>> rr.pop()
b'd'
Mailing list
============
Use the `scrapy-users`_ mailing list for questions about Queuelib.
Bug tracker
===========
If you have any suggestions, bug reports or annoyances please report them to
our issue tracker at: http://github.com/scrapy/queuelib/issues/
Contributing
============
Development of Queuelib happens at GitHub: http://github.com/scrapy/queuelib
You are highly encouraged to participate in the development. If you don't like
GitHub (for some reason) you're welcome to send regular patches.
All changes require tests to be merged.
Tests
=====
Tests are located in `queuelib/tests` directory. They can be run using
`nosetests`_ with the following command::
nosetests
The output should be something like the following::
$ nosetests
.............................................................................
----------------------------------------------------------------------
Ran 77 tests in 0.145s
OK
License
=======
This software is licensed under the BSD License. See the LICENSE file in the
top distribution directory for the full license text.
Versioning
==========
This software follows `Semantic Versioning`_
.. _Scrapy framework: http://scrapy.org
.. _scrapy-users: http://groups.google.com/group/scrapy-users
.. _Semantic Versioning: http://semver.org/
.. _nosetests: https://nose.readthedocs.org/en/latest/
|
