PyCharm 2020.3 ヘルプ

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

PyCharm の Python インタープリター

PyCharm で Python コードを使用するには、少なくとも 1 つのインタープリターを構成する必要があります。Python インタープリターを 1 つだけ使用することに限定されません。いくつかを実装することができます。その際、特定のプロジェクトに使用するインタープリターを選択します。

Python インタープリターを構成するときは、システム内の Python 実行可能ファイルへのパスを指定する必要があります。Python インタープリターを構成する前に、Python をダウンロード(英語)してシステムにインストールし、それへのパスを認識していることを確認する必要があります。同じ Python 実行可能ファイルに基づいて複数の Python インタープリターを作成できます。これは、さまざまなタイプのアプリケーションを開発するためにさまざまな仮想環境を作成する必要がある場合に役立ちます。例:Python 3.6 に基づいて 1 つの仮想環境を作成して Django アプリケーションを開発し、同じ Python3.6 に基づいて別の仮想環境を作成して科学ライブラリと連携させることができます。

以下を構成できます。

PyCharm Professional を使用すると、リモート環境で Python コードを実行するようにインタープリターを構成することもできます。

Python インタープリターは以下のレベルで設定できます:

  • 現在のプロジェクト : 現在選択されている Python インタープリターが現在のプロジェクトに使用されます。

    このレベルでの Python インタープリターの構成について、以下で説明します。新しいインタープリターを作成するか、既存のインター プリターのいずれかを使用できます。

  • 新規プロジェクト : 選択した Python インタープリターがデフォルトのプロジェクトの代わりに新しいプロジェクトに使用されます。

    セクション Python プロジェクトを作成するを参照してください。

新しい Python インタープリターの作成

