PyCharm 2024.2 ヘルプ

実行 / デバッグ構成

PyCharm は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。

さまざまな起動プロパティを使用して、PyCharm がスクリプトを実行するために使用するさまざまな方法を定義できます。例: 異なる Python インタープリターを使用して同じコードを実行し、さまざまな環境変数のセットを提供し、代替ファイルから入力値を取得できます。

実行 / デバッグ構成には 2 つのタイプがあります。

  • 一時的 — 関数またはテストを実行またはデバッグするたびに作成されます。

  • 永続的 — テンプレートから明示的に作成されるか、一時的な構成を保存することによって作成されます。永続的な構成は、削除するまでプロジェクトの一部として残ります。

コードを実行 / デバッグまたはテストするときはいつでも、PyCharm は既存の永続的な実行 / デバッグ構成を使用するか、新しい一時的な構成を作成します。

永続的な構成のアイコンは不透明ですが、一時的な構成のアイコンは半透明です。構成アイコン上の赤い十字は、構成設定にエラーがあることを示します。

一時構成の最大数は 5 です。新しい構成が追加されると、古い構成は自動的に削除されます。必要に応じて、設定 | 詳細設定 | 実行 / デバッグ | 一時的な構成の制限でこの制限を増やすことができます。

永続的な実行 / デバッグ構成を作成する

PyCharm は、永続的な実行 / デバッグ構成を作成する次の方法を提供します。

一時的な構成を永続的なものとして保存する

  • 実行 / デバッグ構成スイッチャーで一時構成を選択し、 / をクリックして、構成の保存を選択します。

    一時構成を保存すると、永続的になり、<project directory>/.idea/ ディレクトリの別の XML ファイルに記録されます。例: MyProject/.idea/Car.xml

  • または、実行 / デバッグ構成ダイアログで一時構成を選択し、ツールバーの Save をクリックします。

PyCharm は、さまざまな言語、ツール、フレームワーク用の実行 / デバッグ構成テンプレートを提供します。使用可能なテンプレートのリストは、インストールされているプラグインと有効になっているプラグインによって異なります。

テンプレートから実行 / デバッグ構成を作成する

  1. 実行 | 実行構成の編集に進みます。または、実行ウィジェットで をクリックし、ドロップダウンメニューから実行構成の編集を選択します。

    Run/Debug Configurations popup
  2. 実行 / デバッグ構成ダイアログで、ツールバーの をクリックするか、Alt+Insert を押します。リストには、実行 / デバッグ構成テンプレートが表示されます。Python を選択します。

    Selecting a new run/debug configuration template
  3. 名前フィールドに実行 / デバッグ構成名を指定します。この名前は、使用可能な実行 / デバッグ構成のリストに表示されます。

    creating a new run/debug configuration
  4. 実行 / デバッグ構成パラメーターを構成します。必須パラメーターとオプションのパラメーターのリストは、選択した実行 / デバッグ構成型によって異なる場合があります。

    一部のオプションのパラメーターは非表示になっています。これらを表示して有効にするには、オプションを変更リンクをクリックします。

    Enabling optional parameters for a Python run configuration

    Python テンプレートの詳細については、「構成パラメーターの実行 / デバッグ」を参照してください。

  5. 構成をすぐに実行することも、構成を保存して後で実行することもできます。

    • OK をクリックして、後で使用するために実行構成を保存し、ダイアログを閉じます。

    • 構成をすぐに実行するには、「実行」をクリックします。

  6. 構成を削除するには、次のいずれかを実行します。

    • 実行 / デバッグ構成ダイアログで構成を選択し、ウィンドウツールバーの Remove Configuration 構成の除去をクリックします。

      Click to remove the configuration
    • 実行 / デバッグ構成のリストから構成を選択し、メインツールバーの More Actions その他のアクションをクリックします。メニューから削除を選択します。

      Select the delete option from the menu

起動前

この領域では、選択した実行 / デバッグ構成を開始する前に実行するタスクを指定できます。タスクは、リストに表示されている順序で実行されます。

