よしたく blog

ほぼ週刊で記事を書いています

blackをVS codeで使うための手順

Python に限らず、プログラミングで開発する際には様々な便利ツールを導入する。 今回は Python の フォーマッタ である black を VS Code に導入する方法をメモしておく。

black を有効にする

VS Code では autopep8 がデフォルトで有効になっている。 black も設定としては持っているので、変更する。 GUI で設定をおこなうと settings.json にも反映される。

f:id:yoshitaku_jp:20201126214814p:plain

f:id:yoshitaku_jp:20201126215015p:plain

保存時のフォーマット実行 を有効にする

手動でフォーマットを実行するのはめんどくさいので、ファイルを保存したタイミングで実行するようにしたい。 こちらも VS Code の設定画面から有効にできる。 settings.json に追記されていることも確認できる。

f:id:yoshitaku_jp:20201126215036p:plain

f:id:yoshitaku_jp:20201126215101p:plain

貼り付け時のフォーマット実行 を有効にする

貼り付けたタイミングでも実行するようにしたい。 こちらも VS Code の設定画面から有効にできる。 settings.json に追記されていることも確認できる。

f:id:yoshitaku_jp:20201126215136p:plain

f:id:yoshitaku_jp:20201126215202p:plain

black をインストールする

VS Code から black がないことを警告されるのでインストールする。

f:id:yoshitaku_jp:20201126215246p:plain

確認

VS Code で black が有効になっている。

f:id:yoshitaku_jp:20201126215314p:plain

f:id:yoshitaku_jp:20201126215329p:plain