astral-sh/ruff

Make logger object name patterns configurable

Open

#12,613 opened on 2024年8月1日

GitHub で見る
 (6 comments) (3 reactions) (0 assignees)Rust (2,088 forks)batch import
help wantedtype-inference

Repository metrics

Stars
 (47,527 stars)
PR merge metrics
 (平均マージ 5d 4h) (30d で 463 merged PRs)

説明

Currently, Ruff uses some hard-coded name "patterns" to determine whether a module-local object might be a logger (for the purposes of e.g. flake8-logging-format G rules).

https://github.com/astral-sh/ruff/blob/fc16d8d04d86aa94a8aac14bbb87089b64d443a1/crates/ruff_python_semantic/src/analyze/logging.rs#L60-L74

We've found that we have some loggers called _LOG which aren't matched, and I was disappointed to find that these aren't configurable. Maybe this should be a setting list of regular expressions or globs or something like that?

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

調査方針
`crates/ruff python semantic/src/analyze/logging.rs` の現在のハードコードされたパターン（60-74行目）を調べます。Ruff で他の設定がどのように定義されているか（例：`crates/ruff workspace/src/settings.rs` 内）を確認します。新しい設定可能なオプション（例：正規表現パターンのリスト）を設計し、ロガー検出ロジックを更新します。既存のテストスイートにテストを追加して、新しい設定が機能することを確認します。必要に応じて、Ruff のドキュメントを更新します。
技術スタック
pythonrust
領域
tooling
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic Rust knowledgeUnderstanding of Ruff's configurationFamiliarity with flake8 logging format
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50