IntelliJ IDEA 2024.2 ヘルプ

Python SDK を設定する

IntelliJ IDEA で Python スクリプトを開発するには、Python(英語) をダウンロードしてインストールし、少なくとも 1 つの Python SDK を構成します。Python SDK は、Python プロジェクトの Python インタープリターとして指定できます。

IntelliJ IDEA は以下をサポートします:

使用可能な SDK のリストを表示するには、メインメニュー Ctrl+Alt+Shift+S からファイル | プロジェクト構造を選択します。Python SDK は、次のレベルで構成できます。

選択した SDK は、すべての Python プロジェクトに使用できます。

Show available Python SDKs

選択した SDK は、現在のプロジェクトとそのモジュールすべてに使用されます。

Change a Python SDK

選択した SDK が現在のプロジェクトモジュールに使用されます。

Manage Python SDK modules

それらを簡単に区別するには、名前フィールドに異なる名前を入力します。SDK 構成の詳細については、「SDK」を参照してください。

Python SDK を追加するには、Python インタープリターを構成する必要があります。レベルに関係なく、ローカルまたはリモート Python インタープリターを構成できます。

ローカル Python インタープリターを構成する

ローカル Python インタープリターを構成するには、次のいずれかの手順に従います。

システムインタープリターを設定する

  1. Python(英語) をコンピューターにダウンロードしてインストールしたことを確認してください。

    Microsoft ストアから Windows に Python をインストールする

    Windows を使用している場合は、Microsoft ストアから Python をダウンロードして、Python インタープリターとしてインストールできます。Python アプリケーションが Microsoft ストアからダウンロードされると、Python 実行可能ファイルのリストで利用可能になります。

    Microsoft ストアのインストールから追加されたインタープリターにはいくつかの制限があります。Microsoft ストアアプリの制限により、Python スクリプトは TEMP やレジストリなどの共有の場所へのフル書き込みアクセス権を持っていない場合があります。

  2. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  3. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  4. Python インタープリターの追加ダイアログの左側のペインでシステムインタープリターを選択します。

    Adding a system interpreter
  5. インタープリター」ドロップダウンで、システムにインストールされている Python インタープリターの 1 つを選択するか、「 the Browse button 」をクリックして、表示される Python インタープリターの選択ダイアログで目的の Python 実行可能ファイルを選択します。

    Selecting the Python executable

    システムインタープリターのパッケージをインストール、削除、アップグレードするには管理者権限が必要です。インテンションアクションを介してインタープリターパッケージをインストールしようとすると、次のエラーメッセージが表示されることがあります。

    System Interpreter warning message

    プロンプトが表示されたら、プロジェクトに仮想環境を使用することを検討してください。

  6. タスクを完了するには、OK をクリックします。

詳細については、PyCharm のドキュメントを参照してください。

virtualenv 環境を作成する

  1. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  2. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  3. Python インタープリターの追加ダイアログの左側のペインで Virtualenv 環境を選択します。

    Creating a virtual environment
  4. 次のアクションは、新しい仮想環境を作成するか、既存の仮想環境を使用するかによって異なります。

    新しい仮想環境
    • ロケーションフィールドに新しい仮想環境の場所を指定するか、Virtual environment location をクリックしてファイルシステム内の場所を参照します。新しい仮想環境のディレクトリは空である必要があります。

    • リストから基本インタープリターを選択するか、Choose the base interpreter をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。

    • マシン上のグローバル Python にインストールされているすべてのパッケージを、これから作成する仮想環境に追加する場合は、グローバル site-packages を継承するチェックボックスを選択します。このチェックボックスは、virtualenv(英語) ツールの --system-site-packages オプションに対応しています。

    • IntelliJ IDEA で Python インタープリターを作成するときにこの環境を再利用する場合は、すべてのプロジェクトで使用可能にするチェックボックスを選択します。

    既存の仮想環境
    • リストから目的のインタープリターを選択します。

    • 目的のインタープリターがリストにない場合は、 をクリックし、目的の Python 実行可能ファイル (たとえば、macOS の venv/bin/python または Windows の venv\Scripts\python.exe) を参照します。

    選択した仮想環境は、現在のプロジェクトで再利用されます。

  5. タスクを完了するには、OK をクリックします。

