Visual Studio で Python プロジェクトのカスタムコマンドを定義する

Python プロジェクトを開発するときに、コマンドウィンドウに切り替えて特定のスクリプトやモジュールを実行したり、pip コマンドを実行したり、コードで他のツールを使用したりできます。ワークフローを改善するために、Visual Studio の Python プロジェクトメニューにカスタムコマンドを追加できます。カスタム Python コマンドは、コンソールウィンドウまたは Visual Studio 出力ウィンドウで実行できます。正規表現を使用して、コマンド出力からエラーと警告を解析する方法を Visual Studio に指示することもできます。

[前提条件]

Python ワークロードをサポートしてインストールされた Windows 上の Visual Studio。詳細については、「 Visual Studio での Python サポートのインストール」を参照してください。

Visual Studio for Mac はサポートされていません。 Windows、Mac、Linux 上の Visual Studio Code は、使用可能な拡張機能を通じて Python と適切に連携します。

カスタムコマンドを調べる

既定では、 Python プロジェクトメニューには、 PyLint の実行 と Mypy の実行という 2 つのコマンドが含まれています。

定義したカスタム Python コマンドは、この同じメニューに表示されます。カスタムコマンドは、Python ファイル、Python モジュール、インライン Python コード、任意の実行可能ファイル、または pip コマンドを参照できます。また、コマンドの実行方法と場所を指定することもできます。

カスタムコマンドは、いくつかの方法で追加できます。

Python プロジェクトファイル (.pyproj) でカスタムコマンドを直接定義します。これらのコマンドは、その特定のプロジェクトに適用されます。
ターゲットファイル (.targets) でカスタムコマンドを定義します。このファイル内のコマンドを簡単にインポートして、複数のプロジェクトで使用できます。
カスタム Python コマンドを定義する Python プロジェクトを Visual Studio のプロジェクトテンプレートから作成します。

Visual Studio の特定の Python プロジェクトテンプレートでは、ターゲットファイルを使用してカスタムコマンドを追加します。 Bottle Web Project テンプレートと Flask Web プロジェクトテンプレートには、 サーバーの開始 と デバッグサーバーの開始という 2 つのコマンドが追加されます。 Django Web プロジェクトテンプレートでは、次のコマンドとさらにいくつかのコマンドが追加されます。

プロジェクトを再読み込みしてカスタムコマンドにアクセスする

Visual Studio でプロジェクトを開くときに、エディターで対応するプロジェクトファイルに変更を加えた場合は、プロジェクトを再読み込みして変更を適用する必要があります。同様に、Python プロジェクトファイルでカスタム Python コマンドを定義した後、Python プロジェクトメニューにコマンドが表示されるように Python プロジェクトを再読み込みする必要があります。ターゲットファイルで定義されているカスタムコマンドを変更する場合は、そのターゲットファイルをインポートするすべてのプロジェクトに対して、完全な Visual Studio ソリューションをリビルドする必要があります。

一般的な方法は、Visual Studio で Python プロジェクトファイルを直接変更することです。

Visual Studio で Python プロジェクトを開きます。 (Visual Studio でプロジェクトを開くと、プロジェクトは既定で 読み込まれます )。
ソリューションエクスプローラーで、Python プロジェクトを右クリックし、[プロジェクトのアンロード] を選択します。

Visual Studio によってプロジェクトがアンロードされ、対応する Python プロジェクトファイル (.pyproj) がエディターで開かれます。

プロジェクトファイルが開かない場合は、Python プロジェクトをもう一度右クリックし、[ プロジェクトファイルの編集] を選択します。
Visual Studio エディターでプロジェクトファイルを変更し、作業内容を保存します。
ソリューションエクスプローラーで、アンロードされたプロジェクトを右クリックし、[プロジェクトの再読み込み] を選択します。変更をプロジェクトファイルに保存せずにプロジェクトを再読み込みしようとすると、Visual Studio によってアクションを完了するように求められます。

