Casual Developers Note

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

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • お問い合わせ
現在の場所:ホーム / アーカイブpython

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

Pythonパッケージ管理の新標準Pipenv入門

Pythonパッケージ管理の新標準Pipenv入門

Pythonのパッケージ管理の仕組みは他のプログラミング言語と比較して使いにくいものでしたが、やっとPipenvという使いやすいパッケージ管理ツールが登場しました。今回はPipenvの簡単な使い方を紹介します。

はじめに

PyCon 2018のこちらの動画「Kenneth Reitz – Pipenv: The Future of Python Dependency Management」をご覧ください。英語が多少わかる方ならすぐにPipenvの良さが理解できたと思います。

Pythonの世界では、Pythonパッケージを管理する方法として、仮想環境(virtualenv/venv)を作り、その上にrequirements.txtを使ってパッケージを読み込む方法がずっと使われてきました。Pythonの世界から出たことがない人は気づかないかもしれませんが、例えば一歩JavaScriptの世界に足を踏み入れてみると、NPMやYarnを使い、ロックファイルの仕組み(プロジェクト単位で設定ファイルにパッケージのバージョンを指定したり、開発用とプロダクション用でインストールするパッケージを分けたりする方法)でパッケージを管理しています。この方法を知っていると、Pythonの今までの方法がいかに使いにくいか分かります。

そこで、このロックファイルの仕組をPythonの世界に持ち込み、新標準となりつつあるのがPipenvです。PipenvではJavaScriptのNPMやYarnと同じように、柔軟なパッケージのバージョン指定や開発用とプロダクション用のパッケージ分けを設定ファイルに書くことができ、パッケージのインストールと同時に仮想環境が生成されるので、開発フローが分かりやすく、よりシームレスになります。本当に便利です。

それでは、さっそく新しいPythonパッケージ管理ツール「Pipenv」に入門しましょう。

従来のパッケージ管理方法(PIP)

まずは、よく使われているPIPを使ったPythonパッケージの管理方法をおさらいしておきましょう。

PIPコマンドによるパッケージのインストールとエクスポート

プロジェクト用にvenvで仮想環境を構築し、その仮想環境上にPIPでパッケージをインストールします。その後、「pip freeze」で仮想環境上にインストールされているパッケージを「requirements.txt」に出力します。

$ python --version
Python 3.7.1
$ mkdir sample-flask-app-old-way
$ cd sample-flask-app-old-way/
$ python -m venv .venv
$ ls -a
./     ../    .venv/
$ source .venv/bin/activate
$ pip install --upgrade pip
$ pip --version
pip 18.1
$ pip install Flask flask_restful flask_cors marshmallow pymongo ptvsd pytest
$ pip list
Package        Version
-------------- -------
aniso8601      4.0.1
atomicwrites   1.2.1
attrs          18.2.0
Click          7.0
Flask          1.0.2
Flask-Cors     3.0.7
Flask-RESTful  0.3.6
itsdangerous   1.1.0
Jinja2         2.10
MarkupSafe     1.1.0
marshmallow    2.16.3
more-itertools 4.3.0
pip            18.1
pluggy         0.8.0
ptvsd          4.2.0
py             1.7.0
pymongo        3.7.2
pytest         4.0.1
pytz           2018.7
setuptools     39.0.1
six            1.11.0
Werkzeug       0.14.1
$ pip freeze > requirements.txt
$ cat requirements.txt
aniso8601==4.0.1
atomicwrites==1.2.1
attrs==18.2.0
Click==7.0
Flask==1.0.2
Flask-Cors==3.0.7
Flask-RESTful==0.3.6
itsdangerous==1.1.0
Jinja2==2.10
MarkupSafe==1.1.0
marshmallow==2.16.3
more-itertools==4.3.0
pluggy==0.8.0
ptvsd==4.2.0
py==1.7.0
pymongo==3.7.2
pytest==4.0.1
pytz==2018.7
six==1.11.0
Werkzeug==0.14.1
$ deactivate

