PyCharm 2024.3 ヘルプ

組み込みの IDE マクロ

PyCharm は、外部ツール実行構成のさまざまなパス、オプション、その他のコマンドライン引数を指定するために使用できる変数である、多数の組み込みマクロを提供します。値としてマクロを受け入れるダイアログフィールドには、プラスアイコン が表示されます。

Add an IDE macro

マクロの値は現在のコンテキストによって異なります。例: 現在のファイルを含むディレクトリの名前を渡す必要がある場合は $FileDirName$、完全なパスが必要な場合は $FileDir$ を使用します。

マクロ

説明

$WORKSPACE_DIR$

現在のプロジェクトが属するワークスペースへのパス。ワークスペースは、開いているファイル階層のルートであり、複数のプロジェクトを含めることができます。

$PROJECT_DIR$

run.json が配置されているプロジェクトのルート。プロジェクトは通常、Maven プロジェクトや Node.js プロジェクトなどのアプリケーションを開発および構築するためのファイルのコレクションです。

$USER_HOME$

ユーザーのホームディレクトリ。

$FILE$

現在のファイルへの絶対パス (拡張子を含む)。

$AffectedModuleNames$

コンマで区切られた、現在のファイルに関連するモジュールの名前。

$ClipboardContent$

システムクリップボードの現在の内容。

$ColumnNumber$

現在のファイルでキャレットが配置されている列番号。

$ContentRoot$

現在のファイルが属するコンテンツルートへのパス。

$FileDir$

現在のファイルを含むディレクトリへの絶対パス。

$FileDirName$

現在のファイルを含むディレクトリの名前。

$FileDirPathFromParent(dir)$

パラメーター dir として指定された親ディレクトリを基準にした現在のファイルを含むディレクトリへのパス。

Argument 1: /Users/jetbrains/myProjects/FileDirPathFromParent/ Argument 2: 1

$FileDirRelativeToProjectRoot$

モジュールのコンテンツルートに相対的な現在のファイルを含むディレクトリへのパス。

$FileDirRelativeToSourcepath$

ソースパスルートを基準にした現在のファイルを含むディレクトリへのパス。

$FileEncoding$

現在のファイルのエンコーディング

$FileExt$

現在のファイルの拡張子。

$FileName$

現在のファイルの名前(すべての拡張子を含む)。

$FileNameWithoutAllExtensions$

拡張子のない現在のファイルの名前。これは、ファイルの拡張子が重複している場合に役立ちます。ピリオドとそれに続くすべてのものが削除されます。

例: ファイルが hello.txt.txt の場合、$FileNameWithoutAllExtensions$ マクロは hello を返します。

$FileNameWithoutExtension$

拡張子のないファイルの名前。これにより、ピリオドの 1 回だけが削除され、その後に延長が続きます。

例: ファイルが hello.txt.txt の場合、$FileNameWithoutExtension$ マクロは hello.txt を返します。

$FileParentDir$

現在のファイルが置かれているディレクトリへの親ディレクトリの名前。

$FilePath$

現在のファイルへの絶対パス。

$FilePathRelativeToProjectRoot$

モジュールのコンテンツルートに相対的な現在のファイルへのパス。

$FilePathRelativeToSourcepath$

ソースパスルートを基準にした現在のファイルへのパス。

$FilePrompt$

ファイルを選択するためのファイルシステムダイアログを表示します。

$FileRelativeDir$

モジュールのコンテンツルートを基準とした、現在のファイルが配置されているディレクトリへのパス。

$FileRelativePath$

モジュールのコンテンツルートに相対的な現在のファイルへのパス。

$IsMake$

コンパイルが make で実行された場合、true を返します。

$LineNumber$

現在のファイルでキャレットが配置されている行番号。

$ModuleFileDir$

現在のモジュールファイルが配置されているディレクトリへの絶対パス。

$ModuleFilePath$

現在のモジュールファイルへの絶対パス。

$ModuleName$

拡張子のない現在のモジュールファイルの名前。

$ModuleSdkPath$

プロジェクトインタープリターへのパス。

$ModuleSourcePath$

現在のモジュールのソースパス。

$OSName$

小文字のオペレーティングシステム名。

最初のスペース文字まで切り詰められた System.getProperty("os.name") の値を返します。特定のバージョンは含まれず、windowsmaclinux などの OS ファミリのみが含まれます。

$Password$

パスワードを指定するためのダイアログを表示します。$Prompt$ と似ていますが、入力はマスクされます。

オプションでコロンの後に追加してプロンプトテキストを指定することもできます。例:: $Password:API token$

$ProjectFileDir$

現在のプロジェクトディレクトリへの絶対パス。