アンロード/編集/保存/再読み込みプロセスは、カスタムコマンドを開発するときに面倒になる可能性があります。より効率的なワークフローでは、Visual Studio でプロジェクトを同時に読み込み、別のエディターで Python プロジェクトファイルを開きます。 Visual Studio の別のインスタンス、Visual Studio Code、メモ帳など、任意のエディターを使用できます。変更をエディターに保存して Visual Studio に戻ると、開いているプロジェクトのプロジェクトファイルの変更が Visual Studio によって検出され、アクションを実行するように求められます。

[ 再読み込み ] または [ すべて再読み込み] を選択すると、Visual Studio によってプロジェクトファイルの変更が開いているプロジェクトに直ちに適用されます。

プロジェクトファイルを使用してカスタムコマンドを追加する

次の手順では、Python プロジェクトファイル (.pyproj) に定義を追加し、Visual Studio でプロジェクトを再読み込みして、カスタムコマンドを作成する方法を示します。カスタムコマンドは、python.exe コマンドを使用してプロジェクトのスタートアップファイルを直接実行します。これは基本的に、Visual Studio のメインツールバーの [デバッグ>オプションを使用する場合と同じです。

Visual Studio で、Python アプリケーションテンプレートを使用して 、Python-CustomCommands という名前の新しい Python プロジェクトを作成します。手順については、「クイックスタート: テンプレートから Python プロジェクトを作成する」を参照してください。

Visual Studio によって Python プロジェクトが作成され、セッションに読み込まれます。プロジェクトファイル (.pyproj) を使用してプロジェクトを構成できます。このファイルは、プロジェクトが開いている場合にのみ Visual Studio で表示されますが、 アンロードされます。プロジェクトには、アプリケーションコード用の Python ファイル (.py) もあります。
エディターで Python_CustomCommands.py アプリケーションファイルを開き、次のコードを追加します。
```
print("Hello custom commands")
```
ソリューションエクスプローラーで Python プロジェクトを右クリックし、Python を選択し、コンテキストメニューのコマンドに注目します。現在、コンテキストメニューのコマンドは PyLint の実行 と Mypy の実行のみです。カスタムコマンドを定義すると、このメニューにも表示されます。
Visual Studio セッションの外部で別のエディターを起動し、エディターで Python プロジェクトファイル (Python-CustomCommands.pyproj) を開きます。 (Python アプリケーションファイル (.py) ではなく、必ずプロジェクトファイル (.pyproj) を開きます)。
プロジェクトファイルで、ファイルの末尾にある終了 </Project> 要素を見つけ、終了要素の直前に次の XML を追加します。
```
<PropertyGroup>
  <PythonCommands>
    $(PythonCommands);
  </PythonCommands>
</PropertyGroup>
```
プロジェクトファイルの変更を保存し、Visual Studio に切り替えます。 Visual Studio によってプロジェクトファイルの変更が検出され、アクションの実行を求められます。プロンプトで[ 再読み込み ]を選択し、開いているプロジェクトをプロジェクトファイルの変更で更新します。
ソリューションエクスプローラーで、Python プロジェクトを右クリックし、Python を選択して、コンテキストメニューでコマンドを確認します。

コンテキストメニューには、[ PyLint の実行 ] コマンドと [Mypy の実行 ] コマンドのみが引き続き表示されます。プロジェクトファイルに追加したコードは、<PythonCommands> コマンドを含む既定のプロパティグループをレプリケートするだけです。次の手順では、カスタムコマンドのコードをさらに追加します。
プロジェクトファイルを更新するエディターに切り替えます。 <Target>要素内に次の<Project>要素定義を追加します。 <Target>定義は、前述の<PropertyGroup>定義の前または後に配置できます。

この<Target>要素は、コンソールウィンドウでコマンドを使用して、プロジェクトのスタートアップファイル (python.exe プロパティで識別) を実行するカスタムコマンドを定義します。属性定義 ExecuteIn="consolepause" では、コンソールウィンドウを閉じるキーの選択を待機するコンソールが使用されます。
```
<Target Name="Example_RunStartupFile" Label="Run startup file" Returns="@(Commands)">
  <CreatePythonCommandItem
    TargetType="script"
    Target="$(StartupFile)"
    Arguments=""
    WorkingDirectory="$(MSBuildProjectDirectory)"
    ExecuteIn="consolepause">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>
```
<PythonCommands> プロパティグループ (手順 5 で追加) を次の XML に置き換えます。この構文では、Nameにカスタムコマンドを追加する、<Target>要素の属性を定義します。このコマンドには、[ スタートアップファイルの実行] というメニューラベルがあります。
```
  <PythonCommands>
    $(PythonCommands);
    Example_RunStartupFile
  </PythonCommands>
```
ヒント

$(PythonCommands) トークンで定義されている既定のコマンドの前にカスタムコマンドをコンテキストメニューに表示する場合は、そのトークンの前にコマンドの<Target>構文を配置します。
プロジェクトファイルの変更を保存し、Visual Studio に切り替えます。プロンプトで、プロジェクトを再読み込みします。
ソリューションエクスプローラーで、Python プロジェクトを右クリックし、Python を選択し、コンテキストメニューでコマンドを再確認します。

これで、カスタムの [スタートアップファイルの実行 ] コマンドがメニューに表示されます。カスタムコマンドが表示されない場合は、Name で説明したように、<Target>要素の<PythonCommands>属性値を要素に追加したかどうかを確認します。また、この記事の後半の「トラブルシューティング」セクションに記載されている考慮事項も確認してください。
[ スタートアップファイルの実行 ] コマンドを選択します。コンソールウィンドウが開き、 Hello カスタムコマンド のテキストが表示され、続けて 任意のキーを押して続行します。出力を確認し、コンソールウィンドウを閉じます。

注

カスタムコマンドスクリプトは、Python プロジェクトのアクティブ化された環境で実行されます。
プロジェクトファイルを使用してエディターに切り替えます。 <Target>要素定義 (手順 8 で追加) で、ExecuteIn属性の値をoutputに変更します。
```
  <CreatePythonCommandItem
    ...
    ExecuteIn="output">
    ...
  </CreatePythonCommandItem>
```
変更を保存し、Visual Studio に切り替えて、プロジェクトを再読み込みします。
Python コンテキストメニューから [スタートアップファイルの実行] カスタムコマンドをもう一度選択します。これで、プログラムの出力がコンソールウィンドウではなく Visual Studio の [出力] ウィンドウに表示されます。
さらにカスタムコマンドを追加するには、次の同じプロセスに従います。
1. プロジェクトファイル内のカスタムコマンドに適した <Target> 要素を定義します。
2. Name要素の<Target>属性値を<PythonCommands>プロパティグループに追加します。
3. 変更内容をプロジェクトファイルに保存します。
4. Visual Studio でプロジェクトを再読み込みします。

プロジェクトのプロパティを使用する

<Target>要素属性値のプロジェクトプロパティまたは環境変数を参照するには、$()や$(StartupFile)などの$(MSBuildProjectDirectory) トークン内でプロパティ名を使用します。詳細については、「 MSBuild プロパティ」を参照してください。

($StartupFile) プロパティなどのプロジェクトプロパティを使用するなどのコマンドを呼び出し、トークンが未定義であるためにコマンドが失敗した場合、プロジェクトを再読み込みするまで、Visual Studio はコマンドを無効にします。プロパティ定義を変更するプロジェクトに変更を加えた場合、関連するコマンドの状態は更新されません。この場合も、プロジェクトを再読み込みする必要があります。

<Target> 要素の構造について

<Target>要素を使用して、カスタムコマンドの詳細を定義します。 <Target>要素の一般的な形式を次の擬似コードに示します。

<Target Name="Name1" Label="Display Name" Returns="@(Commands)">
    <CreatePythonCommandItem Target="filename, module name, or code"
        TargetType="executable/script/module/code/pip"
        Arguments="..."
        ExecuteIn="console/consolepause/output/repl[:Display name]/none"
        WorkingDirectory="..."
        ErrorRegex="..."
        WarningRegex="..."
        RequiredPackages="...;..."
        Environment="...">

      <!-- Output always appears in this form, with these exact attributes -->
      <Output TaskParameter="Command" ItemName="Commands" />
    </CreatePythonCommandItem>
  </Target>

ターゲット属性

次の表に、 <Target> 要素の属性を示します。

特性	必須	Description
`Name`	イエス	Visual Studio プロジェクト内のコマンドの識別子。コマンドを `<PythonCommands>` コンテキストメニューに表示するには、この名前をプロパティグループに追加する必要があります。
`Label`	イエス	Python コンテキストメニューに表示される UI 表示名。
`Returns`	イエス	返される情報。ターゲットをコマンドとして識別する `@(Commands)` トークンが含まれている必要があります。

CreatePythonCommandItem 属性

<Target>要素には、カスタムコマンドの詳細な動作を定義する<CreatePythonCommandItem>要素と<Output>要素が含まれています。次の表に、使用可能な <CreatePythonCommandItem> 要素の属性を示します。すべての属性値は大文字と小文字を区別しません。

`Attribute`	必須	Description
`TargetType`	イエス	`Target`属性に含まれる内容と、`Arguments`属性と共に値を使用する方法を指定します。 - `executable`: `Target` 属性で指定された実行可能ファイルを実行し、コマンドラインに直接入力したかのように、 `Arguments` 属性に値を追加します。値には、引数のないプログラム名のみを含める必要があります。 - `script`: `python.exe`属性のファイル名と、`Target`属性の値を指定して、`Arguments` コマンドを実行します。 - `module`: `python -m` コマンドを実行し、 `Target` 属性のモジュール名の後に、 `Arguments` 属性の値を続けます。 - `code`: `Target` 属性に含まれるインラインコードを実行します。 `Arguments`属性値は無視します。 - `pip`: `Target` 属性のコマンドを使用して pip を実行し、その後に `Arguments` 属性の値を指定します。 `ExecuteIn`属性が `output` に設定されている場合、pip は要求が `install` コマンドを実行することを前提とし、パッケージ名として `Target` 属性を使用します。
`Target`	イエス	`TargetType`属性の値に応じて、使用するファイル名、モジュール名、コード、または pip コマンドを指定します。
`Arguments`	オプション	`Target`属性で使用する引数の文字列 (存在する場合) を提供します。 - `TargetType`属性値が`script`されると、`Arguments` コマンドではなく、`python.exe`値が Python プログラムに提供されます。 - `TargetType` 属性値が `code`されると、 `Arguments` 値は無視されます。
`ExecuteIn`	イエス	コマンドを実行する環境を指定します。 - `console`: (既定値) コマンドラインに直接入力されているかのように、`Target`値を使用して`Arguments`属性を実行します。 `Target`属性の実行中は、コマンドウィンドウが表示され、自動的に閉じます。 - `consolepause`: `console`と同じ動作ですが、ウィンドウを閉じる前にキーを押すのを待ちます。 - `output`: `Target` 属性を実行し、Visual Studio の出力ウィンドウに結果を表示します。 `TargetType`属性が`pip`されている場合、Visual Studio はパッケージ名として `Target` 属性を使用し、`Arguments`属性値を追加します。 - `repl`: `Target`で属性を実行します。オプションの表示名は、ウィンドウのタイトルに使用されます。 - `none`: `console`と同じ動作。
`WorkingDirectory`	オプション	コマンドを実行するフォルダーを識別します。
`ErrorRegex` `WarningRegEx`	オプション	`ExecuteIn`属性が `output` に設定されている場合にのみ使用されます。どちらの属性値も、コマンド出力を解析し、[エラー一覧 ] ウィンドウにエラーと警告を表示するために Visual Studio で使用される正規表現を指定します。これらの属性が指定されていない場合、コマンドは [エラー一覧 ] ウィンドウには影響しません。 Visual Studio で想定される内容の詳細については、「名前付きキャプチャグループ」を参照してください。
`RequiredPackages`	オプション	requirements.txtファイル ( pip.readthedocs.io ) と同じ形式を使用して、コマンドのパッケージ要件の一覧を提供します。たとえば、[ PyLint の実行 ] コマンドでは、 `pylint>=1.0.0`形式を指定します。コマンドを実行する前に、一覧のすべてのパッケージがインストールされていることを Visual Studio で確認します。 Visual Studio では、pip を使用して不足しているパッケージをインストールします。
`Environment`	オプション	コマンドを実行する前に定義する環境変数の文字列を識別します。各変数は、セミコロンで区切られた複数の変数を持つフォーム `\<NAME>=\<VALUE>` を使用します。複数の値を持つ変数は、 `'NAME=VALUE1;VALUE2'`のように、単一引用符または二重引用符で囲む必要があります。

正規表現の名前付きキャプチャグループ

Visual Studio は、カスタムコマンド出力からエラーと警告を解析する際に、ErrorRegex および WarningRegex 属性値の中にある正規表現が、次の名前付きグループを使用することを想定しています。

(?<message>...): エラーのテキスト。
(?<code>...): エラーコード値。
(?<filename>...): エラーが報告されるファイルの名前。
(?<line>...): エラーが報告されるファイル内の場所の行番号。
(?<column>...): エラーが報告されるファイル内の場所の列番号。

たとえば、PyLint は次の形式の警告を生成します。

************* Module hello
C:  1, 0: Missing module docstring (missing-docstring)

Visual Studio でこれらの警告から適切な情報を抽出し、[エラー一覧] ウィンドウに表示できるようにするには、[WarningRegex] コマンドの属性値を次に示します。

^(?<filename>.+?)\((?<line>\d+),(?<column>\d+)\): warning (?<msg_id>.+?): (?<message>.+?)$]]

