jsocol/django-ratelimit

Alias function for is_ratelimited

Open

#308 opened on Oct 30, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (904 stars) (180 forks)batch import
help wanted

Description

Hey,

Is_ratelimited is a great function, but the name is quite missleading for incrementing. You'd expect it only to be a boolean, but yet it can also increment. That's great, but I feel we should have also a new function like increment_ratelimit or some sort of increment function which is just a function rather than decorator, that allows you to increment whenever.

At the moment I want to only increment the ratelimit when the user does an unsuccessful login attempt. So i have

is_ratelimited(
                request, group="login_incorrect", key="ip", rate="5/5m", increment=True
)

But instead of that, i'd quite like something like:

increment_ratelimit(request, group="login_incorrect")

Instead i've created my own function that just does the same thing, but it'd be nice to see this in the official version.

Or I may have just missed it 🤷‍♂️

Happy to hear opinions, let me know if i'm just being blind :)

Contributor guide

Tech stack
python
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonDjango basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests a new function `increment ratelimit` that wraps the existing `is ratelimited` with `increment=True` for convenience. Look at the source code (likely in `ratelimit/decorators.py` or `ratelimit/core.py`) to see how `is ratelimited` is implemented. Create a new function that calls `is ratelimited` with `increment=True` and returns the result. Ensure it follows the existing API patterns and is properly documented. No pull requests or comments indicate blockers.