django-ratelimit icon indicating copy to clipboard operation
django-ratelimit copied to clipboard

Alias function for is_ratelimited

Open TreyWW opened this issue 2 years ago • 2 comments

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 :)

TreyWW avatar Oct 30 '23 18:10 TreyWW

I'm definitely open to this if you want to open a PR!

jsocol avatar Dec 05 '23 19:12 jsocol

Amazing, thank you for replying @jsocol!

I'll try and make some code snippets and let you know how it goes, I'll create a PR if I think it works. Or would you like me to create a blank/draft PR so that somebody else could add this? I wasn't planning on adding it myself, was more of a suggestion, but i'm happy to attempt it

Thanks

TreyWW avatar Dec 05 '23 19:12 TreyWW