注

msg_idで説明されているように、WarningRegex属性値におけるcodeの構文は実際にcodeである必要があります。

ターゲットファイルを使用してカスタムコマンドをインポートする

Python プロジェクトファイルでカスタムコマンドを定義する場合、コマンドはその特定のプロジェクトでのみ使用できます。カスタムコマンドを作成して複数のプロジェクトで使用する場合は、ターゲットファイル (<PythonCommands>) 内のすべての<Target>要素でプロパティグループを定義し、そのファイルを Python プロジェクトにインポートできます。

ターゲットファイルでは、Python プロジェクトファイル (.pyproj) の説明に従って、同じ形式と構文を使用してカスタムコマンドを定義します。構成する一般的な要素には、 <PythonCommands>、 <Target>、 <CreatePythonCommandItem>、および <Output>が含まれます。

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <PythonCommands>
       $(PythonCommands);
       <!-- Additional command names -->
     </PythonCommands>
   </PropertyGroup>

   <Target Name="..." Label="..." Returns="@(Commands)">
     <!-- CreatePythonCommandItem and Output elements... -->
   </Target>

   <!-- Any number of additional Target elements-->
</Project>

ターゲットファイルをプロジェクトにインポートするには、プロジェクトファイル内の <Import Project="(path)"> 要素内の任意の場所に<Project>要素を追加します。

