PythonのためのVisual Studio Codeの設定方法

Pythonは特にアカデミックな場で人気のプログラミング言語です。機械学習に注目が集まっている今、Pythonを学ぶことのメリットはさらに高まっています。今回は、PythonでコーディングするためのおすすめのエディタVisual Studio CodeでPythonの設定方法を紹介します。

見出し

1 はじめに
2 Visual Studio CodeのPython用設定
3 おまけ
- 3.1 Pylintで不要なルールを無効化する
- 3.2 リンターをFlake8に変更する
4 最後に
5 環境
- 5.1 関連記事

はじめに

Pythonのためのエディタと言えば、プロ御用達の有料エディタであるPyCharmが有名ですが、今では無料のVisual Studio Codeでも十分なコーディング環境が実現できます。しかもプラグインを入れるだけです。それでは、Python用の設定方法を紹介します。

Visual Studio CodeのPython用設定

前提

以下が完了している必要があります。

Pythonがインストール済みであること
Visual Studio Codeがインストール済みであること
Visual Studio Codeの基本的な設定が完了していること

Visual Studio Codeの基本設定は以前の記事を参考にしてください。

Python用のVisual Studio Codeプラグイン

以下のプラグインをインストールしてください。

Python extension for Visual Studio Code

Visual Studio CodeのPython設定

Visual Studio Codeの「基本設定 -> 設定」から設定ファイルを開きます。

「ユーザ設定」にて、以下のように「[python]」を指定することで、Python用のコーディング設定ができます。リンターはflake8、mypy、pep8、pylama、pylintから選択できます。デフォルトではpylintが有効になっています。

{
...
  "[python]": {
    "editor.tabSize": 4,
    "editor.formatOnSave": true,
    "editor.formatOnPaste": false,
    "editor.formatOnType": false,
  },
  "python.linting.enabled": true,
  "python.linting.lintOnSave": true,
  "python.linting.maxNumberOfProblems": 100,
  "python.linting.flake8Enabled": false,
  "python.linting.mypyEnabled": false,
  "python.linting.pep8Enabled": false,
  "python.linting.pylamaEnabled": false,
  "python.linting.pylintEnabled": true,
...
}

Python用リンター「Pylint」のインストール

PylintはPython専用のLinterです。PythonファイルをVisual Studio Codeで開くと、以下のダイアログが表示されます。この時に「install」をクリックすればpipでpylintが自動でインストールされます。

もちろん、コマンドラインから自分でインストールすることもできます。

$ pip install pylint

これでPythonのソースコードでダメな書き方を指摘してくれます。

Python用フォーマッター「autopep8」のインストール

autopep8はPython専用のフォーマッターで、Pythonのスタイルガイド「PEP8」に準拠するようにフォーマットしてくれます。PythonファイルをVisual Studio Codeで開くと、以下のダイアログが表示されるので、「Yes」をクリックすればpipでautopep8が自動でインストールされます。

もちろん、コマンドラインから自分でインストールすることもできます。

$ pip install autopep8

これでPythonのソースコードが自動的にフォーマットされます。

リモートデバッグ用の「ptvsd」のインストール

PTVSDはVisual Studio Code用のPythonのリモートデバッグツールです。最近はDocker上に開発環境を構築することが多いと思いますが、PTVSDを使うことでVisual Studio CodeでDockerコンテナ内のPythonサーバーをデバッグすることができます。

$ pip install ptvsd

リモートデバッグの方法は公式ドキュメントを参照するか、Docker上のPythonアプリケーションをリモートデバッグする方法の記事を書いたので参考にしてください。

おまけ

Pylintで不要なルールを無効化する

Pylintのルールは全てのプロジェクトでフィットするわけではないので、不要なルールを無効にしましょう。

まず、対象のプロジェクト内で「.pylintrc」を作ります。

$ cd my-python-project
$ pylint --generate-rcfile > .pylintrc

不要なチェックを「[MESSAGES CONTROL]の「disable」で無効化します。

...
[MESSAGES CONTROL]

disable=print-statement,
....
        E0401,
        C0111,
        C0103
....

ここでは、例としてE0401、C0111、C0103を無効化しています。

リンターをFlake8に変更する

Visual Studio CodeのデフォルトのリンターはPylintですが、ルールが厳しいため、「.pylint」ファイルを編集してカスタマイズして使うのが一般的です。一方で、バッドプラクティスのようなチェックは緩めにしてエラーになりそうな箇所だけしっかりキャッチしてくれればよいのであれば、Flake8はよい選択肢です。

設定を変更するには、「基本設定 -> 設定」から「ユーザ設定」を選択し、Pylint無効にして、Flake8を有効にすればよいです。以下のようになります。

{
...
  "python.linting.flake8Enabled": true,
  "python.linting.mypyEnabled": false,
  "python.linting.pep8Enabled": false,
  "python.linting.pylamaEnabled": false,
  "python.linting.pylintEnabled": false,
...
}

この状態でPythonファイルを開けば、以下のようにダイアログがでるので、このままローカルにもFlake8をインストールすればOKです。

もちろん、コマンドラインから自分でインストールしても構いません。

$ pip install flake8

最後に

いかがでしたか？これでVisual Studio CodeのPython設定ができたと思います。Pythonのコーディングを楽しみましょう。では。

環境

Visual Studio Code: 1.28.2
Python: 3.7.1

この記事を書いた人
最新の記事

Keid

自由で楽しい世界を目指すフルスタックWebデベロッパー。大学でコンピュータサイエンスを真面目に学び、日本の大手IT企業に就職後、新しい技術やスケールするビジネスが北米にある事に気づき、海外への挑戦を決意。全く英語ができなかっため、フィリピン留学およびカナダ留学を経て強制的に英語を上達させた。挑戦に終わりはない。このブログでは海外に挑戦したいエンジニアやデザイナーに少しでも有益な情報を提供していきたいと思う。（写真は旅行先のラスベガス）