PyCharm 2024.3 ヘルプ

新規ウォッチャーダイアログ

File Watchers ページ追加 the Add button または編集 the Edit button ボタンをクリックすると、ダイアログが開きます。このダイアログを使用して、定義済みの PyCharm File Watcher テンプレートに基づいてプロジェクト File Watcher を作成したり、既存のプロジェクト File Watcher を編集したりします。

各テンプレートには、選択したツールに最適な設定が含まれています。ほとんどの場合、必要なのは、ツールの実行可能ファイルへのパスを指定することだけです。

名前

名前フィールドに、File Watcher の名前を入力します。デフォルトでは、PyCharm は選択された定義済みテンプレートの名前を提案します。

監視するファイル

ファイルタイプ

このリストを使用して、予想される入力ファイルの種類を指定します。File Watcher は、この種類のファイルのみを分析および処理の対象と見なします。ファイルの種類は、ファイルの種類とファイル拡張子の関連付けに基づいて認識されます。

スコープ

このリストを使用して、ファイル監視を適用できるファイルの範囲を定義します。

これらのファイルを変更すると、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスの状態に応じて、直ちに、または保存またはフレームの非アクティブ化時にファイル監視が起動されます。

リストから定義済みスコープの 1 つを選択します。プロジェクトレベルのファイル監視の場合は、the Browse button をクリックして、表示されるスコープダイアログでカスタムスコープを設定することもできます。

  • すべての場所 : 下記のすべての範囲

  • プロジェクトファイル : プロジェクトコンテンツルート内のすべてのファイル ( プロジェクト構造の設定を参照)。

  • プロジェクトのプロダクション用ファイル : テストソースを除くプロジェクトコンテンツルート内のすべてのファイル。

  • プロジェクトテストファイル : プロジェクト内のすべてのファイルがテストソースのルートになります。

  • スクラッチとコンソール : プロジェクトツールウィンドウにあるスクラッチとコンソールディレクトリからのすべてのファイル。

  • 開いているファイル : 現在エディターで開かれているすべてのファイル。

  • 現在のファイル : アクティブなエディタータブで開かれたファイル

VCS スコープ : これらのスコープは、プロジェクトがバージョン管理されている場合にのみ使用できます。

  • すべての変更ファイル : すべての変更されたファイル、つまりすべての既存の変更リストに関連付けられたすべてのファイル。

  • デフォルト変更リスト : 変更リスト Default に関連付けられているすべてのファイル。

または、the Browse button をクリックし、開いたスコープダイアログでカスタムスコープを構成します。

ルートファイルのみを追跡する

ルートファイルとは、指定された範囲内の他のファイルに含まれていないファイルです(たとえば import を介して)。

  • このチェックボックスをオンにすると、File Watcher はルートファイルに対してのみ実行されます。

  • チェックボックスをオフにすると、File Watcher はファイルウォッチャーが呼び出されたファイルに対して実行され、このファイルが指定されたスコープ内に再帰的に含まれるすべてのファイルに対して実行されます。

スコープ設定はルートファイルのみを追跡するチェックボックスの設定よりも優先されることに注意してください。依存関係が指定されたスコープの外にある場合、ファイルウォッチャーはそれに適用されません。

2 つのファイル root.scssanother.scss があり、root.scssanother.scss をインポートしているとします。ルートファイルのみを追跡するチェックボックスをオンにすると、another.scss を編集すると、root.scss でのみ File Watcher が呼び出されます。チェックボックスをオフにすると、File Watcher はこれらの両方のファイルを処理します。

変更時に実行するツール

この領域では、ツールとの対話を構成します。使用する実行可能ファイル、渡す引数、PyCharm がツールの出力を探す場所を指定します。

プログラム

このフィールドには、ツールの実行可能ファイルへのパスを指定します。( .com.exe.cmd.bat または特定のツールに応じたその他。)

引数

このフィールドでは、ツールに渡す引数を定義してツールの動作に影響を与えます。

引数は通常、実際のファイル名に置き換えられる $FileName$$FileNameWithoutExtension$ などのマクロを使用して指定されます。

マクロを手動で入力するか、the Insert Macros icon をクリックして、開いたマクロダイアログのリストから関連するパターンを選択します。

リフレッシュする出力パス

このフィールドで、PyCharm にツールの出力を検索する場所(結果のソースコード、ソースマップ、依存関係、ファイル自体)を指定します。出力の場所はツールによって異なります。

通常、出力パスはマクロを使用して指定されます。手動で入力するか、the Insert Macros icon をクリックして、開いたダイアログのリストから関連するものを選択できます。

複数のマクロを指定するには、区切り文字としてコロン : を使用します (例: $FileNameWithoutExtension$.css:$FileNameWithoutExtension$.css.map)。

作業ディレクトリと環境変数

作業ディレクトリ

このフィールドでは、ツールが適用されるディレクトリを指定します。ツールは常にファイルのコンテキストで呼び出されるため、デフォルトの作業ディレクトリは現在のファイルのディレクトリです。デフォルトの作業ディレクトリは、$FileDir$ マクロを使用してすべての定義済みテンプレートで指定されます。カスタム作業ディレクトリを指定するには、そのパスをフィールドに入力するか、the Browse icon をクリックしてパスの選択ダイアログでディレクトリを選択するか、the Insert Macros icon をクリックしてマクロダイアログのリストから目的のマクロを選択します。

環境変数

このフィールドには、ツールが必要とするがオペレーティングシステムレベルでは指定されていない環境変数を指定します。