後は「requirements.txt」を使ってパッケージのバージョンを管理します。この方法には問題があります。それは、開発用のパッケージとプロダクション用のパッケージが混ざっている点です。これに対するメジャーな解決策はrequirements.txtを別名にして分割し、開発時とプロダクション時で別々のrequirements.txtを読み込む方法です。かなり面倒です。

PIPコマンドとrequirements.txtファイルによりパッケージのインストール

「requirements.txt」ファイルを作成し、それを使ってインストールします。

$ mkdir sample-flask-app-old-way2
$ cd sample-flask-app-old-way2/
$ vi requirements.txt
Flask==1.0.2
Flask-RESTful==0.3.6
Flask-Cors==3.0.7
marshmallow==2.16.3
pymongo==3.7.2
ptvsd==4.2.0
pytest==4.0.1
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install --upgrade pip
$ pip install -r requirements.txt
$ pip list
Package        Version
-------------- -------
aniso8601      4.0.1
atomicwrites   1.2.1
attrs          18.2.0
Click          7.0
Flask          1.0.2
Flask-Cors     3.0.7
Flask-RESTful  0.3.6
itsdangerous   1.1.0
Jinja2         2.10
MarkupSafe     1.1.0
marshmallow    2.16.3
more-itertools 4.3.0
pip            18.1
pluggy         0.8.0
ptvsd          4.2.0
py             1.7.0
pymongo        3.7.2
pytest         4.0.1
pytz           2018.7
setuptools     39.0.1
six            1.11.0
Werkzeug       0.14.1
$ deactivate

「requirements.txt」で指定したバージョンのパッケージと依存関係のあるパッケージががインストールされました。

ここまでが従来のPIPによるパッケージ管理の方法でした。

新標準のパッケージ管理方法(Pipenv)

それでは、いよいよPipenvを使っていきましょう。

Pipenvのインストール

PIPからインストールできます。最新版をインストールする場合は以下のコマンドを実行しましょう。

$ pip install --user pipenv
$ pip install --user --upgrade pipenv

バージョンを指定する場合は以下のようにします。

$ pip install --user pipenv==2018.10.13

あるいは、MacからHomebrewでインストールすることもできます。その場合は以下になります。

$ brew install pipenv

Pipenvの設定

Pipenvを使うと自動的に仮想環境が作られるのですが、そのパスをプロジェクト内に指定したい場合は「PIPENV_VENV_IN_PROJECT=1」を「.bash_profile」や「.bashrc」などに設定する必要があります。

$ echo "export PIPENV_VENV_IN_PROJECT=1" >> ~/.bash_profile

この設定をしておけば「pipenv install」実行時にプロジェクト内に「.venv」という名前の仮想環境が構築されるので、扱いやすいです。

Pipenvのサポート情報の確認

Pipenvのバージョン、指定できるPythonバージョンのリスト、パスの設定内容などを確認してみましょう。

$ pipenv --version
pipenv, version 2018.10.13
$ pipenv --support
$ pipenv --support Pipenv version: `'2018.10.13'` Pipenv location: `'/Users/user/.local/lib/python3.7/site-packages/pipenv'` Python location: `'/Users/user/.anyenv/envs/pyenv/versions/3.7.1/bin/python3.7'` Python installations found: - `3.7.1`: `/Users/user/.anyenv/envs/pyenv/shims/python` ...

この時点でエラーになった場合はPipenvのissueを確認してみましょう。ちなみに執筆時点では最新の「2018.11.14」はMac OS上ではエラーで動かないので、一つ前のバージョン「2018.10.13」を使っています。

Pipenvによる初期化

今回用のプロジェクトディレクトリを作成し、Pipenvの初期化をしてみましょう。

$ mkdir sample-flask-app-new-way
$ cd sample-flask-app-new-way/
$ pipenv install
$ ls -a
./            ../           .venv/        Pipfile       Pipfile.lock
$ cat Pipfile
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]

