実行 / デバッグ構成
PyCharm は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。
さまざまな起動プロパティを使用して、PyCharm がスクリプトを実行するために使用するさまざまな方法を定義できます。例: 異なる Python インタープリターを使用して同じコードを実行し、さまざまな環境変数のセットを提供し、代替ファイルから入力値を取得できます。
実行 / デバッグ構成には 2 つのタイプがあります。
一時的 — 関数またはテストを実行またはデバッグするたびに作成されます。
永続的 — テンプレートから明示的に作成されるか、一時的な構成を保存することによって作成されます。永続的な構成は、削除するまでプロジェクトの一部として残ります。
コードを実行 / デバッグまたはテストするときはいつでも、PyCharm は既存の永続的な実行 / デバッグ構成を使用するか、新しい一時的な構成を作成します。
永続的な構成のアイコンは不透明ですが、一時的な構成のアイコンは半透明です。構成アイコン上の赤い十字は、構成設定にエラーがあることを示します。
一時構成の最大数は 5 です。新しい構成が追加されると、古い構成は自動的に削除されます。必要に応じて、
でこの制限を増やすことができます。永続的な実行 / デバッグ構成を作成する
PyCharm は、永続的な実行 / デバッグ構成を作成する次の方法を提供します。
テンプレートから作成または既存の構成をコピーします。
一時的な構成を永続的なものとして保存する
実行 / デバッグ構成スイッチャーで一時構成を選択し、
/
をクリックして、構成の保存を選択します。
一時構成を保存すると、永続的になり、<project directory>/.idea/ ディレクトリの別の XML ファイルに記録されます。例: MyProject/.idea/Car.xml。
または、実行 / デバッグ構成ダイアログで一時構成を選択し、ツールバーの
をクリックします。
PyCharm は、さまざまな言語、ツール、フレームワーク用の実行 / デバッグ構成テンプレートを提供します。使用可能なテンプレートのリストは、インストールされているプラグインと有効になっているプラグインによって異なります。
テンプレートから実行 / デバッグ構成を作成する
実行ウィジェットで
に進みます。または、をクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログで、ツールバーの
をクリックするか、Alt+Insert を押します。リストには、実行 / デバッグ構成テンプレートが表示されます。Python を選択します。
名前フィールドに実行 / デバッグ構成名を指定します。この名前は、使用可能な実行 / デバッグ構成のリストに表示されます。
実行 / デバッグ構成パラメーターを構成します。必須パラメーターとオプションのパラメーターのリストは、選択した実行 / デバッグ構成型によって異なる場合があります。
一部のオプションのパラメーターは非表示になっています。これらを表示して有効にするには、オプションを変更リンクをクリックします。
Python テンプレートの詳細については、「構成パラメーターの実行 / デバッグ」を参照してください。
構成をすぐに実行することも、構成を保存して後で実行することもできます。
OK をクリックして、後で使用するために実行構成を保存し、ダイアログを閉じます。
構成をすぐに実行するには、「実行」をクリックします。
Python 実行 / デバッグ構成にマクロを追加する
実行ウィジェットで
に進みます。または、をクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログで、Python 実行 / デバッグ構成のリストからターゲット構成を選択します。
次のいずれかのフィールドで「
マクロの挿入」をクリックします。
スクリプトパス
パラメーター
作業ディレクトリ
使用可能なマクロのリストからマクロを選択します。
挿入をクリックして、選択したマクロを追加します。
実行 / デバッグ構成でマクロを使用する例については、実行中のスクリプトにパラメーターを渡すを参照してください。
実行 / デバッグ構成を共有する
チームで作業している場合は、実行 / デバッグ構成を共有して、チームメイトが同じ構成を使用してアプリケーションを実行したり、実行中のプロセスにリモートで接続したりできるようにすることができます。
これらの目的のために、PyCharm は、実行 / デバッグ構成をプロジェクトファイルとして保存し、VCS を通じて共有するためのメカニズムを提供します。同じメカニズムは、構成をファイルとして他の人に送信する場合にも使用できます。これにより、実行 / デバッグ構成が洗練されることがあり、手動で同期を維持するのは面倒でエラーが発生しやすくなるため、多くの時間を節約できます。
実行ウィジェットで
に進みます。または、をクリックし、ドロップダウンメニューから実行構成の編集を選択します。
共有する実行 / デバッグ構成を選択し、プロジェクトファイルとして保存オプションを有効にして、構成ファイルを保存する場所を指定します。
PyCharm 2019.3 以前との互換性が必要でない限り、任意の場所を設定できます。これらのバージョンとの互換性を保つには、推奨される場所にファイルを保存してください。
(オプション) .idea ディレクトリが VCS 無視ファイルに追加された場合、.idea/runConfigurations サブフォルダーも無視されます。プロジェクトに Git を使用する場合は、.gitignore を次のように変更することで、.idea/runConfigurations のみを共有し、.idea を無視したままにすることができます。
/.idea/* !/.idea/runConfigurations
実行 / デバッグ構成テンプレート
すべての実行 / デバッグ構成は、スタートアップロジックを実装し、パラメーターのリストとそのデフォルト値を定義するテンプレートに基づいています。使用可能なテンプレートのリストはインストールで事前定義されており、プラグインを介してのみ拡張できます。ただし、各テンプレートのデフォルトのパラメーター値を編集して、新しい実行 / デバッグ構成のセットアップを合理化することができます。
テンプレートのデフォルト値を構成する
実行ウィジェットで
に進みます。または、をクリックし、ドロップダウンメニューから実行構成の編集を選択します。
実行 / デバッグ構成ダイアログの左側のペインで、構成テンプレートの編集をクリックします。
開いた実行 / デバッグ構成テンプレートダイアログで、構成タイプを選択します。
必要なデフォルトパラメーターを指定し、OK をクリックしてテンプレートを保存します。
実行 / デバッグ構成フォルダー
同じ種類の実行 / デバッグ構成が多数ある場合、フォルダーにグループ化すると、視覚的に区別しやすくなります。
グループ化すると、実行 / デバッグ構成が対応するフォルダーのリストに表示されます。
![グループ化された実行構成 Grouped run configurations](https://resources.jetbrains.com/help/img/idea/2024.1/py_run_config_folder.png)
実行 / デバッグ構成用のフォルダーを作成する
実行ウィジェットで
に進みます。または、をクリックし、ドロップダウンメニューから実行構成の編集を選択します。
「実行 / デバッグ構成」ダイアログで構成タイプを選択し、ツールバーの「
」をクリックします。選択したタイプの新しい空のフォルダーが作成されます。
右側のテキストフィールドにフォルダー名を指定するか、デフォルトの名前を受け入れます。
目的の実行 / デバッグ構成を選択し、ターゲットフォルダーに移動します。
変更を適用します。フォルダーが空の場合、保存されません。
フォルダーが不要になった場合は、Delete を削除できます。このフォルダーにグループ化された実行 / デバッグ構成は、対応する実行 / デバッグ構成タイプのルートに移動されます。
サービスツールウィンドウで実行 / デバッグ構成
サービスツールウィンドウで複数の実行 / デバッグ構成を管理できます。例: 複数のアプリケーションを開始、一時停止、停止し、それらのステータスを追跡し、アプリケーション固有の詳細を調べることができます。
サービスウィンドウに実行 / デバッグ構成を追加する
メインメニューから
を選択するか、Alt+8 を押します。サービスツールウィンドウで、サービスの追加をクリックし、実行構成タイプを選択します。
リストから実行 / デバッグ構成タイプを選択して、このタイプのすべての構成をウィンドウに追加します。
ツールウィンドウには、1 つ以上の構成を作成した構成タイプのみが表示されることに注意してください。
構成パラメーターの実行 / デバッグ
項目 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|
スクリプトパス / モジュール名 | リストをクリックして、実行するターゲットの種類を選択します。次に、対応するフィールドに、Python スクリプトへのパスまたは実行するモジュール名を指定します。 このフィールドではパス変数を使用できます。 | ||||||||
パラメーター | このフィールドには、Python スクリプトに渡すパラメーターを指定します。 スクリプトパラメーターを指定するときは、次の規則に従ってください。
このフィールドでは、マクロを追加して、実行 / デバッグ構成の実行時にさまざまなプロジェクト固有またはコンテキスト固有の値を渡すことができます。+ をクリックして、リストから使用可能なマクロの 1 つを選択します。詳細については、実行 / デバッグ構成へのマクロの追加を参照してください。 | ||||||||
複数のインスタンスを許可する | 構成の複数のインスタンスを同時に実行できるようにする場合は、このオプションを選択します。このオプションが無効になっている場合、構成を再実行しようとすると、アクティブなセッションが終了します。 | ||||||||
環境 | |||||||||
プロジェクト | このリストをクリックして、同じ PyCharm ウィンドウで開いたプロジェクトの 1 つを選択します。このプロジェクトでは、この実行 / デバッグ構成を使用する必要があります。開いているプロジェクトが 1 つしかない場合、このフィールドは表示されません。 | ||||||||
環境変数 | このフィールドには、環境変数のリストが表示されます。リストに複数の変数が含まれている場合、それらはセミコロンで区切られます。 デフォルトでは、フィールドには 1 に設定された変数 新しい変数を作成するには、 テキストファイルに一連のレコードとして格納されている変数をリストに追加することができます。
Variable1 = Value1
Variable2 = Value2
テキストファイルから変数のリストをコピーし、環境変数ダイアログで貼り付け ( | ||||||||
「.env」ファイルへのパス | このフィールドには、環境変数を含む .env ファイルへのパスが表示されます。複数のファイルがある場合、それらのファイルへのパスはセミコロンで区切られます。 .env ファイルのリストを管理するには、「 | ||||||||
Python インタープリター | リストから事前設定された Python インタープリターの 1 つを選択してください。 | ||||||||
インタープリターオプション | このフィールドには、インタープリターに渡すコマンドラインオプション(英語)を指定します。必要に応じて、「 | ||||||||
作業ディレクトリ | 実行中のタスクが使用するディレクトリを指定します。
このフィールドではパス変数を使用できます。 | ||||||||
PYTHONPATH にコンテンツルートを追加する | このチェックボックスを選択して、プロジェクトのすべてのコンテンツルートを環境変数 PYTHONPATH に追加します。 | ||||||||
PYTHONPATH にソースルートを追加する | このチェックボックスを選択して、プロジェクトのすべてのソースルートを環境変数 PYTHONPATH に追加します。 | ||||||||
実行 | |||||||||
出力コンソールでターミナルをエミュレートする | エミュレートされたターミナルモードを使用して、出力コンソールでスクリプトまたはモジュールを実行できるようにします。このモードは、スクリプトがキャレットリターンアクション( 出力コンソールでターミナルをエミュレートすることは、システムシェルコマンドを実行するために使用される別個のツールウィンドウであるターミナルを実行することとは異なることに注意してください。 | ||||||||
Python コンソールで実行する | Python コンソールでスクリプトやモジュールを実行できるようにします。 | ||||||||
次からの入力をリダイレクト | テキストファイルのデータを標準入力にリダイレクトできるようにします。スクリプトに何らかの入力が必要で、実行コンソールに値を入力する代わりに、自動的に値を送信したい場合は、このオプションを使用します。リダイレクトを有効にするには、チェックボックスをオンにして、ターゲットテキストファイルへのパスを指定します。 | ||||||||
Docker コンテナーの設定 | |||||||||
オプション |
| ||||||||
Docker Compose | |||||||||
コマンドとオプション | Docker Compose コマンドラインインターフェースの次のコマンドを使用できます。
| ||||||||
コマンドプレビュー | このフィールドを使用して、完全なコマンド文字列をプレビューします。 例: コマンドとオプションフィールドの
docker compose
-f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml
-f <override configuration file>
up --build exec --user jetbrains
|
関連ページ:
![](https://resources.jetbrains.com/help/img/idea/2024.1/plugins_settings.png)
プラグインのインストール
プラグインは PyCharm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケット...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_run_solver.png)
コード実行支援
前提条件:すでに Python プロジェクトを作成し、次のコードを入力しています。import math def demo(a, b, c): d = b ** 2 - 4 * a * c if d > 0: disc = math.sqrt(d) root1 = (-b + disc) / (2 * a) root2 = (-b - disc) / (2 * a) return root1, root2 elif d == 0: return -b / (2 * a) else: re...
![](https://resources.jetbrains.com/help/img/idea/2024.1/services-add-rc.png)
サービスツールウィンドウ
サービスツールウィンドウを使用すると、実行 / デバッグ構成、データベースセッション、Docker 接続など、ソフトウェア開発中に役立つさまざまなサービスを管理できます。プラグイン開発者は、IntelliJ プラットフォーム API を通じて他のサービスを追加できます。メインツールバーには、すべてのサービスタイプに共通の次のボタンとメニューが含まれています。すべて展開リスト内のすべての項目を展開します。すべて折りたたむリスト内のすべての項目を折りたたみます。グループ化サービスのリストを整理する方...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_path_variable_data_path.png)
パス変数
パス変数を使用して、特定のプロジェクトの一部ではないリソースへの絶対パスを定義します。これらの外部リソースは、チームメイトのコンピューターのさまざまな場所にある場合があります。これが、ユーザー定義のカスタムパス変数がプロジェクト設定として保存されず、グローバル IDE 設定として保存される理由です。設定が完了すると、そのようなパス変数は、PyCharm のインスタンスで開くすべてのプロジェクトに対して同じ値になります。新しいパス変数を作成するを押して設定を開き、を選択します。をクリックし、変数の...
![](https://pleiades.io/icons/pycharm.png)
コンテンツルート
PyCharm では、コンテンツは現在作業しているファイルのコレクションであり、場合によってはサブフォルダーの階層に編成されています。この階層の最上位にあるフォルダーは、コンテンツルートフォルダー、または略してコンテンツルート (として表示) と呼ばれます。プロジェクトには少なくとも 1 つのコンテンツルートフォルダーがあり、デフォルトではプロジェクトフォルダーそのものです。いくつかのコンテンツルートを持つことで、共通の直系親を持たない複数のディレクトリからのファイルを扱うことができます。これは、...
![](https://resources.jetbrains.com/help/img/idea/2024.1/SSH_session_dialog.png)
ターミナルエミュレータ
PyCharm には、IDE 内からコマンドラインシェルを操作するための組み込みターミナルエミュレータが含まれています。専用のターミナルアプリケーションに切り替えることなく、Git コマンドの実行、ファイルのアクセス許可の設定、その他のコマンドラインタスクの実行に使用します。ターミナルプラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっているターミナルプラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してくだ...