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.
入力
versionSpec
-
バージョン 仕様の
string
. 必須。 既定値: 3.x
.
SemVer のバージョン範囲構文を使用して、使用する Python バージョンのバージョン範囲または正確なバージョンを指定します。 SemVerの詳細を確認します。
disableDownloadFromRegistry
-
GitHub レジストリ からのリリースのダウンロードを無効にする
boolean
. 既定値: false
.
Github Actions レジストリから不足している Python バージョンのダウンロードを無効にします。 このブール値は、Python のローカル インストールを使用している場合にのみ true
する必要があります。
allowUnstable
-
不安定なリリース のダウンロードを許可する
boolean
. 随意。
disableDownloadFromRegistry = false
するときに使用します。 既定値: false
.
に設定されている場合は、true
から不安定な Python バージョンをダウンロードします。
GitHub Actions python レジストリの GitHub トークンを githubToken
- する
string
. 随意。
disableDownloadFromRegistry = false
するときに使用します。
Github Actions python バージョンのレジストリで匿名要求の制限を適用する GitHub トークンを指定します。 これを空のままにすると、ダウンロードエラーが発生する可能性があります。 Python のローカル インストールを使用している場合は必要ありません。
pathに追加する addToPath
-
boolean
. 既定値: true
.
取得した Python バージョンを PATH 環境変数の先頭に追加して、出力変数を使用せずに後続のタスクまたはスクリプトで使用できるようにします。
architecture
-
アーキテクチャ
string
. 必須。 使用できる値: x86
、x64
。 既定値: x64
.
Python インタープリターのターゲット アーキテクチャ (x86
または x64
) を指定します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。
pythonLocation
インストールされている Python ディストリビューションのディレクトリ。 後続のタスクでこれを使用して、Python のこのインストールにアクセスします。
注釈
このタスクを使用して、エージェントで実行する Python のバージョンをダウンロードまたは選択し、必要に応じて PATH に追加します。
前提条件
- サイド バイ サイド バージョンの Python がインストールされた の Microsoft ホステッド エージェント、または
Agent.ToolsDirectory
が構成されたセルフホステッド エージェント (FAQ 参照)。 - セルフホステッド エージェントでは、Python バージョンのダウンロードはサポートされていません。
Agent.ToolsDirectory
で Python バージョンが見つからない場合、このタスクは失敗します。 Microsoft でホストされるエージェントで使用可能な Python バージョンについては、参照してください。
注
x86 および x64 バージョンの Python は、Microsoft がホストする Windows エージェントでは使用できますが、Linux または macOS エージェントでは使用できません。
タスクのバージョン 0.150 の時点で、バージョンスペックは pypy2
または pypy3
も受け入れます。
タスクのバージョン 0.213.1 の時点で、バージョンスペックは pypy2.x
または pypy3.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
は、x86
または x64
にする必要があります。
tool files
は、解凍された Python バージョン のファイルである必要があります。
{platform}.complete
は、x86.complete
または x64.complete
のような 0 バイトのファイルで、ツールがキャッシュに正しくインストールされていることを示します。
完全で具体的な例として、x64 用 Python 3.11.4 の完全なダウンロードがツール キャッシュでどのように表示されるかを次に示します。
$AGENT_TOOLSDIRECTORY/
Python/
3.11.4/
x64/
{tool files}
x64.complete
ツール キャッシュの詳細を確認します。
スクリプトを Microsoft がホストするエージェントと同じように動作させるには、Unix に似たシステムで PEP 394 シンボリック リンク構造を使用します。
また、Python の埋め込み可能な ZIP リリースでは、を含むインストール済みモジュール pip
必要があることにも注意してください。 可能であれば、完全なインストーラー を使用して、pip
互換性のある Python インストールを取得することをお勧めします。