PyCharm 2024.1 ヘルプ

Poetry 環境を構成する

Poetry(英語) は、プロジェクトの依存関係に基づいて Python 仮想環境を簡単に作成できるツールです。プロジェクトが依存するライブラリを宣言でき、Poetry がインストールして更新します。

プロジェクトの依存関係は、必要なパッケージ、スクリプト、プラグイン、URL を指定する pyproject.toml ファイルに記録されます。その構造と形式の詳細については、pyproject(英語) リファレンスを参照してください。

PyCharm で Poetry を使用するには、Poetry をマシンにインストールして、特定の Python 環境を作成する必要があります。

Poetry をインストールする

  1. ターミナル (macOS および Linux の場合) または PowerShell (Windows の場合) を開き、次のコマンドを実行します。

    curl -sSL https://install.python-poetry.org | python3 -
    (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
    curl -sSL https://install.python-poetry.org | python3 -
  2. macOS と Windows では、インストールスクリプトは、詩の実行可能ファイルを含むフォルダーを PATH 変数に追加することを提案します。これを行うには、次のコマンドを実行します。

    export PATH="/Users/jetbrains/.local/bin:$PATH"
    $Env:Path += ";C:\Users\jetbrains\AppData\Roaming\Python\Scripts"; setx PATH "$Env:Path"

    jetbrains をユーザー名に置き換えることを忘れないでください !

  3. インストールを確認するには、次のコマンドを実行します。

    poetry --version

    Poetry (version 1.2.0) のようなものが表示されるはずです。

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

Poetry 環境を作成する

  1. 以下のいずれか 1 つを実行します:

    • Python インタープリターセレクターをクリックして、新しいインタープリターを追加を選択します。

    • Ctrl+Alt+S を押して設定を開き、プロジェクト: <プロジェクト名> | Python インタープリターに移動します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。

    • Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。

  2. ローカルインタープリターを追加するを選択します。

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

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

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

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

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

    • PyCharm が詩の実行可能ファイルを検出しない場合は、ダイアログで次のパスを指定し、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 をクリックします。

新しい Python プロジェクトを作成するときに Poetry 環境を選択すると、PyCharm はプロジェクト要件を備えた pyproject.toml を作成します。

pyproject.toml ファイルを変更するたびに、PyCharm は通知し、poetry.lock ファイルの変更を記録する ( 詩のロック )、または変更を記録して満たされていない要件をインストールする ( 詩の更新 ) という 2 つのアクションを提案します。

Lock or update poetry

pyproject.toml を使用して Poetry 環境を作成する

  1. pyproject.toml を含むプロジェクトを開いたものの、プロジェクトインタープリターが構成されていない場合、PyCharm は Poetry 環境を作成することを提案します。

    pyproject.toml detected
  2. PyCharm に Poetry を自動的に構成させたい場合は、pyproject.toml を使用して詩環境をセットアップするをクリックします。または、「Python インタープリターを構成する」をクリックして標準ワークフローに従うこともできます。

  3. PyCharm が Poetry 実行可能ファイルを自動検出できない場合は、その実行可能ファイルへのパスを指定して、OK をクリックします。

新しい Poetry 環境がプロジェクト用に構成され、pyproject.toml にリストされているパッケージがインストールされます。

関連ページ:

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

PyCharm の Python インタープリター:PyCharm で Python コードを操作するには、少なくとも 1 つの Python インタープリターを構成する必要があります。Python インストールで利用可能なシステムインタープリターを使用できます。Virtualenv、pipenv、Poetry、conda 仮想環境を作成することもできます。仮想環境は、基本インタープリターとインストールされたパッケージで構成されます。PyCharm Professional では、SSH、Vagr...

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

純粋な Python プロジェクトは、Python プログラミングを対象としています。プロジェクトは、ソースコード、テスト、使用するライブラリ、個人設定を 1 つのユニットに整理できます。プロジェクトが不要な場合は、LightEdit モードでファイルを編集できます。プロジェクトを作成するには、次のいずれかを実行します。に移動します。ウェルカム画面で、新しいプロジェクトをクリックします。、新しいプロジェクトダイアログで、プロジェクト名とその場所を指定します。ダイアログは、PyCharm エディシ...

Pipenv 環境を構成する

Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介して自動的にプロジェクトパッケージが管理されます。Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要である場合、セキュリティに敏感なデプロイにとって特に役立つ可能性が...

conda 仮想環境を構成する

PyCharm は、Conda を使用した Python の仮想環境の作成をサポートしています。次の手順は、サポートされているすべてのオペレーティングシステムに適用されます。このページの上部にあるプラットフォームスイッチャーを使用して、オペレーティングシステムに固有のショートカットを表示します。conda 環境を作成する Anaconda または Miniconda がダウンロードされてコンピューターにインストールされていること、およびその実行可能ファイルへのパスがわかっていることを確認してください。詳細...