詳細については、PyCharm のドキュメントを参照してください。

conda 環境を作成する

  1. Anaconda(英語) または Miniconda(英語) がダウンロードされてコンピューターにインストールされていること、およびその実行可能ファイルへのパスがわかっていることを確認してください。

    詳細については、インストール手順(英語)を参照してください。

  2. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  3. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  4. Python インタープリターの追加ダイアログの左側のペインで Conda 環境を選択します。

    New Conda environment
  5. 次のアクションは、新しい conda 環境を作成するか、既存の環境を使用するかによって異なります。

    新しい conda 環境
    • ロケーションフィールドに新しい conda 環境の場所を指定するか、Conda environment location をクリックしてファイルシステム内の目的の場所を参照します。新しい conda 環境のディレクトリは空にする必要があります。

    • リストから Python のバージョンを選択します。

    • 通常、IntelliJ IDEA は conda のインストールを検出します。

      それ以外の場合は、conda 実行可能ファイルの場所を指定するか、Conda executable location をクリックして参照します。

    • IntelliJ IDEA で Python インタープリターを作成するときにこの環境を再利用する場合は、すべてのプロジェクトで使用可能にするチェックボックスを選択します。

    既存の conda 環境
    • リストから環境を選択します。

    • 目的のインタープリターがリストにない場合は、 をクリックし、以前に構成された conda 環境内で Python 実行可能ファイルを参照します。

    • 必要に応じて、conda 実行可能ファイルの場所を指定するか、 をクリックして参照します。

    • IntelliJ IDEA で Python インタープリターを作成するときにこの環境を再利用する場合は、すべてのプロジェクトで使用可能にするチェックボックスを選択します。

    選択した conda 環境は、現在のプロジェクトで再利用されます。

  6. タスクを完了するには、OK をクリックします。

詳細については、PyCharm のドキュメントを参照してください。

pipenv 環境を作成する

  1. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  2. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  3. Python インタープリターの追加ダイアログの左側のペインで Pipenv 環境を選択します。

    Adding a Pipenv environment
  4. リストから基本インタープリターを選択するか、Choose the base interpreter をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。

  5. プロジェクトに Pipfile が含まれている場合は、Pipfile からパッケージをインストールするチェックボックスを有効または無効にすることで、プロジェクトにリストされているパッケージをインストールするかどうかを選択できます。デフォルトでは、チェックボックスは有効になっています。

  6. ベースバイナリディレクトリを PATH 環境変数に追加した場合、追加のオプションを設定する必要はありません。pipenv 実行可能ファイルへのパスは自動検出されます。

    pipenv 実行ファイルが見つからない場合は、pipenv のインストール手順に従って実行ファイルパスを見つけ、ダイアログで指定します。

  7. タスクを完了するには、OK をクリックします。

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

詳細については、PyCharm のドキュメントを参照してください。

Poetry 環境を作成する

  1. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  2. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  3. Python インタープリターの追加ダイアログの左側のペインで Poetry 環境を選択します。

    creating a poetry environment
  4. 次のアクションは、新しい Poetry 環境を作成するか、既存の環境を使用するかによって異なります。

    新しい Poetry 環境
    • Poetry 環境を選択します。

    • リストから基本インタープリターを選択するか、Choose the base interpreter をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。

    • プロジェクトに pyproject.toml が含まれている場合は、pyproject.toml からパッケージをインストールするチェックボックスを有効または無効にすることで、プロジェクトにリストされているパッケージをインストールするかどうかを選択できます。デフォルトでは、チェックボックスは有効になっています。

    • IntelliJ IDEA が詩の実行可能ファイルを検出しない場合は、ダイアログで次のパスを指定し、jetbrains をユーザー名に置き換えます。

      /Users/jetbrains/Library/Application Support/pypoetry/venv/bin/poetry
      C:\Users\jetbrains\AppData\Roaming\pypoetry\venv\Scripts\poetry.exe
      /home/jetbrains/.local/bin/poetry
    既存の Poetry 環境
    • プロジェクトディレクトリに pyproject.toml ファイルが含まれていることを確認します。

    • 既存の環境を選択します。次に、インタープリターリストを展開し、目的のインタープリターを選択します。

    • 目的のインタープリターがリストにない場合は、 をクリックし、以前に構成した Poetry 環境内で Python 実行可能ファイルを参照します。

    選択した Poetry 環境は、現在のプロジェクトで再利用されます。

  5. タスクを完了するには、OK をクリックします。