[dev-packages]

[requires]
python_version = "3.7"

この時点で仮想環境「.venv」が自動的に作成され、「Pipfile」と「Pipfile.lock」のロックファイルが作成されます。もしすでにこれらのファイルが存在する場合は、指定されているパッケージが自動的にインストールされます。なので、この2つのファイルはGitで管理することになります。(JavaScriptの「package.json」と「package-lock.json」と同じですね。)

Pipfileの詳しい書き方は公式ドキュメントを参照すると良いでしょう。

Pipenvによるパッケージのインストール

次にPipenvで、プロダクション用のパッケージと開発用のパッケージを分けてインストールしてみましょう。

$ pipenv install Flask==1.0.* flask_restful==0.3.* flask_cors==3.0.* marshmallow==2.16.* pymongo==3.7.*
$ pipenv install --dev ptvsd pytest
$ cat Pipfile
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
flask = "==1.0.*"
flask-restful = "==0.3.*"
flask-cors = "==3.0.*"
marshmallow = "==2.16.*"
pymongo = "==3.7.*"

[dev-packages]
ptvsd = "*"
pytest = "*"

[requires]
python_version = "3.7"

分けてインストールできました。

Pipenvによるパッケージのアップデート

古くなっているパッケージを確認して、アップデートします。

$ pipenv update --outdated
$ pipenv update

パッケージを指定してアップデートする場合は以下のようにします。

$ pipenv update Flask

Pipenvによるパッケージのアンインストール

パッケージ名を指定してアンインストールする場合は以下のようにします。この場合は、仮想環境とPipfileの両方から削除されます。

$ pipenv uninstall Flask

仮想環境だけからパッケージを全てアンインストールする場合は以下のようにします。この場合はPipfileはそのまま残ります。

$ pipenv uninstall --all

開発用のパッケージだけを全てアンインストールする場合は以下のようにします。この場合は、開発用に限り、仮想環境とPipfileの両方から削除されます。

$ pipenv uninstall --all-dev

Pipenvで仮想環境の削除

仮想環境(.venv)を削除するには以下のコマンドを実行します。

$ pipenv --rm

Pipenvでrequirements.txtからインストール

Pipenvを使う場合は、Pipfileがrequirements.txtの代替になります。なので、Pipenvを前提とした場合はrequirements.txtは不要になるのですが、移行する場合などはまだrequirements.txtからインストールする場面があるかもしれません。やってみましょう。

$ mkdir sample-flask-app-import-old-way
$ cd sample-flask-app-import-old-way/
$ vi requirements.txt
Flask==1.0.2
Flask-RESTful==0.3.6
Flask-Cors==3.0.7
marshmallow==2.16.3
pymongo==3.7.2
ptvsd==4.2.0
pytest==4.0.1
$ ls -a
./                ../               requirements.txt
$ pipenv install
$ ls -a
./                ../               .venv/            Pipfile           Pipfile.lock      requirements.txt
$ cat Pipfile
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
marshmallow = "==2.16.3"
pymongo = "==3.7.2"
ptvsd = "==4.2.0"
pytest = "==4.0.1"
Flask = "==1.0.2"
Flask-RESTful = "==0.3.6"
Flask-Cors = "==3.0.7"

[dev-packages]

[requires]
python_version = "3.7"

Pipenvではインストール時にPipfileが存在せず、requirements.txtが存在する場合は、自動的にrequirements.txtからインポートします。自分でrequirements.txtファイルを指定する場合は以下のようにします。

$ pipenv install -r requirements.txt

Pipenvによるシェル実行

仮想環境の有効や無効を切り替えるために、従来はactivateとdeactivateを実行していましたが、Pipenvでは「pipenv shell」コマンドを実行することでactivsteされ、「exit」でdeactivateされます。さらに、仮想環境をactivateしないでも「pipenv run」コマンドを使うことで仮想環境内でPythonを実行できます。やってみましょう。