$ProjectName$

現在のプロジェクトディレクトリの名前。

$Projectpath$

現在のプロジェクトのソースパス。

$Prompt$

任意の文字列を渡すためのダイアログを表示します。

オプションでプロンプトテキストとデフォルト値をコロンで区切って指定することもできます。例:: $Prompt:Username:Alice$

$PyInterpreterDirectory$

プロジェクト用に選択された Python インタープリターを含むディレクトリ。

$RemoteProjectFileDir$

リモートサーバー上のプロジェクトディレクトリへの絶対パス。

$SelectedText$

エディターで現在選択されているテキスト。

$SelectionEndColumn$

選択が終了する列番号。

$SelectionEndLine$

選択が終了する行番号。

$SelectionStartColumn$

選択が開始される列番号。

$SelectionStartLine$

選択が開始される行番号。

$Sourcepath$

プロジェクトの完全なソースパス。

$SourcepathEntry$

現在のファイルに関連するソースパスのエントリ。

$TempDir$

一時ファイルのディレクトリ。

Windows では、%TEMP% 環境変数の値を返すか、ユーザーのホームディレクトリ内の AppData\Local\Temp ( System.getProperty("user.home") によって返される) にフォールバックします。

他のオペレーティングシステムでは、$TempDir$/tmp を返します。

$UnixSeparators(path)$

パラメーターとしてパスを取り、すべての区切り文字をスラッシュに変換します。

例: $UnixSeparators(\foo\bar)$/foo/bar を返します。

プロジェクト外のリソースへのパス

パス変数を使用して、プロジェクト外のリソースを指すことができます。マクロを追加するのと同じ方法で、変数の前後にドル記号を付けて、構成済みのパス変数を追加します (例: $MY_VAR$)。

新しいパス変数を作成する

  1. Ctrl+Alt+S を押して設定を開き、外観 & 振る舞い | パス変数を選択します。

  2. the Add button をクリックし、変数の名前と値を入力し、OK をクリックして変更を適用します。

カスタムマクロ

com.intellij.ide.macro.Macro 拡張ポイントを使用して、プラグインのカスタムマクロを定義できます。その後、マクロを plugin.xml に登録します。

<macro implementation="full.macro.class.Name"/>

利用可能な拡張ポイントの詳細については、「IntelliJ プラットフォームプラグイン SDK ドキュメント(英語)」を参照してください。

関連ページ:

外部ツール

サードパーティのコマンドラインアプリケーションを外部ツールとして構成して、PyCharm から実行します。例: ワークフローでは、特定のスクリプト、コードジェネレーター、アナライザー、プリプロセッサーまたはポストプロセッサー、データベースユーティリティなどの実行が必要になる場合があります。外部ツールとして構成することにより、PyCharm は専用のアクションを提供します。これは、メインメニューや特定のコンテキストメニューから実行したり、ショートカットを割り当てたり、特定の実行構成を起動するときに...

実行 / デバッグ構成

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

エンコード

ファイルを正しく表示および編集するには、PyCharm は使用するエンコーディングを認識する必要があります。ソースコードファイルは通常、UTF-8 でエンコードされます。他の要件がない限り、これが推奨されるエンコードです。ファイルのエンコーディングを決定するために、PyCharm は次の手順を使用します。バイトオーダーマーク (BOM) が存在する場合、PyCharm は他のすべての設定に関係なく、対応する Unicode エンコードを使用します。詳細については、バイト順マークを参照してください。...

パス変数

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

ログファイルエイリアスの編集ダイアログ

実行 / デバッグ構成ダイアログのログタブのまたはボタンをクリックするとダイアログが開きます。このダイアログを使用して、実行またはデバッグツールウィンドウの専用タブに表示するファイルまたはファイルのグループを指定します。エイリアスこのフィールドに、ログエントリのエイリアスを入力します。このエイリアスは、ログタブと実行またはデバッグツールウィンドウツールウィンドウの専用タブのヘッダーに表示されます。ログファイルのロケーションこのフィールドには、実行中またはデバッグ中に表示するログファイルを指定しま...

スコープ言語構文リファレンス

スコープ言語を使用して、プロジェクトスコープ(ファイル、ディレクトリ、サブディレクトリのセット)を指定できます。ファイルのセット:単一のファイルを追加するには、ファイル名を使用します (たとえば、)、サブディレクトリのないディレクトリにすべてのファイルを追加するには、スラッシュの後にアスタリスクを使用します(たとえば:)、サブディレクトリのあるディレクトリ内のすべてのファイルを追加するには、二重スラッシュの後にアスタリスクを使用します (たとえば、)、論理演算子:スコープを定義するときは、論...