Python デバッグサーバー

作成: Run | Edit Configurations | | Python デバッグサーバー

リモートデバッグ構成を使用して、デバッグサーバーを起動します。詳細については、リモート PyCharm によるデバッグを参照してください。

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

項目	ショートカット	説明
	`Alt+Insert`	実行 / デバッグ構成を作成します。
	`Alt+Delete`	選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。
	`Ctrl+D`	選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。
		このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。
		新しいフォルダーに移動 / 新しいフォルダーを作成します。実行 / デバッグ構成は、フォルダーに配置することでグループ化できます。フォルダーを作成するには、カテゴリ内の設定を選択し、をクリックしてフォルダー名を指定します。カテゴリだけにフォーカスがある場合は、空のフォルダーが作成されます。次に、設定をフォルダー内、フォルダー間、フォルダー外に移動するには、ドラッグまたはボタンとボタンを使用します。グループ化を解除するには、フォルダーを選択してをクリックします。
		このボタンをクリックすると、設定がアルファベット順にソートされます。

共通オプション

項目	説明
名前	実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。
Allow multiple instances	この実行構成の複数のインスタンスを並行して実行できるようにします。デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、PyCharm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。
プロジェクトファイルとして保存	実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。デフォルトでは無効になっており、PyCharm は実行構成設定を .idea/workspace.xml に保存します。

項目

説明

名前

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

Allow multiple instances

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

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

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

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

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

Python Debug Server-specific configuration options

項目

説明

スクリプトの更新

このセクションには、リモートのデバッグの準備に必要な重要な情報が含まれています。

PyCharm インストールから pydevd-pycharm.egg を Python パスに追加するか、実行してください。

サンプル: pip install pydevd-pycharm~=191.3490

リモート PyCharm によるデバッグの手順説明を参照してください。

デバッグサーバーに接続するには、次のコマンドを追加してください。

以下のコマンドラインステートメントをコピーし、ローカルスクリプトに貼り付けます。

import pydevd_pycharm

pydevd_pycharm.settrace(<host name>, port=<port number>) 、ここ

<host name> は、このデバッグ構成の IDE ホスト名フィールドから取得されます。
<port number> はこのデバッグ構成のポートフィールドから取得した番号、または未指定の場合はコンソールに出力されたランダムな番号です。

IDE ホスト名

リモートデバッグサーバーがアクセス可能な IDE を実行しているマシンの IPアドレスを指定してください。このホスト名は自動的にコマンドラインに代入されます。デフォルトでは、 localhost が使用されます。

ポート

自動的にコマンドラインに代入されるポート番号を指定してください。デフォルトのポート番号（0）を使用した場合は、PyCharm がデバッグ構成の起動ごとにコマンドラインへ任意の番号を代入します。他の値を指定した場合は、その値が常に使われます。

パスマッピング

このフィールドを使用して、ローカルパスとリモートパスのマッピングを作成します。閲覧ボタンをクリックするとパスマッピングの編集ダイアログが開き、新しいパスマッピングの追加や選択したマッピングの削除ができます。ローカルパスはプロジェクトへの絶対パスです。例えば、 /Users/jetbrains/PyCharmProjects/MyDeployment です。リモートパスは SFTP サーバールートパスからの相対パスです。例えば、 /tmp/pycharm_project_923 です。

出力をコンソールにリダイレクトする.

このチェックボックスを選択すると、出力ストリームとエラーストリームが PyCharm コンソールにリダイレクトされ、コマンドラインが stdout_to_server=True, stderr_to_server=True で補完されます。

接続後にサスペンドする

このチェックボックスを選択すると、デバッガーは IDE に接続した直後、 settrace 呼び出しの次の行で一時停止します。

このチェックボックスが選択されていない場合、デバッガーはブレークポイントに到達するか、をクリックしたときにのみ中断し、コマンドラインは suspend=False で補完されます。

起動前

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

項目	ショートカット	説明
	`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` を押すことで、対応するツールウィンドウを自分で開くことができます。
ツールウィンドウにフォーカス		実行 / デバッグ構成を開始したときに、実行またはデバッグツールウィンドウに自動的にフォーカスを移動させるには、このチェックボックスを選択してください。

2026 年 6 月 1 日