jsocol/django-ratelimit

Documentation for custom get_usage / is_rate_limited needed.

Open

#309 ouverte le 13 nov. 2023

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)Python (904 stars) (180 forks)batch import
help wanted

Description

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?

Guide contributeur

Stack technique
python
Domaine
backendsecurity
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
needs maintainer response
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
djangodjango ratelimitrate limiting basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.