たとえば、Python プロジェクト内のターゲット フォルダーに CustomCommands.targets という名前のプロジェクトファイルがある場合は、次のコードをプロジェクトファイルに追加します。
```
<Import Project="targets/CustomCommands.targets"/>
```
プロジェクトファイルがターゲットファイルをインポートし、Visual Studio でプロジェクトを開いている間にターゲットファイルを変更する場合は、プロジェクトだけでなく、プロジェクトを含む Visual Studio ソリューションをリビルドする必要があります。

コマンド例

次のセクションでは、Python プロジェクトのカスタムコマンドを定義するために使用できるコード例を示します。

PyLint (モジュールターゲット) を実行する

Microsoft.PythonTools.targets ファイルに次のコードが表示されます。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);PythonRunPyLintCommand</PythonCommands>
  <PyLintWarningRegex>
    <![CDATA[^(?<filename>.+?)\((?<line>\d+),(?<column>\d+)\): warning (?<msg_id>.+?): (?<message>.+?)$]]>
  </PyLintWarningRegex>
</PropertyGroup>

<Target Name="PythonRunPyLintCommand"
        Label="resource:Microsoft.PythonTools.Common;Microsoft.PythonTools.Common.Strings;RunPyLintLabel"
        Returns="@(Commands)">
  <CreatePythonCommandItem Target="pylint.lint"
                           TargetType="module"
                           Arguments="&quot;--msg-template={abspath}({line},{column}): warning {msg_id}: {msg} [{C}:{symbol}]&quot; -r n @(Compile, ' ')"
                           WorkingDirectory="$(MSBuildProjectDirectory)"
                           ExecuteIn="output"
                           RequiredPackages="pylint&gt;=1.0.0"
                           WarningRegex="$(PyLintWarningRegex)">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>

