Document how to test plugins
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
- #2023 @tanviranindo による — マージされずにクローズ
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 52/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
既存の plugin-development/formatters ドキュメントと、issue に記載されている flake8 2.x から 3.x への移行コンテキストから始めます。有効な関数またはクラスのエントリポイント、1つのチェックに対して文字列をテストする方法、サブプロセスを使わずに標準チェックを実行する方法を網羅した実例をドキュメント化します。完了の条件は、その例が3つすべての質問に答えており、ドキュメント PR に適していることです。
索引モデルが issue の本文から書いたものです。
説明
In GitLab by @stephenfin on May 23, 2019, 03:07
I'm trying to migrate hacking from flake8 2.x to 3.x and finding it extremely difficult to do so because the internals of the flake8 have changed so drastically between these versions (plus hacking does some stuff that's too smart for its own good, IMO). The flake8 documentation provides some introductory text on plugins, including a guide on writing a "formatting type" plugin (though it doesn't explain what a formatting plugin actually is...) but there's nothing about testing this or even what type of class or function the entrypoints should point to. The biggest issue I have is that I want to run flake8 in it entirety (i.e. with both the standard checks and my plugin enabled) on a test string, but there doesn't appear to be anyway to do this.
Would it be possible to get a small worked example that demonstrates:
- What the entrypoint should look like (i.e. if it can be a Python function, a class, or both)
- How you can test a string against only a single check
- How you can test a string against flake8's standard checks (without having to resort to a subprocess call)
I'll happily submit a documentation PR based on this example, if it would be helpful.
- 主要言語
- Python
- スター
- 3.8k
- フォーク
- 363
- 平均マージ
- 3時間 59分
- マージ済み PR（30日）
- 11
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PyCQA/flake8 のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
PyCQA/flake8#2062 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
Max Line Length in style guide ignored with python 3.14 when checking multiple files再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
PyCQA/flake8#2011 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
PyCQA/flake8#1793 · コメント 9 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
PyCQA/flake8#1774 · コメント 13 件 ·
メンテナーはふだん 1 日以内に返信
-
option_manager.add_option ignores action when reading from config再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
PyCQA/flake8#1770 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug Size: XS
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
oposs/repo-infra#93 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
Graphify-Labs/graphify#4546 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
521xueweihan/HelloGitHub#4025 ·