VSCodeで静的コード解析ツールPylintを使用する
はじめに
PythonではPEP8というコード規約が一般的に使用されているようです。（PEP 8 -- Style Guide for Python Code）
この規約に準拠したツールがいくつかあり、これ！っというものは特にないという印象です。
で、代表的なものとして、同名のpep8があるのでややこしい。
ちなみにツールの方のpep8は名前を変更してpycodestyleとなっていますので注意。（pep8は1.7.1が最終更新のようです。）
詳細はQiitaにまとまっている記事がありましたのでこちらを参照してください。（pep8 が pycodestyle に変わった話）
他にもflake8や今回紹介するPylintが競合としてあるようです。
で、今回はPylintを使用することになっていたので、こちらをVSCodeで使用する方法について調べたメモです。
手順
- VSCodeでPythonを入れる際にはまず使用するであろう拡張機能ms-python.pythonを入れる
- 設定を確認
"python.linting.enabled"がtrueになっていること"python.linting.pylintEnabled"がtrueになっていること"python.linting.lintOnSave"はお好みで"python.linting.pylintPath"このPATHでコマンドが実行されるので、PATHが通ってない場合には修正が必要です。
- Pylintの設定ファイルを作成
- デフォルトだと警告が出てくれない事、厳しすぎる規約を変更したい事から設定ファイルを作成します。
- 下記のコマンドでデフォルトの設定ファイルが作成されます。
pylint --generate-rcfile > .pylintrc- 設定ファイルの場所は公式ドキュメントを参照。
- workingdirectoryにpylntrcか、.pylintrcを置いておけばよいかと。
- 日本語onlyの人は訳はここにありました
- 指摘を確認
- 問題ビューに指摘が表示されます。（macだとshift + command + m）
- 明らかにおかしいコードで表示されない場合には、設定ファイルを一旦renameして指摘されるか確認しましょう。
- 設定ファイルを調整
- システム全体で警告を無効化する場合は設定ファイルを修正。
- あるコードのみ例外的に無視したい場合にはコメントとして↓のように無視したいコードを入力すれば無視してくれます。
# pylint: disable=C0330- あまり調べていないのですがファイル全体で無効化されるようなので注意。
- 好みですが、私は以下を修正しました。
- max-line-lengthを120
- デフォルトの100だと厳しいと感じました。
- good-namesにf,vを追加
- スコープに関係なく、1から2文字の変数を許してくれません。
- 実際のプロジェクトでは分析でよく使用される変数名を追加しています。
- あるコードのみ例外的に無視したい場合にはコメントとして↓のように無視したいコードを入力すれば無視してくれます。
