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.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 许可证发布的。

贡献

欢迎贡献！请参阅我们的贡献者指南。