python/peps
GitHub: python/peps
Python 改进提案的官方仓库，收录定义语言特性、编码规范和发展方向的所有正式设计文档。
Stars: 4876 | Forks: 1751
# Python 改进提案
.. image:: https://github.com/python/peps/actions/workflows/render.yml/badge.svg
:target: https://github.com/python/peps/actions
本仓库中的 PEP 会自动发布在网页
https://peps.python.org/。要了解更多关于 PEP 的目的以及如何撰写 PEP，请从 :pep:`1` 开始阅读。请注意，PEP 索引
(:pep:`0`) 是根据其他 PEP 中的元数据标头自动生成的。
# 规范链接
PEP 链接的规范形式是零填充的，例如
``https://peps.python.org/pep-0008/``。
也提供了快捷重定向。
例如，``https://peps.python.org/8`` 会重定向到规范链接。
# API
若干数据文件可在 https://peps.python.org/api/ 获取
# 为 PEP 做贡献
请参阅 `贡献指南 <./CONTRIBUTING.rst>`_。
# 检查 PEP 格式和渲染
请不要提交包含 reStructuredText 语法错误的更改，以免导致 PEP
生成失败，或导致实际渲染效果与您的预期相比出现重大缺陷。
## 浏览 "Read the Docs" 预览
对于每个 PR，我们都会使用
`Read the Docs `_ 自动创建渲染后的 PEP 预览。
您可以在 PR 页面底部的合并框中找到它：
1. 点击 "Show all checks" 展开检查部分
2. 找到 ``docs/readthedocs.org:pep-previews`` 这一行
3. 点击右侧的 "Details"
## 在本地渲染 PEP
请参阅 `构建文档 <./peps/docs/build.rst>`__ 获取关于如何在本地渲染 PEP 的完整
说明。
简而言之，在一个新建且已激活的虚拟环境中运行以下命令：
.. code-block:: bash
```
# 安装 requirements
python -m pip install -U -r requirements.txt
# 构建 PEPs
make html
# 或者，如果你没有 'make'：
python build.py
```
输出的 HTML 文件位于 ``build`` 目录下。
## 检查和 Lint PEP
您可以使用我们的 pre-commit 套件，按需检查并修复常见的 lint 和拼写问题，
或者在提交时自动进行。
详情请参阅 `贡献指南 <./CONTRIBUTING.rst>`_。
标签：API, DNS解析, GitHub Actions, PEP, Python, Python增强提案, ReadTheDocs, reStructuredText, Sphinx, 开发标准, 开源项目, 数据管道, 文档系统, 无后门, 社区治理, 编程语言规范, 自动笔记, 软件工程, 逆向工具, 静态站点生成