# setup-python
[![Basic validation](https://github.com/actions/setup-python/actions/workflows/basic-validation.yml/badge.svg?branch=main)](https://github.com/actions/setup-python/actions/workflows/basic-validation.yml)
[![Validate Python e2e](https://github.com/actions/setup-python/actions/workflows/test-python.yml/badge.svg?branch=main)](https://github.com/actions/setup-python/actions/workflows/test-python.yml)
[![Validate PyPy e2e](https://github.com/actions/setup-python/actions/workflows/test-pypy.yml/badge.svg?branch=main)](https://github.com/actions/setup-python/actions/workflows/test-pypy.yml)
[![e2e-cache](https://github.com/actions/setup-python/actions/workflows/e2e-cache.yml/badge.svg?branch=main)](https://github.com/actions/setup-python/actions/workflows/e2e-cache.yml)
This action provides the following functionality for GitHub Actions users:
- Installing a version of Python or PyPy and (by default) adding it to the PATH
- Optionally caching dependencies for pip, pipenv and poetry
- Registering problem matchers for error output
## Basic usage
See [action.yml](action.yml)
**Python**
```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.13'
- run: python my_script.py
```
**PyPy**
```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 'pypy3.10'
- run: python my_script.py
```
**GraalPy**
```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 'graalpy-24.0'
- run: python my_script.py
```
The `python-version` input is optional. If not supplied, the action will try to resolve the version from the default `.python-version` file. If the `.python-version` file doesn't exist Python or PyPy version from the PATH will be used. The default version of Python or PyPy in PATH varies between runners and can be changed unexpectedly so we recommend always setting Python version explicitly using the `python-version` or `python-version-file` inputs.
The action will first check the local [tool cache](docs/advanced-usage.md#hosted-tool-cache) for a [semver](https://github.com/npm/node-semver#versions) match. If unable to find a specific version in the tool cache, the action will attempt to download a version of Python from [GitHub Releases](https://github.com/actions/python-versions/releases) and for PyPy from the official [PyPy's dist](https://downloads.python.org/pypy/).
For information regarding locally cached versions of Python or PyPy on GitHub hosted runners, check out [GitHub Actions Runner Images](https://github.com/actions/runner-images).
## Supported version syntax
The `python-version` input supports the [Semantic Versioning Specification](https://semver.org/) and some special version notations (e.g. `semver ranges`, `x.y-dev syntax`, etc.), for detailed examples please refer to the section: [Using python-version input](docs/advanced-usage.md#using-the-python-version-input) of the [Advanced usage](docs/advanced-usage.md) guide.
## Supported architectures
Using the `architecture` input, it is possible to specify the required Python or PyPy interpreter architecture: `x86`, `x64`, or `arm64`. If the input is not specified, the architecture defaults to the host OS architecture.
## Caching packages dependencies
The action has built-in functionality for caching and restoring dependencies. It uses [toolkit/cache](https://github.com/actions/toolkit/tree/main/packages/cache) under the hood for caching dependencies but requires less configuration settings. Supported package managers are `pip`, `pipenv` and `poetry`. The `cache` input is optional, and caching is turned off by default.
The action defaults to searching for a dependency file (`requirements.txt` or `pyproject.toml` for pip, `Pipfile.lock` for pipenv or `poetry.lock` for poetry) in the repository, and uses its hash as a part of the cache key. Input `cache-dependency-path` is used for cases when multiple dependency files are used, they are located in different subdirectories or different files for the hash that want to be used.
- For `pip`, the action will cache the global cache directory
- For `pipenv`, the action will cache virtualenv directory
- For `poetry`, the action will cache virtualenv directories -- one for each poetry project found
**Caching pip dependencies:**
```yaml
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
```
>**Note:** Restored cache will not be used if the requirements.txt file is not updated for a long time and a newer version of the dependency is available which can lead to an increase in total build time.
>The requirements file format allows for specifying dependency versions using logical operators (for example chardet>=3.0.4) or specifying dependencies without any versions. In this case the pip install -r requirements.txt command will always try to install the latest available package version. To be sure that the cache will be used, please stick to a specific dependency version and update it manually if necessary.
See examples of using `cache` and `cache-dependency-path` for `pipenv` and `poetry` in the section: [Caching packages](docs/advanced-usage.md#caching-packages) of the [Advanced usage](docs/advanced-usage.md) guide.
## Advanced usage
- [Using the python-version input](docs/advanced-usage.md#using-the-python-version-input)
- [Using the python-version-file input](docs/advanced-usage.md#using-the-python-version-file-input)
- [Check latest version](docs/advanced-usage.md#check-latest-version)
- [Caching packages](docs/advanced-usage.md#caching-packages)
- [Outputs and environment variables](docs/advanced-usage.md#outputs-and-environment-variables)
- [Available versions of Python, PyPy and GraalPy](docs/advanced-usage.md#available-versions-of-python-pypy-and-graalpy)
- [Hosted tool cache](docs/advanced-usage.md#hosted-tool-cache)
- [Using `setup-python` with a self-hosted runner](docs/advanced-usage.md#using-setup-python-with-a-self-hosted-runner)
- [Using `setup-python` on GHES](docs/advanced-usage.md#using-setup-python-on-ghes)
- [Allow pre-releases](docs/advanced-usage.md#allow-pre-releases)
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE).
## Contributions
Contributions are welcome! See our [Contributor's Guide](docs/contributors.md).
没有合适的资源?快使用搜索试试~ 我知道了~
使用特定版本的 Python 设置 GitHub Actions 工作流程.zip
共136个文件
yml:72个
ts:24个
md:8个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 177 浏览量
2024-11-24
16:45:35
上传
评论
收藏 1.47MB ZIP 举报
温馨提示
使用特定版本的 Python 设置 GitHub Actions 工作流程安装 Python 此操作为 GitHub Actions 用户提供了以下功能安装 Python 或 PyPy 版本并(默认)将其添加到 PATH可选择缓存 pip、pipenv 和 poetry 的依赖项注册问题匹配器以进行错误输出基本用法参见action.ymlPythonsteps:- 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格拉尔皮steps:- uses: actions/checko
资源推荐
资源详情
资源评论
收起资源包目录
使用特定版本的 Python 设置 GitHub Actions 工作流程.zip (136个子文件)
CODEOWNERS 30B
.eslintignore 66B
.gitattributes 61B
.gitignore 2KB
index.js 3.48MB
index.js 3.13MB
.eslintrc.js 1KB
.prettierrc.js 398B
jest.config.js 235B
graalpy.json 304KB
package-lock.json 199KB
pypy.json 19KB
tsconfig.json 6KB
versions-manifest.json 3KB
package.json 2KB
python.json 448B
LICENSE 1KB
poetry.lock 10KB
Pipfile.lock 4KB
poetry.lock 14B
advanced-usage.md 28KB
contributors.md 9KB
README.md 6KB
0000-caching-dependencies.md 5KB
CODE_OF_CONDUCT.md 3KB
bug_report.md 955B
feature_request.md 594B
pull_request_template.md 221B
Pipfile 173B
.prettierignore 76B
verify-python.py 1000B
test-pipenv.py 104B
check-python-path.sh 461B
pyproject.toml 332B
pyproject.toml 17B
find-pypy.test.ts 14KB
find-graalpy.test.ts 11KB
cache-restore.test.ts 11KB
install-pypy.test.ts 10KB
utils.ts 10KB
finder.test.ts 10KB
cache-save.test.ts 8KB
install-graalpy.test.ts 8KB
install-pypy.ts 8KB
utils.test.ts 8KB
install-graalpy.ts 7KB
find-python.ts 7KB
find-pypy.ts 6KB
setup-python.ts 5KB
find-graalpy.ts 4KB
install-python.ts 4KB
poetry-cache.ts 3KB
pip-cache.ts 3KB
cache-save.ts 2KB
cache-distributor.ts 2KB
install-python.test.ts 2KB
pipenv-cache.ts 1KB
cache-factory.ts 757B
constants.ts 65B
资源内容.txt 695B
requirements.txt 614B
requirements-linux.txt 189B
pipenv-requirements.txt 27B
标签.txt 6B
api.dep.yml 13KB
test-python.yml 12KB
test-pypy.yml 5KB
e2e-cache.yml 5KB
test-graalpy.yml 3KB
e2e-tests.yml 3KB
node-fetch.dep.yml 3KB
balanced-match.dep.yml 3KB
brace-expansion.dep.yml 3KB
sax.dep.yml 2KB
action.yml 2KB
mime-types.dep.yml 2KB
tslib-1.14.1.dep.yml 2KB
tslib-2.6.2.dep.yml 2KB
webidl-conversions.dep.yml 2KB
uuid-3.4.0.dep.yml 2KB
form-data-2.5.1.dep.yml 2KB
form-data-4.0.0.dep.yml 2KB
ms-rest-js.dep.yml 1KB
tunnel.dep.yml 1KB
events.dep.yml 1KB
core-http.dep.yml 1KB
delayed-stream.dep.yml 1KB
combined-stream.dep.yml 1KB
node-fetch.dep.yml 1KB
tunnel.dep.yml 1KB
core-tracing.dep.yml 1KB
core-lro.dep.yml 1KB
node.dep.yml 1KB
asynckit.dep.yml 1KB
core-auth.dep.yml 1KB
abort-controller.dep.yml 1KB
storage-blob.dep.yml 1KB
core-paging.dep.yml 1KB
whatwg-url.dep.yml 1KB
http-client.dep.yml 1KB
共 136 条
- 1
- 2
资源评论
徐浪老师
- 粉丝: 8070
- 资源: 7322
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- EBS excel导入实例
- 狙击机器人等待特定配对的创建,一旦检测到,机器人就会购买指定金额的代币.zip
- mapbox maps 添加简单地图
- python入门-安装Python软件包.pdf
- 关于标准库与时间:让编程者使用时间函数更便捷
- 此存储库收集了所有有趣的 Python 单行代码 欢迎随意提交你的代码!.zip
- 高考志愿智能推荐-JAVA-基于springBoot高考志愿智能推荐系统设计与实现
- 信奥中的数学:阶乘算法及其应用(NOI入门级,2024.11.24)
- 标准 Python 记录器的 Json 格式化程序.zip
- 复兴村医疗管理-JAVA-基于springBoot复兴村医疗管理系统设计与实现
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功