skip to content
barorin&?

VSCodeでPythonのコードフォーマッター・チェッカーを設定する

/ 2 min read

python , vscode

はじめに

VSCodeでPythonのコードフォーマッター・チェッカーを設定してみましょう。

方法

インストールするライブラリ

flake8 # コードチェッカー
black # コードの自動修正
isort # import文の自動並べ替え
mypy # 静的型チェッカー

VSCode の設定

ファイル > ユーザー設定 > 設定の検索ボックスで、

  1. 「Python > Linting: Enabled」と入力して、チェックボックスにチェック
  2. 「Python > Linting: Pylint Enabled」と入力して、チェックボックスのチェックを外す
  3. 「Python > Linting: Flake8 Enabled」と入力して、チェックボックスにチェック
  4. 「Python > Linting: Flake8 Args」と入力して、以下の設定を追加
  • --max-line-length=88（Flake8の1行の最大デフォルト文字数は79文字のため、Blackの88字に合わせる）
  • --extend-ignore=E203,W503
    • E203: Flake8のWhitespace before ':'を無視し、Blackの挙動（算術演算子の前後に空白を入れる）を優先する
    • W503: Flake8のline break before binary operatorを無視し、Blackの挙動（二項演算子の前の改行を許容する）を優先する
  1. 「Python > Lingint: Mypy Enabled」と入力して、チェックボックスにチェック
  2. 「Python > Formatting: Provider」と入力して、「black」を選択
  3. 「Editor: Format On Save」と入力して、チェックボックスにチェック
  4. 「Editor: Code Actions On Save」と入力して、「settings.json」で編集を開き、以下を追加
"editor.codeActionsOnSave": {
    "source.organizeImports": true
}

VSCode の拡張機能追加

「Error Lens」を追加（エラー表示を問題タブではなく、エディタ上にインラインで表示してくれる。便利！）