プルリクエストよりもPythonコードスタイルを自動的に確認するGitHubアプリ


pycodestyleまたはflake8をリナーとして選択することができます。ボットは両方の構成を読み取ることができます。[flake8]および[pycodestyle]セクションのsetup.cfg読み取ることができます。以下のConfigurationセクションをご覧ください。統合が機能するためには、構成ファイルは必要ありません。ただし、プロジェクトのルートに.pep8speaks.ymlファイルを追加することにより、さらに構成できます。これが例です:
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "注:
.pep8speaks.ymlはこれらの値をオーバーライドします。baseブランチ(既存のもの)の.pep8speaks.ymlを探します。ファイルが見つからない場合は、 headブランチ(着信の変更)を検索します。scanner.linterの値をpycodestyleまたはflake8に設定するignoreやmax-line-lengthなど)の場合、PEP8Speaksは次の順序で構成を見て、優先順位を付けます。pycodestyle:またはflake8: .pep8speaks.ymlのセクション。scanner.linter値に依存します。[pycodestyle]または[flake8]プロジェクトのルートにあるsetup.cfgファイルの[Flake8]セクション。scanner.linterに依存しません。したがって、 [flake8] setup.cfgのセクションもPycodesyleで機能します。| 組織 | 説明 | |
|---|---|---|
| パンダ | Python用の強力なデータ操作ツール | |
| アドビ | Adobeのオープンソース | |
| opensuse | Linux分布 | |
| Pytorch Lightning | ML研究者向けの軽量のPytorchラッパー。 | |
| NetworkX | グラフ理論と複雑なネットワークのためのPythonライブラリ | |
| statsmodels | Pythonの統計モデリングと計量経済学 | |
| XARRAY(Pydata) | pythonのndラベル付き配列とデータセット(データ用のpython) | |
![]() | サンピー | 太陽物理学のためのPython |
| アストロピー | Pythonの天文学 | |
| Scikit Learn Contrib | Scikit-Learn互換プロジェクト | |
| Scikit画像 | Pythonでの画像処理 | |
| スパイダーIDE | 科学的なPython開発環境 | |
![]() | 触媒 | 深い学習研究開発のためのPytorchフレームワーク |
組織とユーザーの完全なリストを参照してください。
@pep8speaks suggest diff 。例@pep8speaks pep8ify in the prで、PRの著者のブランチに対してautopep8が提案した変更を伴うプル要求を作成します。 autopep8 、 pycodestyleによって報告されたほとんどのエラーを修正します。[skip pep8] 、PEP8Speaksがプルリクエストにコメントすることを禁止するために、[PEP8]を任意の任意の場所に追加します。このアプリは、公開されているリポジトリでのみ機能します。したがって、フォークの展開やプライベートリポジトリにアプリを使用する場合は、ここに指示があります。
pep8として知られていた)でローカルにエラーを確認します。アプリの更新は、GitHubリリース機能を使用して発表されます。コミュニティが大きくなるにつれて、多くの大きな変更が行われます。 Watch - > [ページの上にReleases onlyをクリックして、新しい構成または機能の更新について通知されます。
通常、マスターブランチは、リポジトリにプルリクエストがマージされるとすぐに展開されます。ただし、毎週金曜日にリリースし、最新のコードが展開されていることを確認します。最新バージョンを使用するために何もする必要はありません。 PEP 8 Speaksのフォークを使用する場合は、リリーススペースをチェックしてください。
ゴールドスポンサーになって、ReadmeとWebサイトのサイトへのリンクでロゴと名前を入手してください。
サマグラガバナンス | ![]() サマグラックス |
ゴールドスポンサーになって、ReadmeとWebサイトのサイトへのリンクでロゴと名前を入手してください。
Python Software Foundation | ウェブレート |
シルバースポンサーになって、ReadmeとWebサイトのサイトへのリンクでロゴと名前を入手してください。
ccextractor | Sudhanshu Mishra |
その開発に貢献することで、プロジェクトをサポートできます。新機能や改善に関する提案がある場合は、問題を作成してください。プルリクエストは大歓迎です!プロジェクトがどのように機能し、どのように変更を加えることができるかを理解するために、貢献ドキュメントを読んでください。
このプロジェクトは、サーバーでホストする必要があり、そのため、財政的支援も必要です。
PEP 8 Speaksに資金を提供するためのケースを読んでください。
このプロジェクトを使用していて、気に入ったら、お知らせください。ありがとう!
❤❤️
このプロジェクトは、元のPEP 8のすべてのルールを支持するものではないため、Pycodestyleのカスタマイズを信じています。
。