作業環境を整える

DataSpell の Python インタープリター

DataSpell でノートブックまたは Python コードを実行するには、Python インタープリターに基づく仮想環境を少なくとも 1 つ設定する必要があります。Python インストールで利用可能なシステムインタープリターを使用できます。また、Virtualenv、pipenv、Poetry、conda 仮想環境を作成することもできます。仮想環境は、ベースインタープリターとインストールされたパッケージで構成されます。

DataSpell では、SSH または WSL (Windows のみ) を使用して、リモートが管理する Jupyter サーバー上でノートブックを実行するようにインタープリターを構成することもできます。

ワークスペースにディレクトリをアタッチするかプロジェクトを開くと、IDE は仮想環境を作成します。ほとんどの場合、Anaconda インストールに基づいた conda 環境が作成されます。マシン上の他の Python 環境を選択するか、新しい環境を作成することもできます。

構成された Python 環境をプレビューし、設定を変更し、パッケージを更新するには、Ctrl+Alt+S を押してプロジェクト <プロジェクト名> | Python インタープリターに移動します。

既存の仮想環境の構成

いつでも、Python インタープリターセレクターまたは設定のいずれかを使用して仮想環境を切り替えることができます。

Python インタープリターセレクターはステータスバーにあります。これは、Python インタープリターを切り替える最も便利で迅速な方法です。これをクリックして、対象のインタープリターを選択します。

IDE 設定で仮想環境を切り替える

Ctrl+Alt+S を押して設定を開き、プロジェクト <プロジェクト名> | Python インタープリターを選択します。
特定のプロジェクトまたはワークスペースディレクトリの Python インタープリターを変更する場合は、それを選択します。それ以外の場合は、ワークスペースを選択します。
ドロップダウンをクリックして、必要な Python インタープリターを選択します。
リストにない場合は、すべて表示をクリックします。次に、左側のペインで必要なインタープリターを選択し、OK をクリックします。
DataSpell が古い Python バージョンのサポートを停止すると、対応する Python インタープリターはサポートされないものとしてマークされます。

Anaconda CLI を使用して conda 環境を切り替える

ターミナルウィンドウで、<CONDA_HOME> /envs ディレクトリ (たとえば、/Users/jetbrains/.conda/envs) で ls コマンドを実行し、ターゲット環境を選択します。
Anaconda インストールの bin ディレクトリ (たとえば、anaconda3/bin) に移動します。
conda activate <env name> コマンド (例: conda activate my-conda-env) を実行します。

仮想環境を変更する

Ctrl+Alt+S を押して設定を開き、プロジェクト <プロジェクト名> | Python インタープリターを選択します。
利用可能なインタープリターのリストを展開し、すべて表示をクリックします。
インタープリターパスフィールドで Python 実行可能ファイルへのパスを変更できます。
この仮想環境を現在のプロジェクトに関連付けるチェックボックスを有効にすると、インタープリターは現在の DataSpell プロジェクトでのみ使用できます。
インタープリター名を変更するには、対象のインタープリターを選択してをクリックします。
名前フィールドで指定された Python インタープリター名が、使用可能なインタープリターのリストに表示されます。変更を適用するには、OK をクリックします。

仮想環境を削除する

プロジェクトの Python インタープリターが不要になった場合は、プロジェクト設定から削除できます。

以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト <プロジェクト名> | Python インタープリターを選択します。
- Python インタープリターセレクターをクリックして、インタープリターの設定を選択します。
利用可能なインタープリターのリストを展開し、すべて表示をクリックします。
削除するインタープリターを選択し、をクリックします。

新しい仮想環境の作成

ローカル仮想環境の構成

ローカル仮想環境を構成するには、次のいずれかの手順に従います。

virtualenv 環境を作成する

以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、ローカルインタープリターを追加するを選択します。
次のアクションは、新しい仮想環境を生成するか、既存の仮想環境を使用するかによって異なります。
新規 Virtualenv 環境
1. 環境タイプのリストから Virtualenv を選択します。
2. リストから基本インタープリターを選択するか、をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。
3. ロケーションフィールドに新しい仮想環境の場所を指定するか、をクリックしてファイルシステム内の場所を参照します。新しい仮想環境のディレクトリは空である必要があります。
4. マシン上のグローバル Python にインストールされているすべてのパッケージを、これから作成する仮想環境に追加する場合は、ベースインタープリターからパッケージを継承するチェックボックスを選択します。このチェックボックスは、virtualenv(英語) ツールの --system-site-packages オプションに対応しています。
5. DataSpell で Python インタープリターを作成するときにこの環境を再利用する場合は、すべてのプロジェクトで使用可能にするチェックボックスを選択します。
既存の仮想環境
- 環境タイプのリストから Python を選択します。
- リストから必要なインタープリターを選択します。
  必要なインタープリターがリストにない場合は、をクリックし、必要な Python 実行可能ファイル (たとえば、macOS の場合は venv/bin/python、Windows の場合は venv\Scripts\python.exe) を参照します。