特定のパッケージを使用して pip インストールを実行する (pip ターゲット)

次のコマンドは、Visual Studio pip install my-packageウィンドウでコマンドを実行します。パッケージを開発し、そのインストールをテストするときに、次のようなコマンドを使用できます。 <Target>要素には、install コマンドではなくパッケージ名が含まれています。これは、ExecuteIn="output"属性定義を使用する場合に想定されます。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);InstallMyPackage</PythonCommands>
</PropertyGroup>

<Target Name="InstallMyPackage" Label="pip install my-package" Returns="@(Commands)">
  <CreatePythonCommandItem Target="my-package" TargetType="pip" Arguments=""
    WorkingDirectory="$(MSBuildProjectDirectory)" ExecuteIn="output">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>

古い pip パッケージを表示する (pip ターゲット)

次のコマンドは、 list 関数で pip を実行して、古い pip パッケージを識別します。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);ShowOutdatedPackages</PythonCommands>
</PropertyGroup>

<Target Name="ShowOutdatedPackages" Label="Show outdated pip packages" Returns="@(Commands)">
  <CreatePythonCommandItem Target="list" TargetType="pip" Arguments="-o --format columns"
    WorkingDirectory="$(MSBuildProjectDirectory)" ExecuteIn="consolepause">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>

コンソールの一時停止を使用して実行可能ファイルを実行する

