【入門】Visual Studio CodeにBlackとFlake8をインストールする方法

2023年9月20日2023年9月23日

プログラミング

こんにちは。

今回はVSCodeにBlackとFlake8をインストールする方法を紹介します。

Blackはフォーマッター、Flake8はリンターとして、Pythonでは人気のツールです。（もちろん無料で使えます！）

フォーマッターはソースコードの形式を自動でキレイにしてくれます。

例えばインデントや半角スペースを自動で入れてくれたり、関数同士の感覚などを空ける改行作業も自動で行ってくれます。

リンターはコーディングルールに違反していないかを自動でチェックしてくれて、もし反するところがあれば警告を表示して教えてくれます。

このように、プログラミングを効率的、かつ可読性高いコードを保つために、自力で頑張るよりも便利なツールに頼ることで快適な開発環境を獲得することができるというわけです。

ぜひプログラミング開発する皆さんも、一緒に導入して快適な開発環境を構築しましょう！

目次 [ close ]

Blackのインストール方法

今までBlackを使うためには、仮想環境毎にpipインストールする必要がありました。

しかし最近では、VSCodeの拡張機能でインストールすることができ、pipインストールは不要で非推奨となってます。

なのでこれからフォーマッターやリンターを使う方々は、pipインストールではなく拡張機能を使いましょう。

VSCodeの拡張機能から「Black」と検索しましょう。

検索するとBlackと名前がつくものが複数ありますが、「Black Formatter」というところの「インストール」をクリックしてインストールしましょう。

インストールが終わったら、続いて「表示→コマンドパレット」（またはCtrl+Shift+P）をクリックし、検索窓で「Settings」と入力してください。

すると「Open User Settings(JSON)」がリストにあると思いますので、それをクリックしてください。

するとsettings.jsonファイルが開かれると思いますので、そこに以下を記述します。

{
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    },
    // 最大文字数の指定(flake8と合わせた数字に設定)
    "black-formatter.args": [
        "--line-length=88"
    ]
}

記述しましたら、settings.jsonを保存します。

これで準備は完了です。簡単ですね。

pipインストール時はもう少し設定が面倒だったのですが、かなり楽になったと思います。

念のため、ここまで出来たらVSCodeを一旦再起動しましょう。

では早速上手く動くか確認しましょう。

デモファイルを以下に用意しました。

import numpy as np
'''
hogehoge
'''

a=[1, 3,    9,
10]
print(a)

これを上書き保存すると、以下のように自動で整形されればOKです。

行をあけてくれてますし、インデントやスペースも自動で修正してくれてます。

Flake8のインストール方法

リンターのFlake8もかなり設定が簡単になりました。

Black同様、拡張機能から「Flake8」と検索します。

Black同様、「Open User Settings(JSON)」を開きましょう。

以下のように、追記してください。

{
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    },
    // 最大文字数の指定(flake8と合わせた数字に設定)
    "black-formatter.args": [
        "--line-length=88"
    ],
    "flake8.args": [
        "--max-line-length=88",
        "--ignore=E203,W503,W504"
    ]
}

追記したら、保存します。

念のため、VSCodeを再起動しましょう。

では正しく動くか、確認しましょう。

import numpy as np

"""
hogehoge
"""
a = [1, 3, 9, 10, "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"]
print(a)

これを上書き保存すると、以下のようになればOKです。