現在のプロジェクトに新しいインタープリターを追加するには:

  1. Ctrl+Alt+S を押してプロジェクト設定 / 環境設定を開きます。

  2. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、プロジェクト <プロジェクト名> | Python インタープリターを選択します。The Configure project interpreterアイコンをクリックして、追加を選択します。

    Selecting the Add command to create a new Python interpreter
  3. 追加するインタープリタータイプを選択して、特定の設定を実行します。

    1. Python インタープリターの追加ダイアログの左側のペインで Virtualenv 環境を選択します。以下のアクションは、仮想環境が以前に存在していたかどうかによって異なります。

      creating a virtual environment

      新しい環境が選択されている場合:

      1. テキストフィールドに新しい仮想環境の場所を指定するか、Virtual environment locationをクリックしてファイルシステム内の場所を探します。新しい仮想環境を配置するディレクトリは空でなければならないことに注意してください。

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

        PyCharm がマシン上で Python を検出しない場合、python.org から最新の Python バージョンをダウンロードするか、Python 実行可能ファイルへのパスを指定する(非標準のインストールの場合)という 2 つのオプションを提供します。

        Downloading Python when creating a virtual env

      3. グローバル site-packages ディレクトリを継承する場合は、グローバル site-packages を継承するチェックボックスを選択します。このチェックボックスは、virtualenv(英語) ツールの --system-site-packages オプションに対応しています。

      4. 必要に応じてすべてのプロジェクトで使用可能にするチェックボックスを選択してください。

      既存の環境が選択されている場合:

      1. インタープリターリストを展開して既存のインタープリターを選択します。あるいは、Select an interpreterをクリックして、ファイルシステム内の Python 実行可能ファイルへのパス(例: C:\Python36\python.exe)を指定します。

      2. 必要に応じて、チェックボックスすべてのプロジェクトで使用可能にするを選択してください。

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

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

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

      Path to the pipenve executable is autodetected
    2. タスクを完了するには、OK をクリックします。

    3. PATH 変数を変更していない場合、PyCharm はエラーメッセージ Pipenv 実行ファイルが見つかりませんを表示します。pipenv インストール手順の説明に従って適切な実行可能パスを見つけpipenv 実行可能ファイルフィールドにターゲット文字列を入力します(例: C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows)または /Users/jetbrains/.local/bin/pipenv (macOS))。

      OK をクリックして変更を保存し、タスクを完了します。

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

    1. Python インタープリターの追加ダイアログの左側のペインで Conda 環境を選択します。以下のアクションは、Conda 環境が以前に存在していたかどうかによって異なります。

      新しい環境が選択されている場合:

      1. テキストフィールドに新しい Conda 環境の場所を指定するか、Conda environment locationをクリックしてファイルシステム内の場所を探します。新しい Conda 環境を配置するディレクトリは空でなければならないことに注意してください。

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

      3. テキストフィールドに Conda 実行可能ファイルの場所を指定するか、Conda executable locationをクリックして Conda インストールディレクトリ内の場所を見つけます。基本的に、マシンに Conda をインストールするときに使用したパスを探しています。

      4. 必要に応じてすべてのプロジェクトで使用可能にするチェックボックスを選択してください。

      既存の環境が選択されている場合:

      1. インタープリターリストを展開して既存のインタープリターを選択します。あるいは、Select an interpreterをクリックして、ファイルシステム内の Conda 実行可能ファイルへのパス(例: C:\Users\jetbrains\Anaconda3\python.exe)を指定します。

      2. 必要に応じて、チェックボックスすべてのプロジェクトで使用可能にするを選択してください。

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

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

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

      Adding a system interpreter

    2. インタープリターフィールドに、必要なインタープリター実行可能ファイルへの完全修飾パスを入力するか、the Browse buttonをクリックして表示される Python インタープリターの選択ダイアログで、目的の Python 実行可能ファイルを選択して OK をクリックします。

      PyCharm がマシン上で Python を検出しない場合、python.org から最新の Python バージョンをダウンロードするか、Python 実行可能ファイルへのパスを指定する(非標準のインストールの場合)という 2 つのオプションを提供します。

      Downloading Python when installing the system interpreter

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

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

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

    詳細はシステムインタープリターを設定するを参照してください。

    これは Professional の機能です。PyCharmProfessional をダウンロードしてお試しください。

    1. Python インタープリターの追加ダイアログの左側のペインで、SSH インタープリターをクリックします。

    2. 右側のペインで新規サーバー構成を選択し、サーバー情報(ホスト、ポート、ユーザー名)を指定します。

      adding an interpreter via SSH

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

      Existing SSH configuration

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

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

      specifying authentication details

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

      次へをクリックして、最終的な設定手順に進みます。

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

      Setting SSH mappings

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

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

    これは Professional の機能です。PyCharmProfessional をダウンロードしてお試しください。

    1. Python インタープリターの追加ダイアログの左側のペインで、Vagrant をクリックします。

      Add an interpreter

    2. フィールド Vagrant インスタンスフォルダーの横にある参照ボタンthe Browse buttonをクリックし、目的の Vagrant インスタンスフォルダーを指定します。

      この結果、Vagrant ホスト URL へのリンクが表示されます。

    3. Python インタープリターパスフィールドには、目的の Python 実行可能ファイルへのパスが表示されます。デフォルトを受け入れるか、別のものを指定することができます。

    4. OK をクリックします。設定済みのリモートインタープリターがリストに追加されます。

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

    これは Professional の機能です。PyCharmProfessional をダウンロードしてお試しください。

    1. ダイアログの左側のペインで、WSL をクリックします。

      Adding a WSL interpreter
    2. Linux ディストリビューションを選択し、選択した Linux ディストリビューションの python 実行可能ファイルへのパスを指定します。通常、wsl.exe を探す必要がありますが、デフォルト以外の WSL ディストリビューションを指定できます。

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

    これは Professional の機能です。PyCharmProfessional をダウンロードしてお試しください。

    表示されるダイアログで、Docker オプションを選択し、ドロップダウンリストから Docker サーバーを選択し(サーバーがない場合は新規... をクリック)、イメージ名を指定します。

    Python インタープリターのパスはデフォルト値を持つ必要があります:

    Choose a docker

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

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

      これは Professional の機能です。PyCharmProfessional をダウンロードしてお試しください。

      表示されるダイアログで、Docker Compose オプションを選択し、ドロップダウンリストから Docker サーバー、Docker Compose サービス(ここでは web)、設定ファイル(ここでは docker-compose.yml)、およびイメージ名(ここでは python)を選択します。

      web を選んだのはなぜですか?この選択は、Docker-Compose ベースのインタープリターを構成した後、選択したコンテナーの動作を変更する通常の実行構成を作成できるようになるという事実によって説明されます。コンテナー内のコードをデバッグする場合は、ここで選択する必要があります。作成ファイル内の他のすべてのコンテナーは、常にこのファイルとともに起動されますが、PyCharm からの動作に影響を与えることはできません。コマンドラインからコマンド docker-compose up を起動した場合と同じように動作します。

      次に、PyCharm があなたの Docker-Compose 設定を開始してスキャンしてインデックスを作成するのを待ちます:

      Configure remote Python interpreter

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

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

      リモート Python インタープリターが追加されると、まず PyCharm ヘルパーがリモートホストにコピーされます。PyCharm ヘルパーは、パッケージングタスク、デバッガー、テスト、その他の PyCharm 機能をリモートで実行するために必要です。次に、バイナリライブラリのスケルトンが生成され、ローカルにコピーされます。また、すべての Python ライブラリソースは、リモートホスト上の Python パスから収集され、生成されたスケルトンとともにローカルにコピーされます。解決と補完が正しく機能するためには、スケルトンとすべての Python ライブラリソースをローカルに格納する必要があります。PyCharm は、リモートを実行するたびにリモートヘルパーのバージョンを確認するため、PyCharm バージョンを更新すると、新しいヘルパーが自動的にアップロードされ、リモートインタープリターを再作成する必要はありません。SFTP サポートは、ヘルパーをサーバーにコピーするために必要です。

      既存の Python インタープリターの設定

      Python インタープリターウィジェットを使用するか、プロジェクト設定 / 環境設定で、いつでも Python インタープリターを切り替えることができます。

      Python インタープリターウィジェットを使用して Python インタープリターを変更する

      • Python インタープリターウィジェットはステータスバーにあります。これは、Python インタープリターを切り替える最も便利で迅速な方法です。それをクリックして、ターゲットのインタープリターを選択するだけです。

      Project interpreter widget

      プロジェクト設定で Python インタープリターを変更する

      1. Ctrl+Alt+S を押すか、Windows および Linux の場合はファイル | 設定を、macOS の場合は PyCharm | 環境設定を選択して、設定 / 環境設定ダイアログを開きます。

        プロジェクト <プロジェクト名> | Python インタープリターを選択します。

      2. 利用可能なインタープリターのリストを展開してすべて表示リンクをクリックしてください。または、The Configure project interpreterアイコンをクリックしてすべて表示を選択します。

        Show all available interpreters

      3. 目的のインタープリターを選択してください。

        View interpreters

        PyCharm が古い Python バージョンのサポートを停止すると、対応する Python インタープリターはサポートされないものとしてマークされます。

      4. 必要に応じて、編集をクリックして代わりのインタープリター名を入力することもできます。

        Changing interpreter's name

        名前フィールドで指定された Python インタープリター名は、使用可能なインタープリターのリストに表示されるようになります。変更を適用するには、OK をクリックします。

      デフォルトのインタープリターを設定する

      PyCharm では、新しく作成されたすべてのプロジェクトに自動的に設定されるインタープリターを指定できます。

      1. メインメニューから、新規プロジェクトの設定 | 新しいプロジェクトの設定(Windows および Linux)または新規プロジェクトの設定 | 新しいプロジェクトの設定(macOS)を選択します。

      2. Python インタープリター設定を選択します。次に、Python インタープリターリストの既存のインタープリターをNew interpreterをクリックして選択し、新しいインタープリター追加します。OK をクリックして変更を保存します。

        この変更は、PyCharm で新しく作成されたすべてのプロジェクトに有効になります。

      インタープリターパッケージの管理

      インタープリターごとに、Python パッケージをインストール、アップグレード、削除できます。デフォルトでは、PyCharm は pip を使用してプロジェクトパッケージを管理します。Conda 環境では、Conda パッケージマネージャーを使用できます。

      Managing packages

      PyCharm はパッケージのステータスをスマートに追跡し、現在インストールされているパッケージバージョン(列バージョン)と最新の使用可能なバージョン(列最新バージョン)の数を表示することにより、古いバージョンを認識します。新しいバージョンのパッケージが検出されると、PyCharm はそれを矢印New version is availableでマークし、それをアップグレードすることを提案します。

      デフォルトでは、最新バージョン列にはパッケージの安定バージョンのみが表示されます。最新の利用可能なバージョンの範囲をプレリリースバージョン(ベータ版リリース候補など)に拡張する場合は、初期リリースを表示をクリックします。

      一度にいくつかのパッケージをアップグレードすることができます。Cmd(macOS)または Ctrl(Unix または Windows)を押したままにして、パッケージの一覧でいくつかの項目を選択するために左クリックし、アップグレードをクリックします。

      詳細な手順を参照してください。

      関連ページ:

      Python

      PyCharm で Python スクリプトを開発するには:Pythonをダウンロードしてインストールします。インストールして有効にするPython プラグイン( を押してプラグインに移動します)。少なくとも 1 つのPython インタープリターを構成します。Windows ユーザーの場合、Win...

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

      PyCharm で Python コードを使用するには、少なくとも 1 つのインタープリターを構成する必要があります。システムインタープリターは、Python インストールに付属するものです。すべての Python スクリプトにのみ使用するか、Python仮想環境の基本インタープリターとして使用でき...

      仮想環境を構成する

      PyCharm を使用すると、virtualenvツールを使用して、プロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenvツールは PyCharm にバンドルされ...

      Pipenv 環境を構成する

      Pipenvは、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfileファイルを介してプロジェクトパッケージが自動的に管理されます。Pipenv は、確定的なビルドを生成し、作業環境のスナップシ...

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

      導入 :PyCharm とDockerの統合により、Docker コンテナーにデプロイされたさまざまな構成の開発環境でアプリケーションを実行できます。前提条件 :次の前提条件が満たされていることを確認してください。ページDocker ドキュメントに記載されているように、Docker がインストールさ...

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

      前提条件 :次の前提条件が満たされていることを確認してください。インターネット接続が安定しています。Docker で操作するには、busyboxイメージがマシンで利用可能である必要があります。PyCharm がをダウンロードして実行できるように、安定したインターネット接続があることを確認してください...