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.
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).
pip install bullmqfrom bullmq import Queue
queue = Queue('my-queue')
job = await queue.add('my-job', {'foo': 'bar'})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})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
})The documentation is available at https://docs.bullmq.io
MIT
Copyright (c) 2018-2023, Taskforce.sh Inc. and other contributors.