$ mkdir sample-flask-app
$ cd sample-flask-app
$ vi Pipfile
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
Flask = "==1.0.2"
Flask-RESTful = "==0.3.6"
Flask-Cors = "==3.0.7"
marshmallow = "==2.16.3"
pymongo = "==3.7.2"

[dev-packages]
ptvsd = "==4.2.0"
pytest = "==4.0.1"

[requires]
python_version = "3.6"
$ pipenv install
Creating a virtualenv for this project…
Pipfile: /Users/user/sample-flask-app/Pipfile
Using /Users/user/.anyenv/envs/pyenv/versions/3.6.5/bin/python3.6 (3.6.5) to create virtualenv…
...
$ pipenv shell
(sample-flask-app)$ python --version
Python 3.6.5
(sample-flask-app)$ pip list
Package       Version
------------- -------
aniso8601     4.0.1
Click         7.0
Flask         1.0.2
Flask-Cors    3.0.7
Flask-RESTful 0.3.6
itsdangerous  1.1.0
Jinja2        2.10
MarkupSafe    1.1.0
marshmallow   2.16.3
pip           18.1
pymongo       3.7.2
pytz          2018.7
setuptools    40.6.2
six           1.11.0
Werkzeug      0.14.1
wheel         0.32.3
(sample-flask-app)$ exit
exit

Pipenvによるバージョン変更

PipenvではPythonのバージョンを指定することで、仮想環境をまるごと入れ替えられます。「–three」オプションを指定すると、すでに存在する仮想環境が削除され、ローカルにインストールされている最新のPython3の仮想環境が新しく作成されます。「–two」オプソンと指定すると同じことがPython2で行われます。「–python X.X.X」オプションを指定すると固定のPythonバージョンを指定できます。先程の続きからやってみましょう。

$ pipenv --three
Virtualenv already exists!
Removing existing virtualenv…
Creating a virtualenv for this project…
Pipfile: /Users/user/sample-flask-app/Pipfile
Using /Users/user/.anyenv/envs/pyenv/shims/python3 (3.7.1) to create virtualenv…
...
$ pipenv run python --version
...
Python 3.7.1
$ pipenv --two
Virtualenv already exists!
Removing existing virtualenv…
Creating a virtualenv for this project…
Pipfile: /Users/user/sample-flask-app/Pipfile
Using /usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/bin/python2.7 (2.7.15) to create virtualenv…
...
$ pipenv run python --version
...
Python 2.7.15
$ pipenv check
Checking PEP 508 requirements…
Specifier python_version does not match 3.6 (2.7).
Failed!
$ pipenv --python 3.6.5
Virtualenv already exists!
Removing existing virtualenv…
Creating a virtualenv for this project…
Pipfile: /Users/user/sample-flask-app/Pipfile
Using /Users/user/.anyenv/envs/pyenv/versions/3.6.5/bin/python3.6 (3.6.5) to create virtualenv…
...
$ pipenv check
Checking PEP 508 requirements…
Passed!
Checking installed package safety…
All good!
$ pipenv run python --version
Python 3.6.5

仮想環境とPipfileに不整合があるかどうかは「pipenv check」コマンドで確認しています。また、新しく作られた仮想環境はクリーンなので、必要に応じて「pipenv install」を再度実行してください。あるいは、「pipenv install –three」のように一緒にPythonのバージョンを指定することもできます。

おまけ(追記)

DockerでPipenvを使う

Docker上でPipenvを使う場合のDockerfileは以下のようになります。

FROM python:3.7.1-slim-stretch

WORKDIR /usr/src/app

RUN pip install --upgrade pip setuptools \
  && pip install pipenv==2018.11.26

COPY Pipfile ./
COPY Pipfile.lock ./
RUN pipenv install --deploy --system

COPY ./ ./

EXPOSE 5000

CMD python src/app.py

