Contents

Overview

docs
tests
package

Queue system with key-based throttling implemented over Redis.

• Free software: BSD 2-Clause License

Installation

pip install redis-throttled-queue

You can also install the in-development version with:

pip install https://github.com/ionelmc/python-redis-throttled-queue/archive/main.zip

Documentation

https://python-redis-throttled-queue.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Installation

At the command line:

pip install redis-throttled-queue

Usage

To use redis-throttled-queue in a project:

import redis_throttled_queue

Reference

redis_throttled_queue

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

• Your operating system name and version.

• Any details about your local setup that might be helpful in troubleshooting.

• Detailed steps to reproduce the bug.

Documentation improvements

redis-throttled-queue could always use more documentation, whether as part of the official redis-throttled-queue docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/ionelmc/python-redis-throttled-queue/issues.

If you are proposing a feature:

• Explain in detail how it would work.

• Keep the scope as narrow as possible, to make it easier to implement.

• Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up python-redis-throttled-queue for local development:

1. Fork python-redis-throttled-queue (look for the “Fork” button).

2. Clone your fork locally:

   git clone git@github.com:YOURGITHUBNAME/python-redis-throttled-queue.git
   

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

4. When you’re done making changes run all the checks and docs builder with tox one command:

   tox
   

5. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature
   

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run tox).

2. Update documentation when there’s new API, functionality etc.

3. Add a note to CHANGELOG.rst about the changes.

4. Add yourself to AUTHORS.rst.

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel:

tox -p auto

Authors

• Ionel Cristian Mărieș - http://blog.ionelmc.ro

1 Changelog =========

1.0.0 (2022-11-15)

• Switched from eval scripts to redis functions. Minimum Redis server version becomes 7.0.

• Replaced unpack calls with direct indexing in the Lua functions.

• These changes improve the push operation by at least 6%.

0.6.0 (2022-07-06)

• Simplified pop() code to avoid the expensive scan operations. The '...:names key is now a sorted set and will be used as a template for the usage keys ('...:usage:<window>').

0.5.0 (2022-06-28)

• Added support in a AsyncThrottledQueue class that only differs a bit from the regular ThrottledQueue:

  • __len__ is removed, instead a awaitable size() method is available.

  • __init__ doesn’t validate version anymore, instead you can await on validate_version().

  • push(), pull() and cleanup() are awaitable.

• Added a validate_version argument to ThrottledQueue (default: True).

0.4.4 (2022-05-09)

• Fixed missing usage key expiration when some queues are empty.

0.4.3 (2022-04-09)

• Fixed buggy counts when duplicate values are pushed. For now the highest priority will be used when two identical values would be pushed.

0.4.2 (2022-04-02)

• Refactored some duplicated code in the pop script.

0.4.1 (2022-03-31)

• Fixed bogus error in cleanup() when db is completely empty.

0.4.0 (2022-03-31)

• Added last_activity and idle_seconds attributes.

• Added a cleanup() method.

0.3.1 (2022-03-31)

• Renamed attributes (should be safe to mess with):

  • _limit becomes limit.

  • _resolution becomes resolution.

0.3.0 (2022-03-31)

• Allowed pop(window) using any window value (str/bytes/int recommended tho).

0.2.0 (2022-03-31)

• Fixed __len__ (was returning a string).

0.1.0 (2022-03-30)

• First release on PyPI.

Indices and tables

• Index

• Module Index

• Search Page