Visual Studio CodeでJupyter Notebookを使うための設定方法を解説します。
この設定を行えば、両者の良いとこ取りで快適な作業ができるようになります。
Python の開発環境として対話型のJupyterを好んで利用されている方も多いと思います。
ただ、JupyterではVScodeのような便利な拡張機能が使えず、デバッグなどもやりにくい点がある等ストレスを感じることもあると思います。また、両者を場合によって使い分けている事も多いと思います。
そのような場合は、VSCodeでJupyter Notebookを使える拡張機能を導入することで、対話型のVScode環境を手に入れることができるため、切り替えの手間も省けて、ストレス無く作業することが可能になります。
VSCodeのインストール方法やカスタマイズはVSCode利用ガイドをご覧ください。
仮想環境を作成する
ここではJupyterを実行するための仮想環境を作成して、この環境を利用することにします。
※仮想環境は作成せずに、グローバル環境や構築済みの環境を使う場合は飛ばして下さい。
まずメニューから ターミナル＞新しいターミナル を選択して、ターミナルウィンドウを開きます。
ターミナルに仮想環境を作成するためのコマンドを実行します。
1 | python3 -m venv 仮想環境の名称 |
ここでは仮想環境の名称を「jupyter_env」として進めます。
これで仮想環境が作成されます。
仮想環境を有効にします。
VSCodeのターミナルはPowerShellのため、仮想環境を有効にするには「Activate.ps1」を実行します。
ただしPowerShellからPS1スクリプトを実行するためには権限設定が必要なため、以下のコマンドを先に実行します。
1 | Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force |
権限設定後に以下のコマンドを実行します。（jupyter_env は環境に合わせて変更してください）
1 | jupyter_env/Scripts/Activate.ps1 |
コマンドラインの頭に（仮想環境の名称）と表示されれば仮想環境が有効になっています。
Jupyter拡張機能のインストール
VScodeのJupyter拡張機能をインストールします。
サイドバーから拡張機能を開き、検索窓にjupyterと入力します。
表示されるJupyter拡張機能をインストールします。（関連機能も自動でインストールされます）
インストールが完了した状態です。
Jupyterの起動
インストールが完了したら、Jupyterを実行します。
メニューの表示＞コマンドパレットをクリックします。
コマンドの候補から「Jupyter: インタープリターを選択してJupyter Serverを開始する」を選択します。
利用できるインタープリターのリストが表示されるため、作成した仮想環境をインタープリターとして選択します。
これでJupyterを利用する準備は完了です。
ノートブックを作成する
メニュー＞ファイル＞新しいファイル をクリックします。
ファイル種類の選択でJupyter Notebookを選択します。
これでノートブックが作成されます。
VSCodeの拡張機能が利用できる状態で対話環境で開発が可能です。
もちろんIntelliSenseの補完機能も利用できるため、効率的に作業できます。
コードの実行
セル単位でコードを実行するには、セルの左にある「▶」をクリックします。
すべてのコードを実行するには、「すべてを実行」をクリックします。
アクティブセル以下を実行する場合は、セル右上の「▶↓（セルと以下の実行）」をクリックします。
セルを追加するには、追加したい側のセル・出力結果の境界にマウスを持っていくと「＋コード」「＋マークダウン」が表示されるため、そのボタンをクリックします。
デバッグ
コードをデバッグする方法は2通りあります。
1行ずつ実行する方法と、ブレークポイントを設定する方法です。
1行ずつ実行
まず1行ずつ実行する方法です。
セル右上の「次の行を実行」ボタンをクリック、もしくは「F10」キーを押します。
デバッグモードで実行され、ボタン（F10）を押す毎に1行ずつ実行できます。
デバッグモードで実行するとサイドバーにデバッグウィンドウが表示され、変数の状態を確認できます。また、エディタの下にも変数パネル（JUPYTER VARIABLES）が表示されます。
ブレークポイントを設定する
次にブレークポイントを設定する方法です。
VSCodeでデバッグを行う方法と同様に、行番号の左側をクリックしてブレークポイントを設定します。
・参考記事：Visual Studio Codeでプログラム作成・実行・デバッグを行う
デバッグモードで実行するために、セル左の「▶」の横の「∨」をクリックして、［デバッグ］セルをクリックします。
ブレークポイントで停止すると、画面上部にデバッグツールバーが表示され、VSCodeのデバッグモードとして操作可能です。
停止する場合は、セル左側の「□」ボタン（セルの実行を停止する）か、上部の「□割り込み」ボタンをクリックします。
Visual Studio CodeでJupyter Notebookを使うための設定方法を解説しました。
その他の便利な拡張機能はこちらの記事で紹介しています。
・Visual Studio Code おすすめ拡張機能