PyCharm 2020.1ヘルプ

実行/デバッグ構成: Python

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

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

前提条件

開始する前に、Pythonと関連するフレームワークがインストールされていることを確認してください。

詳細については、それぞれのダウンロードおよびインストールページを参照してください。

このダイアログを使用して、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\", \"platform\": \"unix\"}"
    .

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

環境

環境変数

このフィールドには環境変数のリストが表示されます。リストに複数の変数が含まれている場合、それらはセミコロンで区切られています。
デフォルトでは、このフィールドには1に設定された変数 PYTHONUNBUFFERED が含まれています。リストを埋めるには、参照ボタンをクリックするか、Shift+Enter を押して環境変数ダイアログで目的の環境変数を指定します。
新しい変数を作成するには、the Add buttonをクリックして希望の名前と値を入力します。テキストファイルに一連のレコードとして格納されている変数をリストに追加することができます。次に例を示します。

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

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コマンドラインオプションを指定します。

icons actions down をクリックして表を展開します。リストを作成するには、icons general add , icons general removeまたは icons actions edit をクリックしてください。

Docker Compose

コマンドとオプション

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

コマンド

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

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

--build , --abort-on-container-exit , --timeout TIMEOUT , --exit-code-from SERVICE , --scale SERVICE=NUM... , SERVICE...

run(英語) —サービスに対して1回限りのコマンドを実行します。リファレンスドキュメントを参照してください。

--name NAME , --entrypoint CMD , -l, --label KEY=VAL , -u, --user="" , --rm , -p, --publish=[] , --service-ports , --use-aliases , -v, --volume=[] .

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

--privileged , -u, --user USER , --index=index .

コマンド・プレビュー

このフィールドを展開すると、完全なコマンド文字列をプレビューできます。

サンプル: コマンドとオプション項目に以下の組み合わせを入力した場合:

up --build exec --user jetbrains

プレビュー出力は次のようになります。

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

ログタブ

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

項目

説明

アクティブ

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

ログ・ファイル・エントリー

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

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

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

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

内容のスキップ

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

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

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

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

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

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

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

the Add button

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

the Edit button

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

the Delete button

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

the Browse button

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

共通

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

項目

説明

名前

実行/デバッグ構成の名前を指定して、たとえば実行ポップアップ Shift+Alt+F10から構成を編集または実行するときにすばやく識別します。

並列実行を許可する

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

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

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

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

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

ツールバー

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

項目

ショートカット

説明

the Add buttonAlt+Insert

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

the Remove buttonAlt+Delete

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

CopyCtrl+D

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

Save configuration

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

Edit Templates

テンプレート(つまり、デフォルトの実行/デバッグ構成設定)を表示および編集します。テンプレートはテンプレートノードに表示され、新しく作成された構成に使用されます。

Method up / Method down

Alt+Up / Alt+Down

選択した実行/デバッグ構成をリスト内で上下に移動します。

リスト内の設定の順序によって、実行/デバッグ構成を選択したときに表示される設定の順序が決まります。

実行/デバッグ構成のデフォルトのテンプレートは、常にアルファベット順にソートされています。

Move into new folder / Create new folder

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

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

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

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

Sort configurations

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

起動前

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

項目

ショートカット

説明

the Add buttonAlt+Insert

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

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

  • 別の構成を実行 : 別の実行/デバッグ構成を実行することを選択します。開いたダイアログで、実行する設定を選択します。

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

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

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

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

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

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

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

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

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

    開いたNPMスクリプトダイアログで、npm実行/デバッグ構成設定を指定します。
  • CoffeeScript ソース・マップの生成 : CoffeeScriptソースのソースマップを生成するには、このオプションを選択してください。表示されるダイアログで、CoffeeScriptのソースファイルがある場所を指定します。

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

the Remove buttonAlt+Delete

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

EditEnter

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

Method up / Method down

Alt+Up / Alt+Down

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

このページを表示する

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

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

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

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

最終更新日: 2020年7月6日

関連ページ:

実行/デバッグ構成を操作する

PyCharmでコードを実行またはデバッグするには、実行/デバッグ構成を使用できます。各実行/デバッグ構成は、名前付きの実行/デバッグ起動プロパティのセットを表します。PyCharmを使用して実行、デバッグ、またはテストの操作を実行するときは、常にそのパラメーターを使用して、既存の構成のいずれかに基...

コード実行支援

前提条件:PyCharmバージョン5.0以降を使用しています。すでにPythonプロジェクトを作成し、次のコードを入力しています。 import math def demo(a, b, c): d = b ** 2 - 4 * a * c if d > 0:

Docker

以下は、Docker統合とPython Dockerプラグインがインストールされて使用可能になっている場合にのみ有効です。Dockerを使用すると、開発者は本番環境と同じ環境でコードをテストするためにコンテナー内にアプリケーションをデプロイできます。PyCharmはDockerプラグインを使用してD...

実行ツール・ウィンドウ

実行ツールウィンドウには、アプリケーションで生成された出力が表示されます。複数のアプリケーションを実行している場合は、それぞれが実行/デバッグ構成が適用された後に名前が付けられたタブに表示されます。各タブの外観は、実行されているアプリケーションのタイプに依存し、追加のツールボックスやペインを含めるこ...

デバッグツールウィンドウ

このツールウィンドウは、デバッグを開始すると使用可能になります。アプリケーションのデバッグセッションによって生成された出力が表示されます。複数のアプリケーションをデバッグする場合、各アプリケーションの出力は、対応する実行/デバッグ構成の名前を付けた別のタブに表示されます。各アプリケーションには、次の...

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

同じタイプの実行/デバッグ構成が多すぎる場合、フォルダーにグループ化して、視覚的に区別しやすくすることができます。フォルダーが不要になったら、削除できます。このフォルダーにグループ化された実行/デバッグ構成は、対応する実行/デバッグ構成タイプのルートに移動されます。グループ化すると、実行/デバッグ構...