選択した仮想環境は、現在のプロジェクトで再利用されます。
タスクを完了するには、OK をクリックします。

詳細は、仮想環境を構成するを参照してください。

conda 環境を作成する

Anaconda(英語) または Miniconda(英語) がコンピューターにダウンロードされインストールされていること、およびその実行可能ファイルへのパスを認識していることを確認します。
詳細については、インストール手順(英語)を参照してください。
以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、ローカルインタープリターを追加するを選択します。
次のアクションは、新しい conda 環境を作成するか、既存の環境を使用するかによって異なります。
新しい conda 環境
1. 環境タイプのリストから Conda を選択します。
2. リストから Python のバージョンを選択します。
3. 環境名を指定します。
4. DataSpell は conda のインストールを検出します。
  DataSpell がインストールを自動的に検出しなかった場合は、conda 実行可能ファイルの場所を指定するか、をクリックして参照します。
既存の conda 環境
1. 環境タイプのリストから Conda を選択します。
2. DataSpell は conda のインストールを検出します。
  DataSpell がインストールを自動的に検出しなかった場合は、conda 実行可能ファイルの場所を指定するか、をクリックして参照します。
3. リストから環境を選択します。
選択した conda 環境は、現在のプロジェクトで再利用されます。
タスクを完了するには、OK をクリックします。

詳細は、conda 仮想環境を構成するを参照してください。

pipenv 環境を作成する

以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、ローカルインタープリターを追加するを選択します。
環境タイプのリストから Pipenv を選択します。
リストから基本インタープリターを選択するか、をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。
ベースバイナリディレクトリを PATH 環境変数に追加した場合、追加のオプションを設定する必要はありません。pipenv 実行可能ファイルへのパスは自動検出されます。
DataSpell が pipenv 実行可能ファイルを検出しない場合は、pip 経由で pipenv をインストールするをクリックして、DataSpell が自動的にインストールできるようにします。
または、pipenv のインストール手順に従って実行可能パスを検出し、それをダイアログで指定します。
タスクを完了するには、OK をクリックします。

pipenv 仮想環境を Python インタープリターとして設定すると、利用可能なすべてのパッケージが Pipfile で定義されたソースから追加されます。パッケージは、pip ではなく pipenv を通じてパッケージリストにインストール、削除、更新されます。

詳細は、Pipenv 環境を構成するを参照してください。

Poetry 環境を作成する

以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、ローカルインタープリターを追加するを選択します。
次のアクションは、新しい Poetry 環境を作成するか、既存の環境を使用するかによって異なります。
新しい Poetry 環境
1. 環境タイプのリストから Poetry を選択します。
2. リストから基本インタープリターを選択するか、をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。
既存の Poetry 環境
1. 環境タイプのリストから Poetry を選択します。
2. DataSpell は Poetry のインストールを検出します。
  DataSpell がインストールを自動的に検出しなかった場合は、実行可能ファイルの場所を指定するか、をクリックして参照します。
3. リストから環境を選択します。
選択した Poetry 環境は、現在のプロジェクトで再利用されます。
タスクを完了するには、OK をクリックします。

詳細は、Poetry 環境を構成するを参照してください。

リモート仮想環境の構成

リモート Python インタープリターを追加すると、まず DataSpell ヘルパーがリモートホストにコピーされます。DataSpell ヘルパーは、パッケージングタスク、デバッガー、テスト、その他の DataSpell 機能をリモートで実行するために必要です。

次に、バイナリライブラリのスケルトンが生成され、ローカルにコピーされます。また、すべての Python ライブラリソースは、リモートホスト上の Python パスから収集され、生成されたスケルトンと共にローカルにコピーされます。解決と完了が正しく機能するためには、スケルトンとすべての Python ライブラリソースをローカルに保存する必要があります。

DataSpell は、リモートが実行されるたびにリモートヘルパーのバージョンをチェックするため、DataSpell バージョンを更新すると、新しいヘルパーが自動的にアップロードされるため、リモートインタープリターを再作成する必要はありません。

WSL インタープリターを構成する

以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、WSL についてを選択します。
DataSpell がマシン上で Linux を検出し、イントロスペクションを完了するまで待ちます。続行するには次へをクリックします。
ダイアログの左側のペインで、作成する WSL インタープリターのタイプ ( 仮想環境、Conda 環境、またはシステムインタープリター ) を選択します。
システムインタープリターの場合は、選択した Linux ディストリビューション内の Python 実行可能ファイルへのパスを指定するだけです。
仮想環境および conda 環境の場合、選択した Linux ディストリビューション内の既存の環境の Python 実行可能ファイルへのパスを指定するか、指定した Python に基づいて新しい環境を作成できます。

