実行 / デバッグ構成

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

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

実行 / デバッグ構成には 2 種類があります：

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

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

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

一時構成の最大数は 5 です。新しい構成が追加されると、古い構成は自動的に削除されます。必要に応じて、設定 | Advanced Settings | Run/Debug | Temporary configurations limit でこの制限を増やすことができます。

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

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

一時的な実行 / デバッグ構成を永続的な構成として保存します。
テンプレートから作成または既存の構成をコピーします。

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

実行 / デバッグ構成スイッチャーで一時構成を選択し、 / をクリックして、設定の保存を選択します。
一時構成を保存すると、永続的になり、 <project directory>/.idea/ ディレクトリの別の XML ファイルに記録されます。例： MyProject/.idea/Car.xml 。
または、実行 / デバッグ構成ダイアログで一時構成を選択し、ツールバーのをクリックします。

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

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

実行 | 実行構成の編集に進みます。または、実行ウィジェットでをクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログで、ツールバーのをクリックするか、 Alt+Insert を押します。リストには、実行 / デバッグ構成テンプレートが表示されます。 Python を選択します。
名前フィールドに実行 / デバッグ構成名を指定します。この名前はリストやメニューで実行 / デバッグ構成を識別するために使用されます。
実行 / デバッグ構成パラメーターを構成します。必須パラメーターとオプションのパラメーターのリストは、選択した実行 / デバッグ構成型によって異なる場合があります。
一部のオプションのパラメーターは非表示になっています。これらを表示して有効にするには、オプションを変更リンクをクリックします。
Python テンプレートの詳細については、「構成パラメーターの実行 / デバッグ」を参照してください。
構成をすぐに実行するか、保存して後で実行することもできます。
- 実行構成を後で使用するために保存するには、 OK をクリックします。
- 構成をすぐに実行するには、「実行」をクリックします。
構成を削除するには、次のいずれかを実行します。
- 実行 / デバッグ構成ダイアログで構成を選択し、ウィンドウのツールバーにある構成の除去をクリックします。
- 実行 / デバッグ構成のリストから構成を選択し、メインツールバーのその他のアクションをクリックします。メニューから削除を選択します。

起動前

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

項目	ショートカット	説明
	`Alt+Insert`	このアイコンをクリックして、以下の利用可能なタスクのいずれかを追加します： Launch Web Browser: ブラウザーを起動するには、このオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 URL を指定します。また、ブラウザーを JavaScript デバッガーで起動するかどうかも指定します。外部ツールの実行: 外部アプリケーションを実行することを選択します。開いたダイアログで、実行する 1 つまたは複数のアプリケーションを選択します。 PyCharm でまだ定義されていない場合は、その定義を追加してください。詳細については、外部ツールと外部ツールを参照してください。 Run Another Configuration: 別の実行 / デバッグ構成を実行することを選択し、それが完了するまで待ってから現在の構成を開始します。複数の構成を並行して実行する場合は、複合実行 / デバッグ構成を使用してください。 Run File Watchers ：このオプションを選択すると、PyCharm が現在アクティブなすべての File Watchers を適用します。 Run Remote External Tool: リモート SSH 外部ツールを追加します。 Grunt タスクを実行: Grunt タスクを実行するには、このオプションを選択してください。表示される Grunt タスクダイアログで、必要なタスクが定義されている Gruntfile.js を指定し、実行するタスクを選択して、Grunt ツールに渡す引数を指定します。 Node.js ランタイムの場所、それに渡すパラメーター、 grunt-cli パッケージへのパスを指定します。 Run gulp task: Gulp タスクを実行するには、このオプションを選択してください。表示される Gulp タスクダイアログで、必要なタスクが定義されている Gulpfile.js を指定し、実行するタスクを選択して、Gulp ツールに渡す引数を指定します。 Node.js ランタイムの場所、それに渡すパラメーター、 gulp パッケージへのパスを指定します。 npm スクリプトを実行: npm スクリプトを実行するには、このオプションを選択してください。開いた NPM スクリプトダイアログで、 npm 実行 / デバッグ構成設定を指定します。 TypeScript をコンパイルする: 組み込み TypeScript コンパイラーを実行するように選択し、TypeScript コードに加えたすべての変更が生成された JavaScript ファイルに反映されるようにします。表示される TypeScript のコンパイル設定ダイアログで、エラーの確認チェックボックスを選択または選択解除して、エラーが検出された場合のコンパイラーの動作を設定します。エラーの確認チェックボックスが選択されていると、コンパイラーはすべてのエラーを表示し、実行構成は開始されません。エラーの確認チェックボックスがオフの場合、コンパイラーは検出されたすべてのエラーを表示しますが、実行構成は起動されます。 Disconnect Data Source: 実行 / デバッグ構成を実行する前にデータソースへの接続を中断する場合は、このオプションを選択します。
	`Alt+Delete`	このアイコンをクリックして、選択したタスクをリストから削除します。
	`Enter`	選択したタスクを編集するには、このアイコンをクリックします。開いたダイアログで必要な変更を加えます。
	`Alt+Up` `Alt+Down`	これらのアイコンをクリックして、選択したタスクをリスト内で 1 行上または下に移動します。タスクは、リストに表示されている順に実行されます。
