BullMQ For Python
This is the official BullMQ Python library. It is a close port of the NodeJS version of the library. Python Queues are interoperable with NodeJS Queues, as both libraries use the same .lua scripts that power all the functionality.
Features
Currently, the library does not support all the features available in the NodeJS version. The following have been ported so far:
-
Add jobs to queues.
- Regular jobs.
- Delayed jobs.
- Job deduplication.
- Job priority.
- Repeatable (via
JobScheduler).
-
Workers
-
Job events (via
QueueEventsandQueueEventsProducer). -
Job progress.
-
Job retries.
-
Job backoff.
-
Getters.
-
Lock Manager (batched lock renewal).
-
Per-job cancellation (cooperative
AbortController).
Installation
pip install bullmq
Usage
Basic Example
from bullmq import Queue
queue = Queue('my-queue')
job = await queue.add('my-job', {'foo': 'bar'})
Job Priority
Prioritize jobs so higher priority jobs are processed first. Lower number = higher
priority. 1 is the highest priority and 2_097_152 is the lowest. A priority of
0 (the default) means "no priority" and jobs are processed in FIFO order.
from bullmq import Queue
queue = Queue('my-queue')
# Higher priority job (will be processed first)
await queue.add('paint', {'color': 'red'}, {'priority': 1})
# Lower priority job
await queue.add('paint', {'color': 'blue'}, {'priority': 10})
Job Deduplication
Prevent duplicate jobs from being added to the queue:
from bullmq import Queue
queue = Queue('my-queue')
# Simple mode - deduplicates until job completes or fails
job = await queue.add('paint', {'color': 'white'}, {
'deduplication': {
'id': 'custom-dedup-id'
}
})
# Throttle mode - deduplicates for a specific time window (in milliseconds)
job = await queue.add('paint', {'color': 'white'}, {
'deduplication': {
'id': 'custom-dedup-id',
'ttl': 5000 # 5 seconds
}
})
# Debounce mode - replaces pending job with latest data
job = await queue.add('paint', {'color': 'white'}, {
'deduplication': {
'id': 'custom-dedup-id',
'ttl': 5000,
'extend': True, # Extend TTL on each duplicate attempt
'replace': True # Replace job data with latest
},
'delay': 5000 # Must be delayed for replace to work
})
Documentation
The documentation is available at https://docs.bullmq.io
License
MIT
Copyright
Copyright (c) 2018-2023, Taskforce.sh Inc. and other contributors.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bullmq-3.2.1.tar.gz.
File metadata
- Download URL: bullmq-3.2.1.tar.gz
- Upload date:
- Size: 885.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6087a7028751abad7558f8cfdc0cac6efb23eb6037370f8213d1ae21bc3fcfe8
|
|
| MD5 |
2de9d7b6a41f0f8abb2dc4a8f28f22f3
|
|
| BLAKE2b-256 |
9c3c5b72532583d1b691b6ad3ae0da0ad158436d85f236d0cf9dc818b76e97f7
|
File details
Details for the file bullmq-3.2.1-py3-none-any.whl.
File metadata
- Download URL: bullmq-3.2.1-py3-none-any.whl
- Upload date:
- Size: 1.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28f4e16763f770ad9559cac2526fce3280cdbd8e6fc73f40f478d5728549e2f2
|
|
| MD5 |
81d4753b64ac1e0fb072272455d2af76
|
|
| BLAKE2b-256 |
940b94b5dac2468e7f3db70de7ca3bb15fe76d3af87856828ce7daebd5beaf3e
|
