setup python

安裝Python

此操作為 GitHub Actions 使用者提供以下功能：

• 安裝 Python 或 PyPy 版本並（預設）將其新增至 PATH
• 可選擇快取 pip、pipenv 和詩歌的依賴項
• 註冊問題匹配器以進行錯誤輸出

基本用法

參見action.yml

Python

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5
  with :
    python-version : ' 3.13 ' 
- run : python my_script.py

吡啶

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5 
  with :
    python-version : ' pypy3.10 ' 
- run : python my_script.py

格雷爾Py

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5 
  with :
    python-version : ' graalpy-24.0 ' 
- run : python my_script.py

python-version輸入是可選的。如果未提供，則該操作將嘗試從預設的.python-version檔案解析版本。如果.python-version檔案不存在，則會使用 PATH 中的 Python 或 PyPy 版本。 PATH 中 Python 或 PyPy 的預設版本會因執行程式而異，並且可能會意外更改，因此我們建議始終使用python-version或python-version-file輸入明確設定 Python 版本。

該操作將首先檢查本機工具快取是否有 semver 匹配。如果無法在工具快取中找到特定版本，則該操作將嘗試從 GitHub Releases 下載 Python 版本，並從官方 PyPy 的 dist 下載 PyPy 版本。

有關 GitHub 託管運行器上本地緩存的 Python 或 PyPy 版本的信息，請查看 GitHub Actions Runner Images。

支援的版本語法

python-version輸入支援語意版本控制規格和一些特殊的版本符號（例如semver ranges 、 xy-dev syntax等），詳細範例請參閱進階使用指南的「使用 python-version 輸入」部分。

支援的架構

使用architecture輸入，可以指定所需的 Python 或 PyPy 解釋器架構： x86 、 x64或arm64 。若未指定輸入，體系結構預設為主機作業系統體系結構。

快取包依賴項

該操作具有用於快取和恢復依賴項的內建功能。它在底層使用工具包/快取來快取依賴項，但需要較少的配置設定。支援的套件管理器有pip 、 pipenv和poetry 。 cache輸入是可選的，預設情況下快取是關閉的。

此操作預設在儲存庫中搜尋依賴檔案（pip 的requirements.txt或pyproject.toml 、pipenv 的Pipfile.lock或poetry 的poetry.lock ），並使用其雜湊作為快取鍵的一部分。輸入cache-dependency-path用於使用多個依賴檔案的情況，它們位於不同的子目錄或要使用的雜湊的不同檔案中。

• 對於pip ，該操作將快取全域快取目錄
• 對於pipenv ，該操作將快取 virtualenv 目錄
• 對於poetry ，該操作將緩存 virtualenv 目錄 - 一個對應於找到的每個詩歌項目。

快取 pip 依賴項：

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5
  with :
    python-version : ' 3.13 '
    cache : ' pip ' # caching pip dependencies
- run : pip install -r requirements.txt

注意：如果requirements.txt 檔案長時間未更新且有較新版本的依賴項可用，則不會使用復原的緩存，這可能會導致總建置時間增加。

需求檔案格式允許使用邏輯運算子（例如 chardet>=3.0.4）指定依賴項版本或指定不含任何版本的依賴項。在這種情況下， pip install -rrequirements.txt 命令將始終嘗試安裝最新的可用軟體包版本。為了確保使用緩存，請堅持使用特定的依賴版本，並在必要時手動更新。

請參閱高級使用指南的快取包部分中使用pipenv和poetry的cache和cache-dependency-path的範例。

進階用法

• 使用 python 版本輸入
• 使用 python-version-file 輸入
• 檢查最新版本
• 快取包
• 輸出和環境變數
• Python、PyPy 和 GraalPy 的可用版本
• 託管工具快取
• 將setup-python與自架運行器結合使用
• 在 GHES 上使用setup-python
• 允許預發布

執照

該專案中的腳本和文件是根據 MIT 許可證發布的。

貢獻

歡迎貢獻！請參閱我們的貢獻者指南。