詳細については、PyCharm のドキュメントを参照してください。

リモート Python インタープリターの構成

リモート Python インタープリターを構成するには:

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

  1. 画面の左下隅にある Windows ボタンをクリックし、System Information の入力を開始します。システムが WSL でうまく動作するように、Windows を最新の使用可能なバージョンにアップグレードしてください。

  2. Windows Subsystem for Linux をインストールし、WSL インストールガイドの説明に従って Linux ディストリビューションを初期化します。

  3. Linux ディストリビューションに rsync が付属していない場合は、インストールする必要があります。

    sudo apt install rsync

    sudo pacman -S rsync

  4. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  5. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  6. Python インタープリターの追加ダイアログの左側のペインで WSL を選択します。

  7. 必要な Python インタープリターを含む Linux ディストリビューションを選択します。

  8. Python インタープリターパスフィールドで、Python 実行可能ファイルへのパスを指定します。デフォルトを受け入れるか、別のパスを入力するか、the Browse button をクリックして参照します。

    Add a remote interpreter using WSL
  9. OK をクリックします。

    構成されたリモートインタープリターがリストに追加されます。

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

  1. 次の前提条件が満たされていることを確認します (IntelliJ IDEA の外部)。

    • サポートされている Vagrant プロバイダー(英語)のいずれかがコンピューターにインストールされています。

    • Vagrant(英語) がコンピューターにインストールされ、必要なすべてのインフラストラクチャが作成されます。

    • 次の実行可能ファイルの親フォルダーがシステム PATH 変数に追加されました。

      • Vagrant から vagrant.bat または vagrant を選択してください。これはインストーラによって自動的に行われます。

      • Oracle VirtualBox インストールからの VBoxManage.exe または VBoxManage

    • 必要な仮想ボックスが作成されます。

  2. Vagrant プラグインがインストールされ、有効になっていることを確認します。

  3. Vagrant を適切に起動して起動していることを確認してください。基本的には、ターミナルウィンドウを開いて次のコマンドを実行する必要があります。

    $ vagrant init ubuntu/trusty64

    および

    $ vagrant up

    詳細は、Vagrant のドキュメント(英語)を参照してください。

  4. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  5. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  6. Python インタープリターの追加ダイアログの左側のペインで Vagrant を選択します。

  7. Python インタープリターパスフィールドで、Python 実行可能ファイルへのパスを指定します。デフォルトを受け入れるか、別のパスを入力するか、the Browse button をクリックして参照します。

    Add a remote interpreter using Vagrant
  8. OK をクリックします。

    構成されたリモートインタープリターがリストに追加されます。

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

  1. IntelliJ IDEA は ssh-sessions を介してリモートインタープリターを実行するため、リモートホストで SSH サーバーが実行されていることを確認してください。

  2. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  3. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  4. 新規サーバー構成を選択し、サーバー情報 (ホスト、ポート、ユーザー名) を指定します。

    adding an interpreter via SSH

    または、既存サーバー構成を選択して、使用可能なデプロイ構成をリストから選択することもできます。

    existing configurations

    必要に応じて、the Browse button をクリックして、選択したデプロイ構成の接続設定マッピング除外対象パスを確認します。インタープリターの設定を続行するには、次へをクリックします。

  5. 次のダイアログウィンドウで、ターゲットサーバーに接続するための認証の詳細を入力します。

    specifying authentication details

    パスワードまたはキーペア (OpenSSH または PuTTY) を選択し、パスワードまたはパスフレーズを入力します。キーペア (OpenSSH または PuTTY) を選択した場合は、以下を指定します。

    続行するには次へをクリックします。

  6. 次のダイアログウィンドウで、目的の Python インタープリターへのパスを確認します。デフォルトを受け入れることも、別の値を指定することもできます。ローカルプロジェクトとサーバー間のパスマッピングを構成する必要があります。これを行うには、フォルダーの同期フィールドの横にある the Browse button をクリックし、ローカルプロジェクトフォルダーへのパスとリモートサーバー上のフォルダーへのパスを入力します。

    Setting SSH mappings

    チェックボックスを選択して、リモートサーバーへのローカル変更の自動アップロードを有効にすることもできます。

  7. OK をクリックします。

    構成されたリモートインタープリターがリストに追加されます。

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

  1. 次の前提条件が満たされていることを確認してください。

    • Docker のドキュメント(英語)に従って、Docker がインストールされます。

    • 安定したインターネット接続があり、IntelliJ IDEA が busybox:latest (BusyBox Docker 公式イメージ(英語)の最新バージョン) をダウンロードして実行できます。Docker を使用してインタープリターを正常に構成したら、オフラインにすることができます。

    Docker ベースのプロジェクトインタープリターに Python パッケージをインストールできないことに注意してください。

  2. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  3. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  4. Python インタープリターの追加ダイアログの左側のペインで Docker を選択します。

    Adding a Python interpreter using Docker
  5. Docker サーバードロップダウンで既存の Docker 構成を選択します。

    または、新規をクリックして次の手順を実行し、新しい Docker 構成を作成します。

    Docker 構成を作成する

    The Add button をクリックして Docker 構成を追加し、Docker デーモンへの接続方法を指定します。

    接続設定は、Docker のバージョンとオペレーティングシステムによって異なります。詳細については、Docker 接続設定を参照してください。

    ダイアログの下部に接続完了メッセージが表示されます。

    The Docker connection settings for interpreter

    Windows で Docker または macOS を使用するときに、Docker デーモンを実行している仮想マシンにローカルパスをマッピングする方法の詳細については、Windows および macOS ホストの仮想マシンパスマッピングを参照してください。マッピングされたローカルパスの外部にあるディレクトリに対してボリュームやバインドマウントを使用することはできません。

    このテーブルは、Docker がネイティブに実行され、コンテナーに任意のディレクトリをマウントできる Linux ホストでは使用できません。

  6. イメージと Python 実行可能ファイルへのパスを指定します。

    Configuring a Python interpreter using Docker
  7. OK をクリックします。

    構成されたリモートインタープリターがリストに追加されます。

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

  1. 次の前提条件が満たされていることを確認してください。

    • Docker のドキュメント(英語)に従って、Docker がインストールされます。

    • 安定したインターネット接続があり、IntelliJ IDEA が busybox:latest (BusyBox Docker 公式イメージ(英語)の最新バージョン) をダウンロードして実行できます。Docker を使用してインタープリターを正常に構成したら、オフラインにすることができます。

    Docker ベースのプロジェクトインタープリターに Python パッケージをインストールできないことに注意してください。

  2. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  3. プロジェクト構造ダイアログで、プラットフォーム設定セクションの SDK を選択し、Add a new SDK をクリックして、ポップアップメニューから Python SDK を追加するを選択します。

    Adding a new Python SDK
  4. Python インタープリターの追加ダイアログの左側のペインで Docker Compose を選択します。

    Adding a Python interpreter using Docker Compose
  5. サーバードロップダウンで Docker 構成を選択します。

  6. 構成ファイルdocker-compose.yml ファイルを指定し、サービスを選択します。

    Configuring a Python interpreter using Docker Compose

    必要に応じて、環境変数(英語)を指定してプロジェクト名を作成する(英語)を編集します。

  7. 最後に、Python 実行可能ファイルへのパスを指定します。

    Configuring a Python interpreter using Docker Compose
  8. OK をクリックします。

    構成されたリモートインタープリターがリストに追加されます。

