オリジナル住所：https://cloud.tencent.com/developer/article/1365969
「メンテナンスモード」へのソフトウェアプロジェクトでは、読みやすさの要件とコーディング標準は、（でも最初から、それらの規格が確立されていない）何にも簡単に来ることができます。しかし、コードライブラリのコードスタイルや検査基準の一貫性が大幅に圧力のメンテナンスを減らすことができ、またアプリケーションの全体の品質を維持しやすくなりながら、新たな開発者はすぐに、プロジェクトを理解していることを確実にするために。
将来の保守性に優れた方法は、すべての保護プロジェクトの後にコードの品質をチェックするために、外部のライブラリを使用しています。以下は、それらが一貫したコーディングスタイルを強制するために、プロジェクトの成熟するにつれて許容可能なテストのカバレッジがあることを確認するために使用し、ライブラリーの（PEP 8スタイルのエラーやその他のコードをチェック含む）私たちのお気に入りのチェックコードの一部をお勧めします。
あなたのコーディングスタイルをチェック
PEP 8は、線、くぼみ、マルチライン式、変数命名規則などの同様の長さを提供するPythonのスタイル仕様です。あなたのチーム自体も若干異なる仕様を有していてもよいがPEP 8コードのスタイルが、任意の客観的標準のコーディングスタイルはコードベースで一貫性のある基準を実施することで、コードをより読みやすく、保守が容易になります。以下の3つのライブラリは、コード美化あなたを助けるために使用することができます。
1、Pylint
PylintはPEP 8検査規範や一般的なエラーライブラリの違反です。それはまた、コマンドラインから個別に実行することができ、人気のエディタやIDEの一部に統合しました。
実行ピップはpylintインストールPylintをインストールします。そして、実行pylint [オプション]パス/に/ DIRまたはpylint [オプション]パス/に/ module.py Pylintあなたは、それが規範とコンソール出力コードを表示する間違った場所に違反するコマンドラインを使用することができます。
また、エラーチェック用コードPylintのpylintrcをカスタマイズするための設定ファイルを使用することができます。
2、Flake8
Flake8は「PEP 8、Pyflakes（似たPylint）、マッケイブ（コードの複雑インスペクタ）とサードパーティのプラグインはPythonのツールのPythonのスタイルと品質を確認するために一緒に統合すること」です。
実行ピップはflake8インストールflake8をインストールし、flake8実行し、[オプション]パス/に/ DIRまたはflake8 [オプション]パス/に/ module.py報告されたエラーや警告を見ることができます。
そしてPylintは同様に、Flake8は、コンテンツプロフィールは審査から定義できます。これは、自動的にコードを開発プロセスに組み込むことができます確認し、いくつかの有用なcommitフックを含め、非常に明確な文書を持っています。
Flake8また、エディタやIDEの間で人気のいくつかに統合することができますが、文書で詳細に説明しませんでした。お気に入りのエディタやIDEにFlake8を統合するには、（そのようFlake8プラグインの崇高テキストなど）のプラグインを検索することができます。
3、Isort
あなたがプロジェクトにライブラリをインポートすることができ、このライブラリIsort、アルファベット順にソートされ、適切に（例えば、標準ライブラリ、サードパーティのライブラリ、自作のライブラリなどのような）別の部分に分け。これは、コードの可読性を向上させ、大規模なライブラリをインポートするときにさまざまなライブラリを簡単に見つけることができます。
実行ピップはisortインストールisortをインストールし、/に/ module.py isortパスを実行する実行することができます。文書はまた、このようなコンフィギュレーションファイル.isort.cfgをインポートすることで、複数行のライブラリーに対処する方法を決定するisortとして、より多くの設定オプションを提供します。
そしてFlake8は、Pylintとして、isortも人気の編集やIDEプラグインと統合するためのもの。
あなたのコードのスタイルは、プラグインのIDEを実行することによって、これを達成するために、ファイルが痛みを伴うことで、あなたが好きではないかもしれたびに変更した後、手動でコードを確認するには、コマンドラインでそれらを共有します。同様に、あなたの同僚は、おそらく彼らの編集者でもプラグインの種類は、あなたはおそらく、コードをチェックしません、方法を確認するために別のコードを使用して、コードを修正するために厳格な警告に従うことができます。要するに、あなたは徐々に雑然として読みにくくなり、コードベースを共有しています。
良好な溶液は、コードが自動的にPEP 8仕様に従ってフォーマットされる、ライブラリを使用することです。私たちは、ライブラリは、カスタムコードをフォーマットする方法を制御するための3つの異なるレベルを持っています。これらの設定のいくつかは、そのようなPylintやFlake8など、より具体的な、ある、あなたはそこに立つことはできませんが、デフォルトの設定を変更することはできませんかどうかを確認するために最初にテストする必要があります。
4、Autopep8
Autopep8は自動的に再インデント、インデント修復を含むモジュールで指定されたコードを、フォーマットし、余分なスペースを削除し、（例えば、ブール値となし値のような）共通の比較誤差を再構成することができます。あなたは正しい文書の完全なリストを表示することができます。
--upgrade autopep8インストールAutopep8をインストールPIP実行します。次に、あなたのコードの再フォーマットautopep8 --in-場所--aggressive --aggressive缶を行います。攻撃的なオプションの数がAuotopep8は、コードスタイルにどのくらいのコントロールを管理している示しています。ここでは、より積極的な選択肢を学ぶことができます。
5、Yapf
Yapf独自の設定項目リストのコードを再フォーマットするために別のツールがあります。それが唯一のコードを読みやすくするために設計されたPEP 8スタイルの場所が、一貫性のないコードの再フォーマットの違反、存在しません、コード違反PEP 8標準的な場所を指摘しないことAutopep8とは異なります。
PIPがyapfインストールYapfをインストールし実行し、yapf [オプション]パス/ TO / DIR又はyapf [オプション]パス/ TO / module.py再フォーマットコードを実行します。ここでのカスタマイズオプションの完全なリストについて。