次のコマンドは、 where 関数を実行して、プロジェクトフォルダーから始まる Python ファイルの場所を表示します。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);ShowAllPythonFilesInProject</PythonCommands>
</PropertyGroup>

<Target Name="ShowAllPythonFilesInProject" Label="Show Python files in project" Returns="@(Commands)">
  <CreatePythonCommandItem Target="where" TargetType="executable" Arguments="/r . *.py"
    WorkingDirectory="$(MSBuildProjectDirectory)" ExecuteIn="output">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>

サーバーの実行とデバッグサーバーコマンドの実行

Web プロジェクトの スタートサーバー コマンドと Start デバッグサーバー コマンドがどのように定義されているかを調べるには、GitHub の Microsoft.PythonTools.Web.targets リポジトリを調べます。

開発用パッケージをインストールする

次のコードでは、pip を実行してパッケージをインストールします。

<PropertyGroup>
  <PythonCommands>PipInstallDevCommand;$(PythonCommands);</PythonCommands>
</PropertyGroup>

<Target Name="PipInstallDevCommand" Label="Install package for development" Returns="@(Commands)">
    <CreatePythonCommandItem Target="pip" TargetType="module" Arguments="install --editable $(ProjectDir)"
        WorkingDirectory="$(WorkingDirectory)" ExecuteIn="Repl:Install package for development">
      <Output TaskParameter="Command" ItemName="Commands" />
    </CreatePythonCommandItem>
  </Target>