完了すると、新しいインタープリターがプロジェクトに追加され、デフォルトの mnt マッピングが設定されます。

詳細は、WSL を使用してインタープリターを構成するを参照してください。

SSH を使用してインタープリターを構成する

DataSpell は ssh-sessions を介してリモートインタープリターを実行するため、リモートホストで SSH サーバーが実行されていることを確認してください。
以下のいずれか 1 つを実行します:
- Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。
- Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
- アタッチされたディレクトリのコンテキストメニューで、インタープリターを選択します。
利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックし、SSH の場合を選択します。
オプションを選択して新しい SSH 接続を作成し、サーバー情報 (ホスト、ポート、ユーザー名) を指定します。
または、既存を選択して、リストから使用可能な SSH 構成を選択することもできます。新しい SSH 構成を作成するには、次の手順に従います。
SSH 構成の作成
- 構成のリストの横にあるをクリックします。
- をクリックし、このプロジェクトでのみ表示するチェックボックスを無効にして、必要なフィールドに入力します。
- 完了すると、新しく作成された SSH 設定が利用可能な設定のリストに表示されます。「次へ」をクリックして続行してください。
次のダイアログウィンドウで、ターゲットサーバーに接続するための認証の詳細を入力します。
パスワードまたはキーペア (OpenSSH または PuTTY) を選択し、パスワードまたはパスフレーズを入力します。キーペア (OpenSSH または PuTTY) を選択した場合は、以下を指定します。
- 秘密鍵 : 秘密鍵を含むファイルの場所
- パスフレーズ : パスワードと同様に、秘密鍵(英語)を暗号化する(英語)に役立ちます。
続行するには次へをクリックします。
DataSpell が SSH サーバーのイントロスペクションを完了するまで待ちます。
次のダイアログで、SSH サーバーで構成する Python 環境のタイプを選択します。
新しい仮想環境またはコンダ環境を作成したり、既存の環境を選択したり、システムインタープリターを使用したりできます。
- マシン上のグローバル Python にインストールされているすべてのパッケージを、これから作成する仮想環境に追加する場合は、ベースインタープリターからパッケージを継承するチェックボックスを選択します。このチェックボックスは、virtualenv(英語) ツールの --system-site-packages オプションに対応しています。
- SSH サーバー上で Python コードを sudo ユーザーとして実行する必要がある場合は、sudo 経由で root 権限でコードを実行するチェックボックスを有効にします。
- DataSpell は、リモートホストとファイルを自動的に同期できます。そのためには、リモートホストにファイルを自動的にアップロードするチェックボックスをオンにし、ルートディレクトリで同期するルートディレクトリを指定します。ディレクトリが存在しない場合は作成されます。
  このオプションを有効にすると、SSH インタープリターを使用するように設定された接続ディレクトリがリモートホストのルートディレクトリにアップロードされます。その後、以下のいずれかのイベントが発生すると同期されます。
  - ファイルへの変更の適用
  - このインタープリターに切り替えます
  - IDE の起動
- 同期が必要なファイルを除外することもできます。そのためには、除外対象パスフィールドに glob パターンを指定します。デフォルトでは、このフィールドにはリモートインタープリターの実行に不要なディレクトリとファイルのパターンがいくつか含まれています。
作成をクリックして、インタープリターの追加を完了します。

詳細は、SSH を使用してインタープリターを構成するを参照してください。

パッケージを管理する

同じ Anaconda インストールに基づいてさまざまな Conda 環境を作成する理由は明らかです。環境ごとに特定のパッケージをインストールし、特定のタスクやプロジェクトに使用できるからです。

pip と Conda パッケージマネージャーを使用して、環境にパッケージをインストールできます。IDE UI の環境設定またはターミナルウィンドウから実行できます。

環境設定を使用してパッケージをインストールする

Python インタープリターセレクターで、インタープリターの設定を選択します。
Python インタープリターリストからターゲット環境を選択します。
新しいパッケージを追加するには、+ をクリックします。Conda パッケージマネージャーボタン（）をクリックすると、Conda リポジトリのパッケージを管理できます。クリックしない場合は、DataSpell は pip を使用します。
検索フィールドにパッケージ名を入力し、対象のパッケージを見つけます。必要に応じてパッケージのバージョンを指定してください。その後、インストールを押してください。
タスク完了のウィンドウを閉じます。必要に応じて、リポジトリの管理ボタンを押して、パッケージをインストールするカスタムリポジトリを追加します。

ターミナルウィンドウでパッケージをインストールする

ターミナルウィンドウを開きます。
pip からパッケージをインストールするには、pip install <package name> (たとえば、pip install plotly) を実行します。
Conda リポジトリからパッケージをインストールするには:
- Anaconda インストールの bin ディレクトリに移動します (たとえば、anaconda3/bin)
- 次のコマンドを実行します: conda install <package name> (たとえば、conda install tensorflow)。