一貫性のあるシンプルなPythonのコードスタイルを徹底し、複雑なコードパターンを検出する、厳格で独自の方針を持つflake8プラグイン。
PyCQA/pycodestyle
標準ライブラリだけで動作し、PEP 8のスタイル規約に沿っているかをチェックする単一ファイルのPythonチェッカー。
- スター
- 5,165
- フォーク
- 762
- 未解決の Issue
- 105
- 最終コミット
- 3 日前
これは何?
pycodestyleは、Pythonの公式スタイルガイドであるPEP 8で定められたスタイル規約の一部に照らして、Pythonソースコードをチェックします。1行に複数のimportがある、関数間の空行数が適切でない、余分な空白がある、行が長すぎるといった違反を検出し、それぞれにE401やE302などのコードとファイル内の位置を付けて報告します。
このプロジェクトは標準ライブラリだけを必要とする単一のPythonファイルとして配布されているため、プロジェクトにそのまま追加できます。エディターから各エラーの位置に移動できる形式で出力できるほか、該当するソース行と関連するPEP 8の説明も表示できます。統計モードでは、コードベース全体で各エラーが発生した回数を集計します。
このツールはプラグインアーキテクチャを採用しており、新しいチェックを追加できます。以前はpep8という名前でしたが、PEP 8のドキュメントそのものとの混同を避けるため、名称が変更されました。
主な機能
- 01多数のPEP 8スタイル規則に照らしてコードをチェックし、それぞれに固定のエラーコードを付けて報告します。
- 02Python標準ライブラリのみに依存する単一ファイルとして提供されます。
- 03各エラーのファイル名、行、列を出力するため、エディターから該当箇所に移動できます。
- 04違反があったソース行と、関連するPEP 8のガイダンスを表示できます。
- 05コードベース全体のエラーを集計する統計モードを備えています。
- 06カスタムチェックを追加するためのプラグインに対応しています。
ユースケース
- Pythonプロジェクトの継続的インテグレーションで、PEP 8に沿った一貫性のある書式を徹底する。
- Pythonコードの作成中に、エディターからスタイル違反のフィードバックを受け取る。
- 大規模なレガシーコードベースを監査し、どのスタイル違反が多いかを把握する。
- 重い依存関係をインストールせず、軽量なスタイルチェックを実行する。
クイックスタート
- 1
pipでpycodestyleをインストールします
pip install pycodestyle - 2
Pythonファイルに対して実行し、スタイルをチェックします
pycodestyle --first optparse.py
使う前に知っておきたいこと
- メタデータにライセンスが明記されていません(NOASSERTION)。再利用する前にリポジトリを確認してください。
収録されている特集
トピック
よくある質問
- pycodestyle とは?
- 標準ライブラリだけで動作し、PEP 8のスタイル規約に沿っているかをチェックする単一ファイルのPythonチェッカー。 pycodestyleは、Pythonの公式スタイルガイドであるPEP 8で定められたスタイル規約の一部に照らして、Pythonソースコードをチェックします。1行に複数のimportがある、関数間の空行数が適切でない、余分な空白がある、行が長すぎるといった違反を検出し、それぞれにE401やE302などのコードとファイル内の位置を付けて報告します。
- pycodestyle は無料で使えますか?ライセンスは?
- pycodestyle は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
- pycodestyle は今もメンテナンスされていますか?
- 活発にメンテナンス中。pycodestyle の最終コミットは 2026年11月4日 です。
- pycodestyle は何に使えますか?
- Pythonプロジェクトの継続的インテグレーションで、PEP 8に沿った一貫性のある書式を徹底する。 Pythonコードの作成中に、エディターからスタイル違反のフィードバックを受け取る。 大規模なレガシーコードベースを監査し、どのスタイル違反が多いかを把握する。 重い依存関係をインストールせず、軽量なスタイルチェックを実行する。
- pycodestyle のインストール方法は?
- pipでpycodestyleをインストールします: pip install pycodestyle Pythonファイルに対して実行し、スタイルをチェックします: pycodestyle --first optparse.py
- pycodestyle はどこで入手できますか?
- ソースコードとインストール手順は GitHub にあります:https://github.com/PyCQA/pycodestyle
概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。
関連プロジェクト
pyflakesやpycodestyleがチェックしない、バグの可能性が高いコードや疑わしい設計パターンを検出するFlake8プラグイン。
PyFlakes、pycodestyle、McCabeを1つのコマンドにまとめ、サードパーティ製プラグインにも対応するPythonリンターです。
Pythonのimportを選択したスタイルガイドに沿ってグループ分け・整列できているかをチェックする、flake8およびPylama用プラグイン。
関数のMcCabe循環的複雑度を計算し、flake8プラグインとして複雑すぎるコードを検出するPythonツールです。
Pythonコードを実行せずに解析し、エラーの検出、コーディング規約の適用、コードスメルの指摘を行う静的解析ツールです。