ポイントは、仮想環境を構築せずにシステムにインストールしている点です。Dockerではコンテナで環境が分離されるので仮想環境を使う必要がないためです。Pipenvでインストールする場合、開発用であれば「pipenv install --dev --system」、プロダクション用であれば「pipenv install --deploy --system」が良いと思います。後は、追加としてFlaskやDjangoなどのフレームワーク向けの環境変数などを追加すれば完璧です。

最後に

いかがでしたか?これでPipenvの基本的な使い方は理解できたと思います。まだ新しいツールですが、今後デファクトスタンダードになることは間違いないので、今のうちに使えるようになってしまいましょう。それでは。

環境

  • PC: macOS Mojava 10.14.1
  • Python: 3.7.1
  • PIP: 18.1
  • Pipenv: 2018.10.13

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

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

Docker上でPython FlaskのRESTアプリケーションを構築し、Visual Studio Codeからリモートデバッグする方法

Docker上でPython FlaskのRESTアプリケーションを構築し、Visual Studio Codeからリモートデバッグする方法

Docker上にアプリケーションを構築するのが一般的になってきた昨今、Dockerコンテナへのリモートデバッグはバグ解析には必須です。今回は、Visual Studio CodeでPythonのFlaskで作成したRES APIアプリケーションをリモートデバッグする方法を紹介します。

はじめに

FlaskはPythonでサーバーサイドアプリケーションを作る人気のフレームワークです。Visual Studio CodeはもとはJavaScript向けのエディタでしたが、今ではPythonの開発環境としても人気のエディタです。

リモートデバッグとは、リモート(ローカル以外)で稼働しているアプリケーションに対して、ローカルから接続して、デバッグすることです。Docker上にあるアプリケーションをデバッグするには、リモートデバッグで行う必要があります。

今回は、Docker上でFlaskで作ったREST APIアプリケーションを構築し、そのアプリケーションへVisual Studio Codeからリモートデバッグしていきましょう。

前提

以下の準備が整っている必要があります。

  • Dockerがインストールされている
  • Visual Studio Codeがインストールされている(Python用の基本設定は以前の記事を参照してください)
  • Python3がインストールされている

細かいバージョンは「環境」を参照してください。

Docker上に簡単なFlaskのREST APIアプリケーションを作る

ベースを作る

まずはデバッグする対象となるRESTアプリケーションを簡単に作成しましょう。FlaskでRESTなAPIを作ります。

$ mkdir flask-vscodea-app
$ cd flask-vscodea-app/
$ touch app.py
$ touch requirements.txt
$ touch Dockerfile
$ touch docker-compose.yml

Dockerの設定ファイルを作る

今回のアプリケーションはFlakeのアプリケーションからMongoDBを使う構成にします。

Dockerfile

以下のようにします。

FROM python:3-slim-stretch

WORKDIR /usr/src/app

COPY requirements.txt ./
RUN pip install --upgrade pip setuptools \
  && pip install --no-cache-dir -r requirements.txt

ENV PYTHONUNBUFFERED 1
ENV FLASK_APP app.py

COPY ./ ./

EXPOSE 5000

CMD python app.py

注意点としては、PythonのイメージとしてAlpineを選択するとビルドできないパッケージがあるという点です。Dockerに慣れているとAlpineを選択しがちですが、PythonではSlimを選択するのがベターです。

また、DockerでPython環境を構築する場合は、venvで仮想環境を構築する必要はなく、単にグローバルにパッケージをインストールして使います。

docker-compose.yml

FlakeのアプリケーションからMongoDBを使う構成になるように以下のように書きます。

version: '3'

services:
  web:
    build: .
    ports:
      - "3000:3000"
      - "5000:5000"
    environment:
      - FLASK_ENV=development
      - REMOTE_DEBUGGING=False
    volumes:
      - .:/usr/src/app
    links:
      - db

  db:
    image: mongo
    ports:
      - "27017:27017"

