jsocol/django-ratelimit

Documentation for custom get_usage / is_rate_limited needed.

Open

#309 opened on 2023年11月13日

GitHub で見る
 (1 comment) (1 reaction) (0 assignees)Python (904 stars) (180 forks)batch import
help wanted

説明

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?

コントリビューターガイド

技術スタック
python
領域
backendsecurity
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
needs maintainer response
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
djangodjango ratelimitrate limiting basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.
Documentation for custom get_usage / is_rate_limited needed. · jsocol/django-ratelimit#309 | Good First Issue