項目

ショートカット

説明

the Add button

Alt+Insert

このアイコンをクリックして、以下の使用可能なタスクのいずれかを追加します。

  • 外部ツールの実行 : 外部アプリケーションを実行することを選択します。開いたダイアログで、実行する 1 つまたは複数のアプリケーションを選択します。PyCharm でまだ定義されていない場合は、定義を追加します。詳細については、「外部ツールおよび外部ツール」を参照してください。

  • 別の構成を実行 : 別の実行 / デバッグ構成を実行することを選択し、それが完了するまで待ってから現在の構成を開始します。複数の構成を並行して実行する場合は、複合実行 / デバッグ構成を使用してください。

  • Web ブラウザーの起動 : ブラウザーを起動するにはこのオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 URL を入力します。また、ブラウザーを JavaScript デバッガーで起動するかどうかを指定します。

  • ファイル監視の実行 : PyCharm に現在アクティブなすべての File Watchers を適用させるには、このオプションを選択します。

  • Grunt タスクの実行 : Grunt タスクを実行するには、このオプションを選択してください。

    表示される Grunt タスクダイアログで、必要なタスクが定義されている Gruntfile.js を指定し、実行するタスクを選択して、Grunt ツールに渡す引数を指定します。

    Node.js インタープリターの場所、渡すパラメーター、grunt-cli パッケージへのパスを指定します。

  • gulp タスクの実行 : Gulp タスクを実行するには、このオプションを選択してください。

    表示される Gulp タスクダイアログで、必要なタスクが定義されている Gulpfile.js を指定し、実行するタスクを選択して、Gulp ツールに渡す引数を指定します。

    Node.js インタープリターの場所、それに渡すパラメーター、gulp パッケージへのパスを指定します。

  • npm スクリプトの実行 : npm スクリプトを実行するには、このオプションを選択してください。

    開いた NPM スクリプトダイアログで、npm 実行 / デバッグ構成設定を指定します。

  • React Native Bundler の起動 : 実行中またはデバッグセッションの一部としてバンドラーを自動的に実行するには、このオプションを選択します。デフォルトでは、これは react-native start を介して行われます。

    アプリケーションが Expo(英語) を使用している場合は、start npm タスクを介して開発サーバーを実行する必要があります。これを行うには、Add をクリックし、React Native の設定ダイアログで npm スクリプトを選択し、リストから開始を選択します。

  • TypeScript のコンパイル : 組み込み TypeScript コンパイラーを実行するように選択し、TypeScript コードに加えたすべての変更が生成された JavaScript ファイルに反映されるようにします。表示される TypeScript のコンパイル設定ダイアログで、エラーの確認チェックボックスを選択または選択解除して、エラーが検出された場合のコンパイラーの動作を設定します。

    • エラーの確認チェックボックスが選択されていると、コンパイラーはすべてのエラーを表示し、実行構成は開始されません。

    • エラーの確認チェックボックスがオフの場合、コンパイラーは検出されたすべてのエラーを表示しますが、実行構成は起動されます。

  • CoffeeScript ソースマップの生成 : CoffeeScript ソースのソースマップを生成するには、このオプションを選択してください。表示されるダイアログで、CoffeeScript のソースファイルがある場所を指定します。

  • リモート外部ツールの実行 : リモート SSH 外部ツールを追加します

the Remove button

Alt+Delete

このアイコンをクリックして、選択したタスクをリストから削除します。

Edit

Enter

選択したタスクを編集するには、このアイコンをクリックします。開いたダイアログで必要な変更を加えます。

Method up

Method down

Alt+Up

Alt+Down

これらのアイコンをクリックして、選択したタスクをリスト内で 1 行上または下に移動します。タスクは、リストに表示されている順に実行されます。

このページを表示する

実行 / デバッグ構成を実際に開始する前に、実行 / デバッグ構成設定を表示するには、このチェックボックスを選択します。

ツールウィンドウをアクティブにする