外部ポートは、Flaskアプリケーション用に5000ポート、リモートデバッグ用に3000ポートを開けてあります。

Flaskアプリケーションを作る

簡単なREST APIを作ります。

requirements.txt

インストールするパッケージのリストを書きます。

ptvsd
Flask
flask_restful
pymongo

app.py

Flaskのアプリケーションを書きます。

今回は環境変数として「REMOTE_DEBUGGING」のフラグを持たせることで、REMOTE_DEBUGGINGがTrueの場合にリモートデバッグができるようにしています。

注意点としては、リモートデバッグする時は、Flask実行時に「––no-debugger」(debug=False)と「––no-reload」(use_reloader=False)のオプションを有効にする必要があります。詳しくは公式ドキュメントを参照してください。

動作確認

それでは、APIの動作確認を簡単にしましょう。

OKですね。

Visual Studio Codeでリモートデバッグする

次に、Dockerへのリモートデバッグをやってみましょう。

ローカルにptvsdをインストールする

Visual Studio Codeでリモートデバッグする場合は、PTVSDをローカルとDockerコンテナの両方にインストールする必要があります。

Visual Studio Codeのデバッグ設定ファイルを作る

Visutal Studio Codeを開き、デバッグボタンから「構成の追加」をクリックします。

NewImage

「Python」を選択します。

NewImage

すると、ローカルに「.vscode/launch.json」のファイルが作成されます。

NewImage

launch.json

「.vscode/launch.json」にリモートデバッグ用の設定を以下のように追加します。

リモートデバッグ用のポートを3000に設定しています。今回のDockerの設定ですでに3000ポートは開けてありますね。

動作確認

それではリモートデバッグの動作確認をしていきましょう。

まずは、REMOTE_DEBUGGINGを有効にして、Dockerを起動します。

するとデータベースだけ起動して、以下のように接続待ち状態になります。

NewImage

Visual Studio Codeからデバッグで接続します。

NewImage

リモートデバッグの接続が完了するとFlaskアプリケーションが以下のように起動します。

NewImage

これでリモートデバッグの準備は完了しました。

次に、POSTしたデータを取得している箇所でブレークポイントを設定しています。

NewImage

コマンドラインからPOSTしてみます。

受信したデータがデバッグ画面に表示されています。

NewImage

これでリモートデバッグが動いていることが確認できました。

最後に

いかがでしたか?これでDockerコンテナ上にPythonでアプリケーションを構築した場合に、Visutal Studio Codeからデバッグできるようになりましたね。それでは。

環境

  • Visutal Studio Code: 1.28.2
  • Docker: Docker version 18.06.1-ce, build e68fc7a
  • Python: 3.7.1
  • pip: 18.1
  • ptvsd: 4.1.4

カテゴリ : 技術 Tips & Tutorials タグ : docker, flask, python, remote-debugging, vscode

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

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

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

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

はじめに

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用リンター「Pylint」のインストール

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

NewImage

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

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

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

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

NewImage

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

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

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

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

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

おまけ

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

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

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

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

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

リンターをFlake8に変更する

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

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

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

NewImage

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

最後に

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

環境

  • Visual Studio Code: 1.28.2
  • Python: 3.7.1

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

  • 1
  • 2
  • 次のページ »

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

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にブログ移転する最適な方法
  • SpringBootのProfile毎にプロパティを使い分ける3つの方法
    SpringBootのProfile毎にプロパティを使い分ける3つの方法
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~
    今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~
  • バンクーバー留学豆知識: バンクーバーのカジノを攻略せよ!必勝法を公開します!
    バンクーバー留学豆知識: バンクーバーのカジノを攻略せよ!必勝法を公開します!

Bitcoin寄付 / BTC Donation

Bitcoinを寄付しよう

BTC
Select Payment Method
Personal Info

Donation Total: BTC 0.0010

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

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

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

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

Copyright © 2023 KD - Casual Developers Notes