はじめに
python初心者が「ステップ実行してコードの動きを見たい」というきっかけから、これを実現できる環境としてVSCodeを導入してみました。
環境
Windows10 x64
前提条件
- python3 or Anacondaをインストール済み
環境構築
VSCodeをインストールする
Visual Sutudio Codeからダウンロードしインストールします。
最新バージョン1.3.1.1を使います（2019/02/23現在）。
PATHの設定
VSCodeでPythonを動かすには、python.exeの場所を教える必要があります。デフォルトでは環境変数PATHを見に行くので、それに実行バイナリがあるフォルダパスを設定します（設定済みの方はスキップ）。
Windowsの[コントロールパネル]->[システム]->[システムの詳細設定]->[環境変数]を開き、PATHを追加する。
Anacondaインストール環境においては以下のパスにあるようです。
C:\Users\(ユーザ名)\Anaconda3\python.exe
PATHなのでフォルダパスを指定します。くれぐれもファイル名は含めないこと。
見つからない場合はWindowsの検索機能で「python.exe」を検索するとすぐに見つかります。
PATHが通ったかどうかを確認するには、コマンドプロンプトから「python」と入力するとよい。
C:\>python
Python 3.6.5 |Anaconda, Inc.| (default, Mar 29 2018, 13:32:41) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>
終了するにはCtrl+Z+Enterを入力する。
PATHが通ったことを確認できたので、VSCodeを再起動しておく。
Python Extentionインストール
VSCodeでpythonを扱うための拡張機能をインストールします。
[Shift+Ctrl+X]で「拡張機能」を開き、検索バーに「Python」を入力すると「Python」がヒットします。
実行確認
適当なpyファイルを作成します。
print("hello")
F5を押して実行します。
なんか怒られましたが、とりあえず実行環境はこれで整いました。
コードをステップ実行する
ブレークポイントを設置
行数の左側をクリックすることで赤丸が表示されます。
ステップ実行
F5を押すとコードを実行し、ブレークポイントで中断します。
以下、ステップイン実行した時の動きです（1つの画像です
）
このようにpythonコードがどのように実行されているのかを確認できました。
【余談1】ほかに調べたこと
VSCodeを使うならばと便利な拡張機能について調べたことも”記録として”載せておきます。
PyLintで静的解析しながらコーディング
コーディングの際には静的解析ツールを活用していると非常に捗るから是非とも入れておきたいところ。
しかし結論から言うと、多分何もしなくてもよかった模様。
いろいろ操作していたかどうかも、もはやこの記事を書いている時点で覚えていませんが、こんな手順を踏んでいたはず↓
- インストール方法をググる
- pipコマンドでインストールする方法が散見される(新調したmyPCには入ってないし、手間を避けたい...Anaconda環境にはないのか...?)
- Anaconda NavigatorからPyLintを検索
- 既にインストールされていた。
- VSCodeで構文エラーを発生させてみる
- 発生した
Anaconda Navigatorの検索画面は以下の通り。
pylintが「Installed」であることが分かります。
VSCodeを日本語化したい
VSCodeにはデフォルトに日本語がありません。そのためパッケージをインストールします。
[file]->[Preferences]->[Extensions]を選択
検索バー(Search Extensions in Marketplace)に「Japanese Language Pack for Visual Studio Code」を入力し、インストールします。
コマンドパレット（F1またはShift+Ctrl+P）を開き、「language」と入力すると、「Configure Display Language」がヒットし、それをクリックするとlocal.jsonファイルが開く。
{
// Defines VS Code's display language.
// See https://go.microsoft.com/fwlink/?LinkId=761051 for a list of supported languages.
"locale":"en" // Changes will not take effect until VS Code has been restarted.
}
【最後に】どうでもいい余談
Pythonを基礎から勉強するためにAnaconda環境でサンプルコードを動かしていましたが、「関数デコレータ」の動きがよくわからず、pythonを解説した某サイトには「こうかけば、こういうけっかが、でるよ」というような感じで、詳しい解説がありませんでした。
それならばステップ実行してどういう順番で実行されているのか見てみよう！と思い、デバッグ方法を調べてみました。
デバッグしたい場所にコードを追記するだけでデバッグできるというものがあったが、使いにくく、やめました。
以下のサイトで解説されております。
Pythonデバッグ方法 入門編
そんな時に、過去にVSCodeでpythonを扱っていた時、簡単にステップ実行ができることをふと思い出し、新調したmyPCにインストールしよう、ついでにQiitaに備忘録として残しておこうと思った次第です。
本来の目的である「関数デコレータの動きの理解」については、せっかくなので後日アップしようと思います。