Skip to main content

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.

Project details


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

bullmq-2.25.2.tar.gz (795.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bullmq-2.25.2-py3-none-any.whl (911.6 kB view details)

Uploaded Python 3

File details

Details for the file bullmq-2.25.2.tar.gz.

File metadata

  • Download URL: bullmq-2.25.2.tar.gz
  • Upload date:
  • Size: 795.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for bullmq-2.25.2.tar.gz
Algorithm Hash digest
SHA256 4ebcca5cd8d7b6fca33eea610c07899b6c19f74afb9f79388e08c966b1cd19cf
MD5 27c02f71d3bec02fd41a82eefa4c03ed
BLAKE2b-256 49936b9f311b96e858817e86b3328fca950b9ccd2677061b2283600926bc515c

See more details on using hashes here.

File details

Details for the file bullmq-2.25.2-py3-none-any.whl.

File metadata

  • Download URL: bullmq-2.25.2-py3-none-any.whl
  • Upload date:
  • Size: 911.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for bullmq-2.25.2-py3-none-any.whl
Algorithm Hash digest
SHA256 720f22786ab4492469781e7b260616376dd7088c3f8e0e4a12cc6c7791030aed
MD5 4e81fbe6948a8da31a8559d1b48fe95e
BLAKE2b-256 fcdaa8d8f951bbb6850abb0b0a3bf36d930486acbba392eecb3e889f41eab956

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page