BullMQ for Python
Project description
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.
-
Workers
-
Job events.
-
Job progress.
-
Job retries.
-
Job backoff.
-
Getters.
Installation
pip install bullmq
Usage
Basic Example
from bullmq import Queue
queue = Queue('my-queue')
job = await queue.add('my-job', {'foo': 'bar'})
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.
Release history Release notifications | RSS feed
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-2.19.1.tar.gz.
File metadata
- Download URL: bullmq-2.19.1.tar.gz
- Upload date:
- Size: 782.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a65ad735345ab309e730d2495e2ffdfd470927836fb7bee235f43185a91f767c
|
|
| MD5 |
daf5b6887331342054289920b3cc53aa
|
|
| BLAKE2b-256 |
99f5aed0277d84416d0320b5c80391c6f70bba07c9c46461b6f07e9d97a5d3a6
|
File details
Details for the file bullmq-2.19.1-py3-none-any.whl.
File metadata
- Download URL: bullmq-2.19.1-py3-none-any.whl
- Upload date:
- Size: 897.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ddb857ee198b3af926dafb8a20b6191c5e348eaf6d08ed3645246fa4dc20cae3
|
|
| MD5 |
01aa2c169c2f2e9f9fdf59a07851f69c
|
|
| BLAKE2b-256 |
e9924e8e03c6ce5b2bc5c0504299eaf1c932a2588b45586f5494a3051b83f3a1
|