fxthomas/Example.pyproj.xml (GitHub) から、アクセス許可と共に使用されます。

Windows インストーラーを生成する

次のスクリプトでは、Windows インストーラーが生成されます。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);BdistWinInstCommand;</PythonCommands>
</PropertyGroup>

<Target Name="BdistWinInstCommand" Label="Generate Windows Installer" Returns="@(Commands)">
    <CreatePythonCommandItem Target="$(ProjectDir)setup.py" TargetType="script"
        Arguments="bdist_wininst --user-access-control=force --title &quot;$(InstallerTitle)&quot; --dist-dir=&quot;$(DistributionOutputDir)&quot;"
        WorkingDirectory="$(WorkingDirectory)" RequiredPackages="setuptools"
        ExecuteIn="Repl:Generate Windows Installer">
      <Output TaskParameter="Command" ItemName="Commands" />
    </CreatePythonCommandItem>
  </Target>

fxthomas/Example.pyproj.xml (GitHub) から、アクセス許可と共に使用されます。

Python ホイールパッケージを生成する

次のスクリプトでは、 Python ホイールパッケージが生成されます。

<PropertyGroup>
  <PythonCommands>$(PythonCommands);BdistWheelCommand;</PythonCommands>
</PropertyGroup>

<Target Name="BdistWheelCommand" Label="Generate Wheel Package" Returns="@(Commands)">

  <CreatePythonCommandItem Target="$(ProjectDir)setup.py" TargetType="script"
      Arguments="bdist_wheel --dist-dir=&quot;$(DistributionOutputDir)&quot;"
      WorkingDirectory="$(WorkingDirectory)" RequiredPackages="wheel;setuptools"
      ExecuteIn="Repl:Generate Wheel Package">
    <Output TaskParameter="Command" ItemName="Commands" />
  </CreatePythonCommandItem>
</Target>

fxthomas/Example.pyproj.xml (GitHub) から、アクセス許可と共に使用されます。

カスタムコマンドのトラブルシューティング

カスタムコマンドの操作に関連して考えられる問題については、次のセクションを参照してください。

プロジェクトファイルが読み込まれていない

このエラーメッセージは、プロジェクトファイルに構文エラーがあることを示します。このメッセージには、行番号と文字位置を含む特定のエラーが含まれています。

コマンドの実行後にコンソールウィンドウが閉じる

コマンドの実行直後にコンソールウィンドウが閉じる場合は、ExecuteIn="consolepause"の代わりにExecuteIn="console"属性定義を使用します。

Python コンテキストメニューにカスタムコマンドが表示されない場合は、次の項目を確認します。

コマンドが <PythonCommands> プロパティグループに含まれていることを確認します。
コマンドリストで定義されているコマンド名が、 <Target> 要素で指定された名前と一致することを確認します。

次に例を示します。次の XML スニペットでは、Example プロパティグループの<PythonCommands>名が、ExampleCommand要素定義の<Target>名と一致しません。 Visual Studio で Example という名前のコマンドが見つからないため、コマンドは表示されません。コマンドリストで ExampleCommand を使用するか、ターゲットの名前を Exampleのみに変更します。

  <PropertyGroup>
    <PythonCommands>$(PythonCommands);Example</PythonCommands>
  </PropertyGroup>
  <Target Name="ExampleCommand" Label="Example Command" Returns="@(Commands)">
    <!-- ... -->
  </Target>

コマンドの実行中にエラーが発生し、コマンドターゲットを取得できませんでした

このエラーメッセージは、 <Target> 要素または <CreatePythonCommandItem> 要素の内容が正しくないことを示します。

このエラーの考えられる理由を次に示します。