リモート Python インタープリターの詳細については、PyCharm のドキュメントを参照してください。

Python インタープリターを削除する

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

  1. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  2. プロジェクト構造ダイアログで、プラットフォーム設定SDK ノードをクリックします。

  3. 削除するインタープリターを選択し、Remove Interpreter をクリックします。

    Remove a Python interpreter

インタープリターのパスを管理する

IntelliJ IDEA を使用すると、選択したインタープリターへのパスを追加できます。これらのパスは環境変数 PYTHONPATH に追加されます。IntelliJ IDEA はこれらのパスをインデックス化し、コードのオブジェクト (パッケージのインポートなど) を解決します。

インタープリターのパスを表示

  1. ファイル | プロジェクト構造に移動するか、Ctrl+Alt+Shift+S を押します。

  2. プロジェクト構造ダイアログで、プラットフォーム設定SDK ノードをクリックします。

  3. インタープリターを選択します。

  4. インタープリターパスをクラスパスタブで表示します。

    Classpath tab

インタープリターパスを追加する

  1. クラスパスタブで、Add をクリックします。

  2. 開いたダイアログでパスを指定します。特定の Python バージョンへのパスを追加するには、https://www.python.org/(英語) からダウンロードしてマシンにインストールする必要があることに注意してください。

インタープリターパスを削除する

  1. クラスパスタブで削除するパスを選択します。

  2. Remove をクリックします。