拡張オプション

編集したファイルを自動保存してウォッチャーをトリガーする

  • このチェックボックスをオンにすると、PyCharm はファイルを編集するとすぐに保存し、File Watcher はすぐに起動します。

  • チェックボックスをオフにすると、保存時 ( ファイル | すべて保存 ) または PyCharm からフォーカスを移動したとき (フレームの非アクティブ化時) に File Watcher が起動します。

外部の変更でウォッチャーをトリガーする

  • このチェックボックスをオンにすると、File Watcher は、PyCharm 外で行われた変更や、バージョン管理システムでブランチをチェックアウトした後の変更など、そのスコープ内のファイルに対するすべての変更で起動します。

  • チェックボックスをオフにすると、File Watcher は、そのスコープ内のファイルが PyCharm から更新された場合にのみ起動し、バージョン管理システムから受信した変更など、その他の変更は無視されます。

構文エラーに関係なく監視をトリガーする

  • チェックボックスをオンにすると、File Watcher はファイルの構文上の正確さに関係なく起動します。ファイルウォッチャーは、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスの状態に応じて、更新、保存、フレームの非アクティブ化時に開始されます。

  • このチェックボックスをオフにすると、File Watcher は構文上無効なファイル内のすべてのトリガーを無視し、エラーのないファイルでのみ起動します。

stdout から出力ファイルを作成する

  • ほとんどの場合、このチェックボックスは、ほとんどのツールが関連するファイルに直接出力を書き込むため、クリアする必要があります。

  • このチェックボックスを選択すると、PyCharm はネイティブツールの出力 standard output stream (stdout) を読み込み、そこから結果ファイルを生成します。生成されたファイルの名前はリフレッシュする出力パスフィールドから取られます。フィールドに複数の名前が含まれている場合は、リストの最初の名前が使用されます。

コンソールの表示

このリストから、File Watcher がいつコンソールを開くかを選択します。

  • 常時 : このオプションを使用すると、ツールの実行が完了した後にコンソールが常に開きます。

  • エラー時 : このオプションを使用すると、Exit code0 と異なる場合にのみツール実行後にコンソールが開きます。

  • なし : コンソールをまったく開かないようにするには、このオプションを選択します。

出力フィルター

このフィールドで、ツールに関連付けられている出力フィルターを指定します。これらのフィルターに基づいて、ツールの出力の絶対ファイルパスと行番号がハイパーリンクに変換されます。これらのリンクをクリックすると、対応するファイルがエディターで開きます。

例: 有用なエラーメッセージを表示するには、$FILE_PATH$:$LINE$ $MESSAGE$ と入力します

関連ページ:

プラグインのインストール

プラグインは PyCharm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケット...

プロジェクトのセキュリティ

潜在的なセキュリティリスクを防ぐために、PyCharm では、プロジェクトのソースがわからない場合にプロジェクトを開く方法を決定できます。PyCharm は、オープニングプロセス中に実行されるタスクまたは構成について警告し、信頼できるソースを構成できるようにします。不明なソースからプロジェクトを開く:プロジェクトを開くと、PyCharm を使用すると、未知ソースコードを含むプロジェクトの処理方法をすぐに決定できます。プロジェクトを初めて開くたびに、IDE にプロジェクトを信頼ダイアログが表示さ...

File Watchers

このページは、File Watchers プラグインが有効になっている場合に使用できます。File Watchers の構成の詳細については、File Watchers を参照してください。File Watchers プラグインは PyCharm にバンドルされており、デフォルトで有効になっています。プラグインが無効になっている場合は、プラグインのマッピングの説明に従って、設定 | プラグインページのインストール済みタブで有効にします。File Watcher は、ファイルの変更を追跡し、サードパーティ...

ファイルタイプの関連付け

PyCharm は、さまざまな言語やテクノロジを表すファイルの言語固有の機能(構文のハイライトやコード分析など)について、ファイルタイプのリストを保持します。各ファイルタイプは、言語サービスを 1 つ以上のファイル名パターンにリンクします。ファイルタイプのデフォルトリストには、関連するすべてのファイル名パターンが含まれていますが、カスタム言語ファイルに新しいファイルタイプを追加したり、既存のファイルタイプに関連付けられたファイル名パターンを変更したりできます。エディターでファイルを開くと、PyC...

プロジェクト構造の設定

PyCharm では、コンテンツは現在作業しているファイルのコレクションであり、サブフォルダーの階層に編成されている可能性があります。プロジェクトの最上位フォルダーは、そのコンテンツルートです。コンテンツルート内では、PyCharm はソースコードを含むフォルダーと、検索、解析、監視などの際に無視されるフォルダーを区別できます。さまざまなタイプのフォルダーを区別するには、コンテンツルートのフォルダーをソースフォルダーまたは除外フォルダーとしてマークします。ソースルートには、実際のソースファイルとリ...

バージョン管理統合サポート

PyCharm は 2 つのレベルでバージョン管理統合をサポートします。IDE レベルでは、VCS 統合は、デフォルトで有効になっているバンドルされたプラグインのセットを通じて提供されます。プロジェクトレベルでは、プロジェクトフォルダーを 1 つまたは複数のバージョン管理システムと関連付けることで、VCS 統合が有効になります。プロジェクトルートをバージョン管理システムに関連付ける:PyCharm を使用すると、プロジェクトとバージョン管理システムの統合を迅速に有効にし、それをプロジェクトルー...