PyCharm 2024.3 ヘルプ

実行 / デバッグ構成: Python

作成: 実行 | 実行構成の編集 | Add New Configuration | Python

初めてアプリケーションを実行すると、PyCharm は自動的に一時的な実行 / デバッグ構成を作成します。デフォルトのパラメーターを指定または変更して永続的な Run/Debug 設定として保存するように変更できます。

このダイアログを使用して、Python スクリプトの実行 / デバッグ構成を作成します。

構成タブ

項目

説明

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

リストをクリックして、実行するターゲットの種類を選択します。次に、対応するフィールドに、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

ログタブ

このタブを使用して、コンソールまたは実行またはデバッグツールウィンドウの専用タブに表示される実行中またはデバッグ中に生成されるログファイルを指定します。

項目

説明

アクティブ

この列のチェックボックスを選択すると、ログエントリが実行ツールウィンドウまたはデバッグツールウィンドウの対応するタブに表示されます。

ログファイルエントリ

この列の読み取り専用フィールドには、表示するログファイルの一覧が表示されます。リスト

  • 特定のファイルへのフルパス。

  • 完全なパスやパターンを代用する別名。これらのエイリアスは、対応するログファイルが表示されているタブのヘッダーにも表示されます。

    ログエントリパターンで複数のファイルが定義されている場合、タブヘッダーにはログエントリエイリアスではなくファイルの名前が表示されます。

内容のスキップ

選択したログの以前の内容をスキップするには、このチェックボックスを選択します。

コンソール出力をファイルに保存する

このチェックボックスを選択して、コンソール出力を指定した場所に保存します。パスを手動で入力するか、参照ボタンをクリックして、表示されるダイアログで目的の場所をポイントします。

メッセージが標準出力ストリームに出力されたときにコンソールを表示する

関連付けられているプロセスが Standard.out に書き込んだ場合は、このチェックボックスをオンにして出力コンソールをアクティブにして前面に表示します。

メッセージがエラー出力ストリームに出力されたときにコンソールを表示する

関連付けられているプロセスが Standard.err に書き込んだ場合は、このチェックボックスをオンにして出力コンソールをアクティブにして前面に表示します。

the Add button

このボタンをクリックするとログファイルエイリアスの編集ダイアログが開き、新しいログエントリを選択してエイリアスを指定できます。

the Edit button

このボタンをクリックすると、ログファイルエイリアスの編集ダイアログの選択したログファイルエントリのプロパティを編集できます。

the Delete button

選択したログエントリをリストから削除するには、このボタンをクリックします。

the Browse button

このボタンをクリックすると、選択ログファイルのエントリを編集できます。このボタンは、項目が選択されている場合にのみ使用できます。

共通設定

実行構成を編集するとき(ただし実行構成テンプレートは編集しないとき)、次のオプションを指定できます。

項目

説明

名前

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

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

この実行構成の複数のインスタンスを並行して実行できるようにします。

デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、PyCharm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。

プロジェクトファイルとして保存

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、.idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、PyCharm は実行構成設定を .idea/workspace.xml に保存します。

ツールバー

実行 / デバッグ構成のツリー表示には、プロジェクトで使用可能な構成を管理したり、デフォルトの構成テンプレートを調整したりするのに役立つツールバーがあります。

項目

ショートカット

説明

the Add button

Alt+Insert

実行 / デバッグ構成を作成します。

the Remove button

Alt+Delete

選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。

Copy

Ctrl+D

選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。

Save configuration

このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。

Move into new folder / Create new folder

新しいフォルダーに移動 / 新しいフォルダーを作成します。実行 / デバッグ構成は、フォルダーに配置することでグループ化できます。

フォルダーを作成するには、カテゴリ内の設定を選択し、Folder をクリックしてフォルダー名を指定します。カテゴリだけにフォーカスがある場合は、空のフォルダーが作成されます。

次に、設定をフォルダー内、フォルダー間、フォルダー外に移動するには、ドラッグまたは Move Up ボタンと Move Down ボタンを使用します。

グループ化を解除するには、フォルダーを選択して Remove Configuration をクリックします。

Sort configurations

このボタンをクリックすると、設定がアルファベット順にソートされます。

起動前

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

項目

ショートカット

説明

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 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

関連ページ:

実行 / デバッグ構成

PyCharm は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。さまざまな起動プロパティを使用して、PyCharm がスクリプトを実行するために使用するさまざまな方法を定義できます。例: 異なる Python インタープリターを使用して同じコードを実行し、さまざまな環境変数のセットを提供し、代替ファイルから入力値を取得できます。実行 / デバッグ構成には...

パス変数

パス変数を使用して、特定のプロジェクトの一部ではないリソースへの絶対パスを定義します。これらの外部リソースは、チームメイトのコンピューターのさまざまな場所にある場合があります。これが、ユーザー定義のカスタムパス変数がプロジェクト設定として保存されず、グローバル IDE 設定として保存される理由です。設定が完了すると、そのようなパス変数は、PyCharm のインスタンスで開くすべてのプロジェクトに対して同じ値になります。新しいパス変数を作成するを押して設定を開き、を選択します。をクリックし、変数の...

コード実行支援

前提条件:すでに 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...

コンテンツルート

PyCharm では、コンテンツは現在作業しているファイルの集まりであり、おそらくサブフォルダーの階層に編成されています。この階層の最上位にあるフォルダーは、コンテンツルートフォルダーまたはコンテンツルート (と表示) と呼ばれます。プロジェクトには少なくとも 1 つのコンテンツルートフォルダーがあり、既定ではプロジェクトフォルダー自体です。いくつかのコンテンツルートを持つことで、共通の直系親を持たない複数のディレクトリからのファイルを扱うことができます。これは、静的コンテンツ(アイコンなど)を使...

ターミナルエミュレータ

PyCharm には、IDE 内からコマンドラインシェルを操作するための組み込みターミナルエミュレータが含まれています。専用のターミナルアプリケーションに切り替えることなく、Git コマンドの実行、ファイルのアクセス許可の設定、その他のコマンドラインタスクの実行に使用します。ターミナルプラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっているターミナルプラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してくだ...

Docker

Docker は、分離された再現可能な環境で実行可能ファイルをデプロイおよび実行するためのツールです。これは、たとえば、本番環境と同じ環境でコードをテストする場合に役立ちます。PyCharm は Docker 機能を統合し、Docker イメージの作成、Docker コンテナーの実行、Docker Compose アプリケーションの管理、パブリックおよびプライベート Docker レジストリの使用など、IDE から直接実行するための支援を提供します。Docker コンテナーにデプロイされたさまざま...