Casual Developers Note

エンジニアやデザイナー向けの技術情報・英語学習情報・海外留学情報・海外旅行情報を提供中。世界を旅して人生を楽しもう。

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • お問い合わせ
現在の場所:ホーム / 技術 Tips & Tutorials / PythonのためのVisual Studio Codeの設定方法

2018年11月2日 By KD コメントを書く

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

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

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

見出し

  • 1 はじめに
  • 2 Visual Studio CodeのPython用設定
    • 2.1 前提
    • 2.2 Python用のVisual Studio Codeプラグイン
    • 2.3 Visual Studio CodeのPython設定
    • 2.4 Python用リンター「Pylint」のインストール
    • 2.5 Python用フォーマッター「autopep8」のインストール
    • 2.6 リモートデバッグ用の「ptvsd」のインストール
  • 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

NewImage

Visual Studio CodeのPython設定

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

NewImage

「ユーザ設定」にて、以下のように「[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が自動でインストールされます。

NewImage

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

$ pip install pylint

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

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

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

NewImage

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

$ 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です。

NewImage

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

$ pip install flake8

最後に

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

環境

  • Visual Studio Code: 1.28.2
  • Python: 3.7.1
The following two tabs change content below.
  • この記事を書いた人
  • 最新の記事
KD
Twitter のプロフィール

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。
KD
Twitter のプロフィール

最新記事 by KD (全て見る)

  • 2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介 - 2020年1月13日
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~ - 2019年11月4日
  • ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~ - 2019年10月30日

関連記事

  • UXデザイン初学者のための基本用語まとめ

    UXという言葉はだいぶ前からデザインの考え方として流行っています。ただ、本気で学ぼうと思うとどうしても情報は英語になるた…

  • [tips][perl] Perlで文字コードをいい感じに処理する方法

    日頃のつまらないルーチンワークは全てスクリプト化している俺です。スクリプトは動的言語であれば気楽にかけるので何でもよいの…

  • Visual Studio Code コンプリート設定(Mac版) ~ Web開発に必要なVSCodeの初期設定と使い方の完全版 ~

    Webの世界は移り気が激しく、特にJavscript関係のフレームワークやツールはどれもこれも短いライフサイクルで消滅し…

  • Amazon EC2インスタンスにSSHできなくなった時の対処法

    あれ?再起動したらEC2インスタンスにSSHできないぞ?今までSSHできていたのになぜだ?AWSでEC2インスタンスを作…

  • CircleCI 2.0で.envファイルを環境変数として使う方法

    CircleCI 2.0に環境変数を一つ一つ登録するのではなく.envファイルとして扱う方法はとても便利です。今回はCi…

カテゴリ : 技術 Tips & Tutorials タグ : python, vscode

コメントを残す コメントをキャンセル

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください。

ブログ更新情報や海外の関連情報などを配信する無料メルマガ

Sponsored Links

About Author

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。

https://casualdevelopers.com/

最近の投稿

  • 2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年1月13日
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    2019年11月4日
  • ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    2019年10月30日
  • BashからZshに移行する方法(Mac編)

    BashからZshに移行する方法(Mac編)

    2019年10月21日
  • Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    2019年9月30日

カテゴリ

  • 技術 Tips & Tutorials (100)
  • 技術塾 (6)
  • ライフハック (26)
  • 海外留学 (12)
  • 英語学習 (3)
  • コラム (6)

アーカイブ

最高の学習のために

人気記事ランキング

  • MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
    MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
  • Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
    Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
  • SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
    SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
  • バンクーバー留学豆知識:バンクーバーのATMで日本の銀行のキャッシュカードを使ってお得にお金を引き出す方法
    バンクーバー留学豆知識:バンクーバーのATMで日本の銀行のキャッシュカードを使ってお得にお金を引き出す方法
  • Amazon EC2インスタンスにSSHできなくなった時の対処法
    Amazon EC2インスタンスにSSHできなくなった時の対処法
  • Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
    Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
  • TumblrからWordPressにブログ移転する最適な方法
    TumblrからWordPressにブログ移転する最適な方法
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~
    今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~
  • SpringBootのProfile毎にプロパティを使い分ける3つの方法
    SpringBootのProfile毎にプロパティを使い分ける3つの方法
  • 爆速でJenkinsをマスターしよう(GitHubアカウント統合編) ~ JenkinsのGitHub Organizationの設定方法 ~
    爆速でJenkinsをマスターしよう(GitHubアカウント統合編) ~ JenkinsのGitHub Organizationの設定方法 ~

Bitcoin寄付 / BTC Donation

Bitcoinを寄付しよう

BTC
Select Payment Method
Personal Info

Donation Total: BTC 0.0010

このブログの運営のためにBitcoinでの寄付を募集しています。お気持ち程度の寄付を頂けると管理者の励みになります。

Bitcoin寄付について知りたい方はこちらの記事へ

The following two tabs change content below.
  • この記事を書いた人
  • 最新の記事
KD
Twitter のプロフィール

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。
KD
Twitter のプロフィール

最新記事 by KD (全て見る)

  • 2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介 - 2020年1月13日
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~ - 2019年11月4日
  • ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~ - 2019年10月30日

関連記事

  • UXデザイン初学者のための基本用語まとめ

    UXという言葉はだいぶ前からデザインの考え方として流行っています。ただ、本気で学ぼうと思うとどうしても情報は英語になるた…

  • [tips][perl] Perlで文字コードをいい感じに処理する方法

    日頃のつまらないルーチンワークは全てスクリプト化している俺です。スクリプトは動的言語であれば気楽にかけるので何でもよいの…

  • Visual Studio Code コンプリート設定(Mac版) ~ Web開発に必要なVSCodeの初期設定と使い方の完全版 ~

    Webの世界は移り気が激しく、特にJavscript関係のフレームワークやツールはどれもこれも短いライフサイクルで消滅し…

  • Amazon EC2インスタンスにSSHできなくなった時の対処法

    あれ?再起動したらEC2インスタンスにSSHできないぞ?今までSSHできていたのになぜだ?AWSでEC2インスタンスを作…

  • CircleCI 2.0で.envファイルを環境変数として使う方法

    CircleCI 2.0に環境変数を一つ一つ登録するのではなく.envファイルとして扱う方法はとても便利です。今回はCi…

ビットコイン取引ならここ

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • サイトマップ
  • タグ一覧
  • プライバシーポリシー
  • お問い合わせ

Copyright © 2023 KD - Casual Developers Notes