関連ページ:

プラグインのインストール

プラグインは IntelliJ IDEA のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains...

Python プロジェクトを作成する

に移動するか、ウェルカム画面で新規プロジェクトをクリックします。新規プロジェクトダイアログで、プロジェクトタイプとして Python を選択します。構成された Python 環境がある場合は、リストから 1 つ選択するか、インタープリターの追加を選択してターゲット環境へのパスを指定します。使用可能な環境がない場合は、新規ボタンを選択し、環境タイプを選択します。ロケーションフィールドに新しい仮想環境の場所を指定するか、をクリックしてファイルシステム内の場所を参照します。新しい仮想環境のディレクトリは空...

SDK

ソフトウェア開発キットまたは SDK は、特定のソフトウェアフレームワーク用のアプリケーションを開発するために必要なツールのコレクションです。例: Java でアプリケーションを開発するには、Java SDK(JDK) が必要です。SDK には、バイナリ、バイナリのソースコード、ソースコードのドキュメントが含まれています。JDK ビルドにはアノテーションも含まれています。一般に、SDK はグローバルです。つまり、1 つの SDK を複数のプロジェクトやモジュールで使用できます。新しいプロジェクトを作...

システムインタープリターを設定する

PyCharm で Python コードを使用するには、少なくとも 1 つのインタープリターを構成する必要があります。システムインタープリターは、Python インストールに付属するものです。すべての Python スクリプトにのみ使用するか、Python 仮想環境の基本インタープリターとして使用できます。システムインタープリターを設定する Python をコンピューターにダウンロードしてインストールしたことを確認してください。Microsoft ストアから Windows に Python をインス...

Python 言語サポート

IntelliJ IDEA で Python スクリプトを開発するには:Python をダウンロードしてインストールします。少なくとも 1 つの Python SDK を構成します。Windows ユーザーの場合、Windows 用 Python をインストールすることをお勧めします。サポートされるバージョン:Python 2: バージョン 2.7、Python 3: バージョン 3.6 からバージョン 3.12 まで、次の機能は、Python 3.12 サポートの一部として使用できます。PEP 69...

仮想環境を構成する

PyCharm を使用すると、virtualenv ツールを使用して、プロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenv ツールは PyCharm にバンドルされているため、ユーザーはインストールする必要はありません。virtualenv 環境を作成する以下のいずれか 1 つを実行します:Python インタープリターセレクターをクリックして、新しいインタープ...