この記事の内容まとめ
- Windows + Spyder + Anaconda で数値計算やシミュレーションをやってきたユーザが、VSCodeに移行するために拡張機能を作った話
- 拡張機能(ipydesk)でできること
- F5実行で、ブレイクポイントでも止められる
- Spyder の変数エクスプローラー的な変数ビュー
- プロットペイン的なグラフ表示
- セル実行やカーソル行実行のショートカット
- 拡張機能のリンク(marketplace)
なぜ拡張機能を自作するに至ったか
- 純正のPython拡張機能ではブレイクポイントを使うためにはデバッグモードでの実行が必要(また設定が手間)
- Jupyter拡張機能が微妙
- F5実行できない
- 実行結果とコードが別枠になっている
- プロットペインがない
- ショートカットをいちいち設定するのが面倒(チームメンバーに細かい設定を教えるのが面倒)
- これらのハードルを乗り越えてでもGitとの親和性が高いVSCodeに移行したかった(AIコーディング支援も)
できることの比較
○:できる △:できるが条件や手間がある ×:できない
| やりたいこと |
VSCode + IPyDesk |
VSCode + Python拡張 + Jupyter拡張 |
Spyder |
| F5 で実行して、実行後も変数が残る |
○ |
△ F5(デバッガ)では消える。「インタラクティブウィンドウで実行」なら残る |
○ |
| ブレークポイントで止めてステップ実行 |
○ F5 のまま |
○ F5(デバッガ) |
○ デバッグ実行(Ctrl+F5) |
| 上の 2 つを同じ操作でやる |
○ |
× 実行方法が別々 |
△ 実行とデバッグでキーが別 |
# %% のセル実行 |
○ |
○ インタラクティブウィンドウ |
○ |
| 選択範囲 / カーソル行を実行 |
○ |
○ |
○ |
| 変数の一覧 |
○ Workspace ビュー |
△ インタラクティブウィンドウとデバッガで別々のビュー |
○ 変数エクスプローラー |
| 配列 / DataFrame を表で見る |
○ Variable Editor |
○ データビューアー |
○ |
| 表で選んだ範囲をそのままプロット |
○ |
× |
△ 変数単位ならプロットできる |
| 3 次元以上の配列を表で見る |
○ 軸ごとに行 / 列 / 固定を選べる |
△ スライスを指定して 2 次元で見る |
△ 軸と番号を選んで 2 次元で見る |
| グラフを IDE の中に表示 |
○ Figure タブ(拡大・移動可、履歴あり) |
△ インタラクティブウィンドウでは画像で表示。F5 では別ウィンドウが開いて処理が止まる |
○ プロットペイン(画像、履歴あり) |
| エラーが起きた行を再実行せずに調べる |
○ ステータスバーをクリック |
△ 最初からデバッガで実行していれば止まる |
○ %debug
|
| スクリプトに引数を渡す |
○ コマンドから設定、履歴あり |
△ launch.json に書く |
○ ファイルごとの実行設定 |
| 設定ファイルなしで使い始められる |
○ |
△ 引数などは launch.json が必要 |
○ |
| 停止中にマウスホバーで値を見る |
○ |
○ |
○ |
| ライブラリの内部までステップイン |
× 標準ライブラリ・IPython・matplotlib には入らない |
○ 設定で可 |
○ |
ショートカット一覧
実行
| キー |
動作 |
| F5 |
実行(ブレークポイントがあれば止まる) |
| Ctrl+F5 |
ブレークポイントを無視して実行 |
| Alt+F5 |
実行し、エラーが出たらその行で止まる |
| Ctrl+Alt+F5 |
新しいセッションで実行 |
| Ctrl+Shift+F5 |
空のセッションを新しく作る |
セル・行の実行
| キー |
動作 |
| Ctrl+Enter |
カーソルのあるセル(# %% で区切った範囲)を実行 |
| Shift+Enter |
セルを実行して次のセルへ移動 |
| Ctrl+Shift+Enter |
選択範囲を実行(選択がなければカーソル行)。停止中も使える |
停止中(ブレークポイントで止まっている間)
| キー |
動作 |
| F5 |
続行 |
| F10 |
ステップオーバー |
| F11 |
ステップイン |
| Shift+F11 |
ステップアウト |
| Shift+F5 |
デバッガを抜けてプロンプトへ戻る |
Figure タブ
| キー |
動作 |
| Ctrl+C |
グラフを画像としてコピー |
Variable Editor
| キー |
動作 |
| Shift+Space |
行全体を選択 |
| Ctrl+Space |
列全体を選択 |
| Ctrl+クリック(列見出し) |
離れた列を追加で選択 |
| Ctrl+ホイール |
表示倍率を変更(50〜200%) |
| Alt+↑ / Alt+↓ |
多次元配列:固定している軸の番号を変更 |
| Alt+← / Alt+→ |
多次元配列:固定する軸を切り替え |
導入手順
必要なもの
| 項目 |
内容 |
| OS |
Windows(macOS / Linux は未検証) |
| VSCode |
1.85 以降 |
| Python |
3.9 以上 |
| Python パッケージ |
ipython / ipdb / matplotlib / tornado
|
パッケージが足りなければ初回の実行時に確認が出るので、[インストール]を押す。
手順
- VSCode の拡張機能ビュー(Ctrl+Shift+X)で「IPyDesk」を検索してインストール
- フォルダを開く(ファイル → フォルダーを開く)
- VSCode 右下で、使う Python 環境を選ぶ
-
.py ファイルを開いて F5
ターミナル「IPyDesk」が開いてスクリプトが実行される。
ファイル単体で開くとブレークポイントで止まらない。必ずフォルダを開いて、その中にスクリプトを置く。
まとめ
- 自作した拡張機能でSpyderからVSCodeへの移行がシンプルにできるように
- さらに便利に使うために随時機能追加していく予定。