デフォルトではこのチェックボックスは選択されており、実行 / デバッグ構成を開始すると実行またはデバッグツールウィンドウが開きます。

それ以外の場合、チェックボックスがオフの場合、ツールウィンドウは非表示になります。ただし、構成が実行されている場合は、Alt+4 または Alt+5 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

Python 実行 / デバッグ構成にマクロを追加する

  1. 実行 | 実行構成の編集に進みます。または、実行ウィジェットで をクリックし、ドロップダウンメニューから実行構成の編集を選択します。

    Run/Debug Configurations popup
  2. 実行 / デバッグ構成ダイアログで、Python 実行 / デバッグ構成のリストからターゲット構成を選択します。

  3. 次のいずれかのフィールドで「 マクロの挿入」をクリックします。

    • スクリプトパス

    • パラメーター

    • 作業ディレクトリ

  4. 使用可能なマクロのリストからマクロを選択します。

    Adding macros to Python run configuration
  5. 挿入をクリックして、選択したマクロを追加します。

    実行 / デバッグ構成でマクロを使用する例については、実行中のスクリプトにパラメーターを渡すを参照してください。

実行 / デバッグ構成を共有する

チームで作業している場合は、実行 / デバッグ構成を共有して、チームメイトが同じ構成を使用してアプリケーションを実行したり、実行中のプロセスにリモートで接続したりできるようにすることができます。

