TaskIQ-Redis
Taskiq-redis is a plugin for taskiq that adds a new broker and result backend based on redis.
Installation
To use this project you must have installed core taskiq library:
pip install taskiq
This project can be installed using pip:
pip install taskiq-redis
Usage
Let's see the example with the redis broker and redis async result:
# broker.py
import asyncio
from taskiq_redis import ListQueueBroker, RedisAsyncResultBackend
redis_async_result = RedisAsyncResultBackend(
redis_url="redis://localhost:6379",
)
# Or you can use PubSubBroker if you need broadcasting
broker = ListQueueBroker(
url="redis://localhost:6379",
result_backend=redis_async_result,
)
@broker.task
async def best_task_ever() -> None:
"""Solve all problems in the world."""
await asyncio.sleep(5.5)
print("All problems are solved!")
async def main():
task = await best_task_ever.kiq()
print(await task.wait_result())
if __name__ == "__main__":
asyncio.run(main())
Launch the workers:
taskiq worker broker:broker
Then run the main code:
python3 broker.py
PubSubBroker and ListQueueBroker configuration
We have two brokers with similar interfaces, but with different logic. The PubSubBroker uses redis' pubsub mechanism and is very powerful, but it executes every task on all workers, because PUBSUB broadcasts message to all subscribers.
If you want your messages to be processed only once, please use ListQueueBroker. It uses redis' LPUSH and BRPOP commands to deal with messages.
Brokers parameters:
url- url to redis.task_id_generator- custom task_id genertaor.result_backend- custom result backend.queue_name- name of the pub/sub channel in redis.max_connection_pool_size- maximum number of connections in pool.
RedisAsyncResultBackend configuration
RedisAsyncResultBackend parameters:
redis_url- url to redis.keep_results- flag to not remove results from Redis after reading.result_ex_time- expire time in seconds (by default - not specified)result_px_time- expire time in milliseconds (by default - not specified)
IMPORTANT: It is highly recommended to use expire time in RedisAsyncResultBackend If you want to add expiration, either
result_ex_timeorresult_px_timemust be set.# First variant redis_async_result = RedisAsyncResultBackend( redis_url="redis://localhost:6379", result_ex_time=1000, ) # Second variant redis_async_result = RedisAsyncResultBackend( redis_url="redis://localhost:6379", result_px_time=1000000, )
Metadata
Release files for taskiq-redis 0.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| taskiq_redis-0.5.4.tar.gz | 7.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| taskiq_redis-0.5.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.2 kB
Release files / taskiq_redis-0.5.4.tar.gz
| Download URL | taskiq_redis-0.5.4.tar.gz |
|---|---|
| Size | 7.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
26d9f661b35d0fe623bc1420cd645ce0ef4a64fbee5a5d252d38a2a4d340a36d
|
|
BLAKE2b-256 checksum How to use checksums |
4b7f17defd9fc1b245d54fdab5e2533872511cb7d809cc507cd566573feabaa1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.2.0-1016-azure
|
Release files / taskiq_redis-0.5.4-py3-none-any.whl
| Download URL | taskiq_redis-0.5.4-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ad0cce210d1906955e1142fd539b061d7fe884fccb481a5196713aba60f5332f
|
|
BLAKE2b-256 checksum How to use checksums |
51b677cae006f01541fd9ba682376479a85dae9c0ccb7ffe8bef6e071696526a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.2.0-1016-azure
|
Security for taskiq-redis 0.5.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
