UsePythonVersion@0 - Python バージョン v0 タスクを使用する

  • [アーティクル]

このタスクを使用して、エージェントで実行する Python のバージョンをダウンロードまたは選択し、必要に応じて PATH に追加します。

構文

# Use Python version v0
# Use the specified version of Python from the tool cache, optionally adding it to the PATH.
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.x' # string. Required. Version spec. Default: 3.x.
    #disableDownloadFromRegistry: false # boolean. Disable downloading releases from the GitHub registry. Default: false.
    #allowUnstable: false # boolean. Optional. Use when disableDownloadFromRegistry = false. Allow downloading unstable releases. Default: false.
    #githubToken: # string. Optional. Use when disableDownloadFromRegistry = false. GitHub token for GitHub Actions python registry. 
    #addToPath: true # boolean. Add to PATH. Default: true.
  # Advanced
    architecture: 'x64' # 'x86' | 'x64'. Required. Architecture. Default: x64.

# Use Python version v0
# Use the specified version of Python from the tool cache, optionally adding it to the PATH.
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.x' # string. Required. Version spec. Default: 3.x.
    #addToPath: true # boolean. Add to PATH. Default: true.
  # Advanced
    architecture: 'x64' # 'x86' | 'x64'. Required. Architecture. Default: x64.

# Use Python Version v0
# Retrieves the specified version of Python from the tool cache. Optionally add it to PATH.
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.x' # string. Required. Version spec. Default: 3.x.
    #addToPath: true # boolean. Add to PATH. Default: true.
  # Advanced
    architecture: 'x64' # 'x86' | 'x64'. Required. Architecture. Default: x64.

入力

versionSpec - バージョン スペック
string. 必須です。 既定値: 3.x。

SemVer のバージョン範囲構文を使用して、使用する Python バージョンのバージョン範囲または正確なバージョンを指定します。 SemVer の詳細については、こちらを参照してください。


disableDownloadFromRegistry - GitHub レジストリからのリリースのダウンロードを無効にする
boolean. 既定値: false。

Github Actions レジストリから不足している Python バージョンのダウンロードを無効にします。 このブール値は、Python のローカル インストールを使用している場合にのみ指定 true する必要があります。


allowUnstable - 不安定なリリースのダウンロードを許可する
boolean. 省略可能。 の場合は disableDownloadFromRegistry = falseを使用します。 既定値: false。

に設定されている場合は、 Github Actions Python バージョンレジストリから不安定な Python バージョン を trueダウンロードします。


githubToken - GitHub Actions Python レジストリの GitHub トークン
string. 省略可能。 の場合は disableDownloadFromRegistry = falseを使用します。

GitHub Actions Python バージョン レジストリで匿名要求の制限を適用する GitHub トークンを指定します。 これを空のままにすると、ダウンロード エラーが発生する可能性があります。 Python のローカル インストールを使用する場合は不要です。


addToPath - PATH に追加
boolean. 既定値: true。

取得した Python バージョンを PATH 環境変数の前に追加して、出力変数を使用せずに後続のタスクまたはスクリプトで使用できるようにします。


architecture - アーキテクチャ
string. 必須です。 使用できる値: x86、x64。 既定値: x64。

Python インタープリターのターゲット アーキテクチャ (x86 または x64) を指定します。


タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

このタスクでは、ダウンストリームのステップ、ジョブ、およびステージで使用できる次の 出力変数を定義します。

pythonLocation
インストールされている Python ディストリビューションのディレクトリ。 後続のタスクでこれを使用して、Python のこのインストールにアクセスします。

注釈

このタスクを使用して、エージェントで実行する Python のバージョンをダウンロードまたは選択し、必要に応じて PATH に追加します。

前提条件

  • Python のサイド バイ サイド バージョンがインストールされた Microsoft ホスト型エージェント 、または構成済みのセルフホステッド エージェント Agent.ToolsDirectory ( FAQ を参照)。
  • セルフホステッド エージェントでは、Python バージョンのダウンロードはサポートされていません。