これらの目的のために、PyCharm は、実行 / デバッグ構成をプロジェクトファイルとして保存し、VCS を通じて共有するためのメカニズムを提供します。同じメカニズムは、構成をファイルとして他の人に送信する場合にも使用できます。これにより、実行 / デバッグ構成が洗練されることがあり、手動で同期を維持するのは面倒でエラーが発生しやすくなるため、多くの時間を節約できます。

  1. 実行 | 実行構成の編集に進みます。または、実行ウィジェットで をクリックし、ドロップダウンメニューから実行構成の編集を選択します。

    Run/Debug Configurations popup
  2. 共有する実行 / デバッグ構成を選択し、プロジェクトファイルとして保存オプションを有効にして、構成ファイルを保存する場所を指定します。

    PyCharm 2019.3 以前との互換性が必要でない限り、任意の場所を設定できます。これらのバージョンとの互換性を保つには、推奨される場所にファイルを保存してください。

  3. (オプション) .idea ディレクトリが VCS 無視ファイルに追加された場合、.idea/runConfigurations サブフォルダーも無視されます。プロジェクトに Git を使用する場合は、.gitignore を次のように変更することで、.idea/runConfigurations のみを共有し、.idea を無視したままにすることができます。

    /.idea/* !/.idea/runConfigurations

実行 / デバッグ構成テンプレート

すべての実行 / デバッグ構成は、スタートアップロジックを実装し、パラメーターのリストとそのデフォルト値を定義するテンプレートに基づいています。使用可能なテンプレートのリストはインストールで事前定義されており、プラグインを介してのみ拡張できます。ただし、各テンプレートのデフォルトのパラメーター値を編集して、新しい実行 / デバッグ構成のセットアップを合理化することができます。

テンプレートのデフォルト値を構成する

  1. 実行 | 実行構成の編集に進みます。または、実行ウィジェットで をクリックし、ドロップダウンメニューから実行構成の編集を選択します。

    Run/Debug Configurations popup
  2. 実行 / デバッグ構成ダイアログの左側のペインで、構成テンプレートの編集をクリックします。

    Run/Debug templates
  3. 開いた実行 / デバッグ構成テンプレートダイアログで、構成タイプを選択します。

    Run/Debug templates
  4. 必要なデフォルトパラメーターを指定し、OK をクリックしてテンプレートを保存します。

実行 / デバッグ構成フォルダー

同じ種類の実行 / デバッグ構成が多数ある場合、フォルダーにグループ化すると、視覚的に区別しやすくなります。

グループ化すると、実行 / デバッグ構成が対応するフォルダーのリストに表示されます。

Grouped run configurations

実行 / デバッグ構成用のフォルダーを作成する

  1. 実行 | 実行構成の編集に進みます。または、実行ウィジェットで をクリックし、ドロップダウンメニューから実行構成の編集を選択します。

    Run/Debug Configurations popup
  2. 実行 / デバッグ構成ダイアログで、構成タイプを選択し、ツールバーの the New Folder icon をクリックします。選択したタイプの新しい空のフォルダーが作成されます。

    Adding a configuration folder
  3. 右側のテキストフィールドにフォルダー名を指定するか、デフォルトの名前を受け入れます。

  4. 目的の実行 / デバッグ構成を選択し、ターゲットフォルダーに移動します。

  5. 変更を適用します。フォルダーが空の場合、保存されません。

フォルダーが不要になった場合は、Delete を削除できます。このフォルダーにグループ化された実行 / デバッグ構成は、対応する実行 / デバッグ構成タイプのルートに移動されます。

サービスツールウィンドウで実行 / デバッグ構成

サービスツールウィンドウで複数の実行 / デバッグ構成を管理できます。例: 複数のアプリケーションを開始、一時停止、停止し、それらのステータスを追跡し、アプリケーション固有の詳細を調べることができます。

サービスウィンドウに実行 / デバッグ構成を追加する

  1. メインメニューから表示 | ツールウィンドウ | サービスを選択するか、Alt+8 を押します。

  2. サービスツールウィンドウで、サービスの追加をクリックし、実行構成タイプを選択します。

    Services tool window: Add run configuration
  3. リストから実行 / デバッグ構成タイプを選択して、このタイプのすべての構成をウィンドウに追加します。

    ツールウィンドウには、1 つ以上の構成を作成した構成タイプのみが表示されることに注意してください。

構成パラメーターの実行 / デバッグ

項目

説明

スクリプトパス / モジュール名

リストをクリックして、実行するターゲットの種類を選択します。次に、対応するフィールドに、Python スクリプトへのパスまたは実行するモジュール名を指定します。

このフィールドではパス変数を使用できます。

パラメーター

このフィールドには、Python スクリプトに渡すパラメーターを指定します。

スクリプトパラメーターを指定するときは、次の規則に従ってください。

  • スペースを使用して、個々のスクリプトパラメーターを区切ります。

  • スペースを含むスクリプトパラメーターは、二重引用符で区切る必要があります(例: some" "param または "some param")。

  • スクリプトパラメーターに二重引用符が含まれている場合は、二重引用符をバックスラッシュでエスケープします(例:

    -s"main.snap_source_dirs=[\"pcomponents/src/main/python\"]" -s"http.cc_port=8189" -s"backdoor.port=9189" -s"main.metadata={\"location\": \"B\", \"language\": \"python\"}"

このフィールドでは、マクロを追加して、実行 / デバッグ構成の実行時にさまざまなプロジェクト固有またはコンテキスト固有の値を渡すことができます。+ をクリックして、リストから使用可能なマクロの 1 つを選択します。詳細については、実行 / デバッグ構成へのマクロの追加を参照してください。

複数のインスタンスを許可する

構成の複数のインスタンスを同時に実行できるようにする場合は、このオプションを選択します。このオプションが無効になっている場合、構成を再実行しようとすると、アクティブなセッションが終了します。

環境

プロジェクト

このリストをクリックして、同じ PyCharm ウィンドウで開いたプロジェクトの 1 つを選択します。このプロジェクトでは、この実行 / デバッグ構成を使用する必要があります。開いているプロジェクトが 1 つしかない場合、このフィールドは表示されません。

環境変数

このフィールドには、環境変数のリストが表示されます。リストに複数の変数が含まれている場合、それらはセミコロンで区切られます。

デフォルトでは、フィールドには 1 に設定された変数 PYTHONUNBUFFERED が含まれます。リストに入力するには、参照ボタンをクリックするか、Shift+Enter を押して、環境変数ダイアログで目的の環境変数のセットを指定します。

新しい変数を作成するには、the Add button をクリックして、目的の名前と値を入力します。

テキストファイルに一連のレコードとして格納されている変数をリストに追加することができます。

Variable1 = Value1 Variable2 = Value2

テキストファイルから変数のリストをコピーし、環境変数ダイアログで貼り付けPaste)をクリックするだけです。変数がテーブルに追加されます。OK をクリックして、タスクを完了します。いつでも、環境変数ダイアログですべての変数を選択し、コピー Copy をクリックして、テキストファイルに貼り付けることができます。

".env" ファイルへのパス

このフィールドには、環境変数を含む .env ファイルへのパスが表示されます。複数のファイルがある場合、それらのファイルへのパスはセミコロンで区切られます。

.env ファイルのリストを管理するには、「 ".env" ファイルの選択」をクリックします。開いた環境ファイルダイアログで、 追加および 除去を使用してファイルを追加および削除します。

および を使用して、.env ファイルがロードされる順序を変更することもできます。

Python インタープリター

リストから事前設定された Python インタープリターの 1 つを選択してください。

インタープリターオプション

このフィールドで、インタープリターに渡されるコマンドラインオプション(英語)を指定します。必要に応じて、Expand the field をクリックし、エディターに文字列を入力します。

作業ディレクトリ

実行中のタスクが使用するディレクトリを指定します。

  • デフォルトの実行 / デバッグ構成がキーボードショートカット Ctrl+Shift+F10 によって、またはスクリプトのコンテキストメニューから実行を選択することによって作成されるとき、作業ディレクトリは実行可能スクリプトを含むものです。このディレクトリはプロジェクトディレクトリとは異なる場合があります。

  • このフィールドを空白のままにすると、PyCharm インストールの bin ディレクトリが使用されます。

このフィールドではパス変数を使用できます。

PYTHONPATH にコンテンツルートを追加する

このチェックボックスを選択して、プロジェクトのすべてのコンテンツルートを環境変数 PYTHONPATH に追加します。

PYTHONPATH にソースルートを追加する

このチェックボックスを選択して、プロジェクトのすべてのソースルートを環境変数 PYTHONPATH に追加します。

実行

出力コンソールでターミナルをエミュレートする

エミュレートされたターミナルモードを使用して、出力コンソールでスクリプトまたはモジュールを実行できるようにします。このモードは、スクリプトがキャレットリターンアクション(print(i, flush=True , end='\r')を実行する場合など、標準出力コンソールでは実装できないタスクに役立ちます。

出力コンソールでターミナルをエミュレートすることは、システムシェルコマンドを実行するために使用される別個のツールウィンドウであるターミナルを実行することとは異なることに注意してください。

Python コンソールで実行する

Python コンソールでスクリプトやモジュールを実行できるようにします。

次からの入力をリダイレクト

テキストファイルのデータを標準入力にリダイレクトできるようにします。スクリプトに何らかの入力が必要で、実行コンソールに値を入力する代わりに、自動的に値を送信したい場合は、このオプションを使用します。リダイレクトを有効にするには、チェックボックスをオンにして、ターゲットテキストファイルへのパスを指定します。

Docker コンテナーの設定

the Browse button をクリックしてダイアログを開き、以下の設定を指定します。

オプション

  • すべてのポートを公開する : すべてのコンテナーポートをホストに公開します。これはオプション --publish-all に対応します。

  • ポートバインディング : ポートバインディング(英語)のリストを指定します(英語)docker run-p オプションを使用するのと同様です。

  • ボリュームバインディング : このフィールドを使用して、特別なフォルダー ( ボリューム) と、Docker デーモンが実行されるコンピューターのフォルダー間のバインドを指定します。-v オプションに対応します。詳細については、「コンテナー内のデータを管理する(英語)」を参照してください。

  • 環境変数 : このフィールドを使用して、環境変数とその値のリストを指定します。-e オプションに対応します。詳細については、「ENV (環境変数)(英語)」を参照してください。

  • 実行オプション : このフィールドを使用して、Docker コマンドラインオプション(英語)を指定します。

をクリックしてテーブルを展開します。 をクリックしてリストを作成します。

Docker Compose

コマンドとオプション

Docker Compose コマンドラインインターフェースの次のコマンドを使用できます。

コマンド

サポートされているオプション

up(英語): サービスのコンテナーをビルド、作成、開始、アタッチします。

  • --abort-on-container-exit

  • --build

  • --exit-code-from SERVICE

  • --scale SERVICE=NUM...

  • --timeout TIMEOUT

run(英語): サービスに対して 1 回限りのコマンドを実行します。

  • --entrypoint CMD

  • -l, --label KEY=VAL

  • --name NAME

  • -p, --publish=[]

  • --rm

  • --service-ports

  • --use-aliases

  • -u, --user=""

  • -v, --volume=[]

exec(英語): サービスで任意のコマンドを実行します。

  • --index=index

  • --privileged

  • -u, --user USER

コマンドプレビュー

このフィールドを使用して、完全なコマンド文字列をプレビューします。

例: コマンドとオプションフィールドの up --build exec --user jetbrains の組み合わせは、プレビューで次の出力を生成します。

docker compose -f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml <override configuration file> up --build exec --user jetbrains

関連ページ:

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

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

外部ツール

サードパーティのコマンドラインアプリケーションを外部ツールとして構成して、PyCharm から実行します。例: ワークフローでは、特定のスクリプト、コードジェネレーター、アナライザー、プリプロセッサーまたはポストプロセッサー、データベースユーティリティなどの実行が必要になる場合があります。外部ツールとして構成することにより、PyCharm は専用のアクションを提供します。これは、メインメニューや特定のコンテキストメニューから実行したり、ショートカットを割り当てたり、特定の実行構成を起動するときに...

外部ツール

このページでは、ローカル外部ツールに対して構成できる設定について説明します。外部ツールの追加と使用の詳細については、「外部ツール」を参照してください。ツールバーボタンを使用して、使用可能な外部ツールのリストを管理します。保持したいがメニューで使用できないツールとグループのチェックボックスをオフにします。追加新しい外部ツールを追加します。除去選択したツールまたはグループを削除します。編集選択したツールを編集します。上へ選択したツールをリスト内で上に移動します。

複数のターゲットを実行 / デバッグする

PyCharm は、複数のものを一度に実行 / デバッグするいくつかの方法を提供します。たとえば、複数の異なるプロセスまたはタスクを起動する必要があるクライアントサーバーアプリや複雑なテストです。いずれにせよ、最初のステップは、起動する必要があるタスクまたはプロセスごとに実行構成を作成することです。必要な構成がすべて整ったら、起動するためのいくつかのオプションがあります。複合実行構成を使用する複数の構成を並行して起動する、起動前タスクを使用する複数の構成を順番に起動する、複数の構成を一度に起動す...

File Watchers

File Watcher は PyCharm ツールであり、IDE でファイルを変更または保存するときに、コンパイラー、フォーマッタ、リンターなどのコマンドラインツールを自動的に実行できます。File Watchers には 2 つの専用コードインスペクションがあります。ファイル監視使用可能インスペクションは、定義済みの File Watcher が適用可能なすべてのファイルで実行されます。プロジェクトに関連する File Watcher が設定されていない場合、PyCharm は追加することを提...

npm、pnpm、Yarn

PyCharm は npm、pnpm、Yarn、Yarn 2、Yarn 3 と統合されているため、組み込みのターミナルで、IDE 内から再利用可能なコードのパッケージをインストール、検索、更新、削除できます。PyCharm では、npm、Yarn、pnpm スクリプトを実行およびデバッグすることもできます。PyCharm は、package.json ファイルを解析してスクリプトの定義を認識し、スクリプトをツリービューに表示して、ツリー内のスクリプトと package.json ファイル内のその定義の間...