PyCharm 2026.1 Help

FastAPI

作成: Run | Edit Configurations | 新規構成の追加| FastAPI

ツールバー

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

項目

ショートカット

説明

追加ボタン

Alt+Insert

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

削除ボタン

Alt+Delete

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

コピー

Ctrl+D

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

構成を保存

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

新しいフォルダーに移動 / 新しいフォルダーを作成

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

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

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

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

構成の並べ替え

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

共通オプション

項目

説明

名前

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

Allow multiple instances

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

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

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

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

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

FastAPI-specific configuration options

項目

説明

アプリケーションファイル

Specify the file that defines your FastAPI application.

アプリケーション名

Specify the name of the FastAPI application instance. If left empty, PyCharm will attempt to detect it automatically.

Run using

From this list, choose the server used to run the FastAPI application. 利用可能なオプションは次のとおりです:

  • Uvicorn: run the application using Uvicorn(英語).

  • Hypercorn: run the application using Hypercorn(英語).

  • Dev mode: launch the FastAPI application using the server ’ s development mode instead of the standard run mode.

実行オプション

Specify additional command-line options passed to the selected server (for example, --reload delay 10).

自分のコードだけをデバッグ

このオプションを有効にすると、デバッガーはユーザーが記述したコードのみに焦点を当て、外部ライブラリへのステップインをスキップします。

環境変数

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

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

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

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

Variable1 = Value1 Variable2 = Value2

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

Python インタープリター

リストから事前設定された Python インタープリターの 1 つを選択してください。

インタープリターオプション

このフィールドで、インタープリターに渡される コマンドラインオプション(英語)を指定します。 必要に応じて、 Expand the field をクリックし、エディターに文字列を入力します。

作業ディレクトリ

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

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

  • このフィールドを空白のままにすると、PyCharm インストールの bin ディレクトリが使用されます。

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

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

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

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

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

起動前

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

項目

ショートカット

説明

追加ボタン

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

ツールウィンドウにフォーカス

実行 / デバッグ構成を開始したときに、 実行または デバッグツールウィンドウに自動的にフォーカスを移動させるには、このチェックボックスを選択してください。

ログ

次のオプションは、この構成の実行のログ記録に関連しています。 詳細については、 ログオプションの設定 を参照してください。

項目

説明

Specify logs to be shown in the console

アプリケーションの実行中に表示するログファイルを指定します。

追加ボタン をクリックして新しいログを追加します。 ログファイルエイリアスの編集 ダイアログで、次のように構成します。

  • エイリアス: ログが表示されるタブの名前。

  • ログファイルのロケーション: ログファイルまたは Ant パターン(英語)へのパスを指定します。 ローリングログの複数のファイルがパターンに一致する場合、PyCharm は最新のファイルを表示します。

  • Show all files coverable by pattern: パターンに一致するすべてのログを表示します。

テーブル内のログについては、次のオプションを構成できます:

  • アクティブ: 指定したログファイルを表示します。

  • 内容のスキップ: 以前の実行からの古いログメッセージを表示しません。

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

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

Show console when a message is printed to stdout

アプリケーションが標準出力ストリームに書き込む際にコンソールを有効化します。

Show console when a message is printed to stderr

アプリケーションが標準エラーストリームに書き込む際にコンソールを有効化します。

2026 年 6 月 1 日