で Python バージョンが見つからない Agent.ToolsDirectory場合、このタスクは失敗します。 Microsoft でホストされるエージェントで使用可能な Python バージョンについては、 こちらを参照してください。

注意

x86 および x64 バージョンの Python は、Microsoft でホストされる Windows エージェントでは使用できますが、Linux または macOS エージェントでは使用できません。

タスクのバージョン 0.150 以降では、バージョン 仕様では または pypy3も受け入れられますpypy2。

タスクのバージョン 0.213.1 以降では、バージョン 仕様では または pypy3.xも受け入れられますpypy2.x。

タスクが正常に完了すると、タスクの出力変数には Python インストールのディレクトリが含まれます。

出力変数のスクリーンショット。

このタスクを "パスに追加" python で実行すると、後続のスクリプトのコマンドは、バージョン スペックとアーキテクチャに一致する使用可能なインタープリターの最高バージョン用になります。

Microsoft でホストされる Ubuntu および macOS イメージにインストールされている Python のバージョンは、 PEP 394 で定義されている Unix に似たシステムのシンボリック リンク構造に従います。

たとえば、 python3.11 は Python 3.11 の実際のインタープリターです。

python3 は、そのインタープリターにシンボリック リンクされ python 、そのシンボリック リンクへのシンボリック リンクです。

Microsoft でホストされる Windows イメージでは、インタープリターは 単なる pythonです。

Microsoft でホストされるエージェントの場合、x86 は Windows でのみサポートされます。 これは、Windows が WoW64 サブシステムを使用して x86 アーキテクチャ用にコンパイルされた実行可能ファイルを実行できるためです。ホストされた Ubuntu とホステッド macOS では、64 ビット オペレーティング システムが実行され、64 ビット Python のみが実行されます。

このタスクを使用するようにセルフホステッド エージェントを構成するにはどうすればよいですか?

重要

セルフホステッド エージェントでは、Python バージョンのダウンロードはサポートされていません。 プレインストールされたバージョンのみを使用できます。

タスクで使用できるように、目的の Python バージョンをセルフホステッド エージェントのツール キャッシュに追加する必要があります。 通常、ツール キャッシュはエージェントのディレクトリの下 _work/_tool にあります。または、環境変数 でパスを AGENT_TOOLSDIRECTORYオーバーライドすることもできます。 そのディレクトリの下に、Python バージョンに基づいて次のディレクトリ構造を作成します。

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

は version number の 1.2.3形式に従う必要があります。 は platform または x64であるx86必要があります。 は tool files 、解凍された Python バージョン ファイルである必要があります。 は{platform}.complete、ツールがキャッシュに正しくインストールされていることを示す または x64.complete のような x86.complete 0 バイトのファイルである必要があります。

完全で具体的な例として、Python 3.11.4 for x64 の完全なダウンロードがツール キャッシュでどのように表示されるかを次に示します。

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {tool files}
            x64.complete

ツール キャッシュの詳細については、こちらを参照してください。

スクリプトを Microsoft でホストされているエージェントと同じように動作させるには、UNIX に似たシステムで PEP 394 のシンボリック リンク構造を使用します。

また、Python の埋め込み可能な ZIP リリースでは、 を含むpipインストール済みモジュールの追加の構成が必要であることにも注意してください。 可能であれば、 完全なインストーラー を使用して互換性のある Python インストールを pip取得することをお勧めします。

必要条件

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 なし
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 このタスクは、次の コマンド制限を使用して実行されます。
設定可能な変数 このタスクには、 次の変数を設定するアクセス許可があります: pythonLocation、PATH
エージェントのバージョン 2.182.1 以降
タスクのカテゴリ ツール
要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 なし
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン サポートされているすべてのエージェント バージョン。
タスクのカテゴリ ツール