Show this page		実行 / デバッグ構成を実際に開始する前に、実行 / デバッグ構成設定を表示するには、このチェックボックスを選択します。
Activate tool window		デフォルトではこのチェックボックスは選択されており、実行 / デバッグ構成を開始すると実行またはデバッグツールウィンドウが開きます。それ以外の場合、チェックボックスがオフの場合、ツールウィンドウは非表示になります。ただし、設定の実行中は、 `Alt+4` または `Alt+5` を押すことで、対応するツールウィンドウを自分で開くことができます。
ツールウィンドウにフォーカス		実行 / デバッグ構成を開始したときに、実行またはデバッグツールウィンドウに自動的にフォーカスを移動させるには、このチェックボックスを選択してください。

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

実行 | 実行構成の編集に進みます。または、実行ウィジェットでをクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログで、Python 実行 / デバッグ構成のリストからターゲット構成を選択します。
次のいずれかのフィールドで「マクロを挿入」をクリックします。
- スクリプトパス
- パラメーター
- 作業ディレクトリ
使用可能なマクロのリストからマクロを選択します。
挿入をクリックして、選択したマクロを追加します。
実行 / デバッグ構成でマクロを使用する例については、実行中のスクリプトにパラメーターを渡すを参照してください。

実行構成を起動する

既存の実行構成は、次のいずれかの方法で起動できます。

実行ウィジェットで実行構成がすでに選択されている場合は、その横にあるをクリックするか、 Shift+F10 を押します。
別の実行構成を選択する場合は、「実行ウィジェット」をクリックします。開いたメニューで、起動したい実行構成の横にある「」をクリックします。
Alt+Shift+F10 を押す。開いたメニューで、起動したい実行構成をクリックします。

実行 / デバッグ構成を共有すると、チームメイトが同じ構成でアプリケーションを実行できたり、実行しているプロセスにリモートでアタッチできるようになります。

PyCharm は、実行 / デバッグ構成をプロジェクトファイルとして保存し、VCS を通じて共有できる仕組みを提供します。同じメカニズムは、構成をファイルとして他のユーザーに送信したり、実行 / デバッグ構成のローカルバックアップを作成したり、ファイルからインポートしたりする場合にも使用できます。

レガシーな .ipr ベースのプロジェクトでは、個別の実行 / デバッグ構成はサポートされていません。レガシープロジェクトでは、 .ipr ファイルを VCS に追加することによってのみ、一度にすべての構成を共有できます。

実行 | 実行構成の編集に進みます。または、実行ウィジェットでをクリックし、ドロップダウンメニューから実行構成の編集を選択します。
共有したい実行 / デバッグ構成を選択し、プロジェクトファイルとして保存オプションを有効にして、構成ファイルの保存場所を指定してください。
PyCharm 2019.3 以前との互換性が必要でない限り、任意の場所を設定できます。これらのバージョンとの互換性を保つには、推奨される場所にファイルを保存してください。
(オプション) .idea ディレクトリが VCS 無視ファイルに追加されると、 .idea/runConfigurations サブフォルダーも無視されます。プロジェクトで Git を使用する場合は、次のように .gitignore を変更することで、 .idea/runConfigurations を共有し、 .idea を無視したままにすることができます。
/.idea/* !/.idea/runConfigurations

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

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

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

実行 | 実行構成の編集に進みます。または、実行ウィジェットでをクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログの左側ペインで、 Edit configuration templates… をクリックしてください。
開いた Run/Debug Configuration Templates ダイアログで、構成タイプを選択します。
必要なデフォルトパラメーターを指定し、 OK をクリックしてテンプレートを保存します。

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

同じ種類の実行 / デバッグ構成が多い場合は、より簡単にアクセスできるようにフォルダーでグループ化できます。

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

実行 | 実行構成の編集に進みます。または、実行ウィジェットでをクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログで、構成タイプを選択し、ツールバーのをクリックします。選択したタイプの新しい空のフォルダーが作成されます。
右側のテキストフィールドにフォルダー名を指定するか、デフォルトの名前を受け入れます。
目的の実行 / デバッグ構成を選択し、ターゲットフォルダーに移動します。
変更を適用します。フォルダーが空の場合、保存されません。

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

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

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

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

メインメニューから View | Tool Windows | Services を選択するか、 Alt+8 を押します。
In the サービス tool window, click Add service, then select 実行構成.
リストから実行 / デバッグ構成タイプを選択して、このタイプの全構成をウィンドウに追加します。
If you have already created one or more configurations of the selected type, PyCharm displays them in a dedicated node. If there are no configurations of the selected type yet, the IDE opens the 新規構成の追加 dialog, where you can create a new run/debug configuration.

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

項目

説明

Python インタープリター

リストから事前設定された Python インタープリターの 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 つ選択してください。詳細は実行 / デバッグ構成へのマクロの追加を参照してください。

作業ディレクトリ

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

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

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

Project

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

環境変数

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

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

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

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

                        Variable1 = Value1
                        Variable2 = Value2

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

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

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

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

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

開始時に実行 / デバッグツールウィンドウを開く

このオプションを使用すると、設定の実行時に実行 / デバッグツールウィンドウが自動的に開きます。

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

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

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

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

Docker コンテナーの設定

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

オプション

すべてのポートを公開する: すべてのコンテナーポートをホストに公開します。これはオプション --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
            
     

2026 年 6 月 1 日