jsocol/django-ratelimit

Documentation for custom get_usage / is_rate_limited needed.

Open

#309 geöffnet am 13. Nov. 2023

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Python (904 Stars) (180 Forks)batch import
help wanted

Beschreibung

I am looking to do some conditional rate limiting , and I see the documentation about customizing get_usage and is_ratelimited. It' not clear how to use these methods after customization. Do you still call them using the decorator? Are there any examples?

Contributor Guide

Tech Stack
python
Domain
backendsecurity
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
needs maintainer response
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
djangodjango ratelimitrate limiting basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Review the source code in django ratelimit for the get usage and is rate limited methods, likely in the decorators module. Check existing documentation and any comments in the code. Provide clear examples of how to override these methods and use them with the decorator, including how to call them after customization. Consider adding a section to the README or a separate docs file.