必須の <Target> 要素属性が空です。
必要な TargetType 属性が空であるか、認識されない値が含まれています。
必要な ExecuteIn 属性が空であるか、認識されない値が含まれています。
ErrorRegex属性またはWarningRegex属性は、ExecuteIn="output"属性定義を設定せずに指定します。
認識できない属性が要素に存在します。たとえば、属性参照のスペルがArgumnetsではなく、Argumentsと間違える場合があります。

未定義のプロパティを参照する場合は、属性値を空にすることができます。トークン $(StartupFile) を使用しても、プロジェクトでスタートアップファイルが定義されていない場合、トークンは空の文字列に解決されます。このような場合は、既定値を定義できます。たとえば、Bottle、Flask、Django プロジェクトテンプレートで定義されている [ サーバーの実行 ] コマンドと [ デバッグサーバーの実行 ] コマンドでは、既定で manage.py ファイルが使用されます (サーバースタートアップファイルがプロジェクトのプロパティで指定されていない場合)。

Visual Studio が応答を停止し、クラッシュする

カスタムコマンドの実行時に Visual Studio が応答を停止し、クラッシュした場合は、 ExecuteIn="output" 属性定義を使用してコンソールコマンドを実行しようとしている可能性があります。このような場合、Visual Studio は出力を解析しようとしたときにクラッシュする可能性があります。この状態を回避するには、代わりに ExecuteIn="console" 属性定義を使用します。詳細については、問題 3681 を参照してください。

コマンドが操作可能なプログラムまたはバッチファイルとして認識されない

TargetType="executable"属性定義を設定する場合、Target属性の値は、やpythonのみなど、引数のないプログラム名python.exeする必要があります。この場合は、引数を Arguments 属性に移動します。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-12-12

次の方法で共有

Visual Studio で Python プロジェクトのカスタム コマンドを定義する

[前提条件]

カスタム コマンドを調べる

プロジェクトを再読み込みしてカスタム コマンドにアクセスする

プロジェクト ファイルを使用してカスタム コマンドを追加する

プロジェクトのプロパティを使用する

<Target> 要素の構造について

ターゲット属性

CreatePythonCommandItem 属性

正規表現の名前付きキャプチャ グループ

ターゲット ファイルを使用してカスタム コマンドをインポートする

コマンド例

PyLint (モジュール ターゲット) を実行する

特定のパッケージを使用して pip インストールを実行する (pip ターゲット)

古い pip パッケージを表示する (pip ターゲット)

コンソールの一時停止を使用して実行可能ファイルを実行する

サーバーの実行とデバッグ サーバー コマンドの実行

開発用パッケージをインストールする

Windows インストーラーを生成する

Python ホイール パッケージを生成する

カスタム コマンドのトラブルシューティング

プロジェクト ファイルが読み込まれていない

コマンドの実行後にコンソール ウィンドウが閉じる

メニューにコマンドがありません

コマンドの実行中にエラーが発生し、コマンド ターゲットを取得できませんでした

Visual Studio が応答を停止し、クラッシュする

コマンドが操作可能なプログラムまたはバッチ ファイルとして認識されない

フィードバック

その他のリソース

Visual Studio で Python プロジェクトのカスタムコマンドを定義する

カスタムコマンドを調べる

プロジェクトを再読み込みしてカスタムコマンドにアクセスする

プロジェクトファイルを使用してカスタムコマンドを追加する

正規表現の名前付きキャプチャグループ

ターゲットファイルを使用してカスタムコマンドをインポートする

PyLint (モジュールターゲット) を実行する

サーバーの実行とデバッグサーバーコマンドの実行

Python ホイールパッケージを生成する

カスタムコマンドのトラブルシューティング

プロジェクトファイルが読み込まれていない

コマンドの実行後にコンソールウィンドウが閉じる

コマンドの実行中にエラーが発生し、コマンドターゲットを取得できませんでした

コマンドが操作可能なプログラムまたはバッチファイルとして認識されない