Python 增强提案
.. image:: https://github.com/python/peps/actions/workflows/render.yml/badge.svg :target: https://github.com/python/peps/actions
该仓库中的 PEPs 会自动发布在 https://peps.python.org/ 网站上。如需了解更多关于 PEPs 的用途以及如何撰写 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/ 获取。
为 PEPs 做贡献
请参阅 Contributing Guidelines <./CONTRIBUTING.rst>_。
检查 PEP 的格式与渲染效果
请勿提交包含 reStructuredText 语法错误的更改,这类错误会导致 PEP 生成失败,或使渲染结果与您的预期出现重大偏差。
浏览“阅读文档”预览
对于每个 PR,我们都会使用 Read the Docs <https://about.readthedocs.com>_ 自动生成已渲染 PEPs 的预览版本。
您可以在 PR 页面底部的合并框中找到它:
- 点击“显示所有检查项”以展开检查项部分
- 找到
docs/readthedocs.org:pep-previews所在的行 - 点击右侧的“详细信息”
在本地渲染 PEPs
请参阅 build documentation <./peps/docs/build.rst>__ 以获取关于如何在本地构建 PEPs 的完整说明。
简而言之,请在全新且已激活的虚拟环境中运行以下命令:
.. code-block:: bash
# 安装依赖项
python -m pip install -U -r requirements.txt
# 构建 PEPs
make html
# 或者,如果您没有 ‘make’ 命令:
python build.py
生成的 HTML 文件位于 build 目录下。
检查与修复 PEPs 的问题
您可以使用我们的预提交检查工具套件,按需或在提交代码时自动检查并修复常见的代码格式与拼写问题。
详情请参阅 Contributing Guide <./CONTRIBUTING.rst>_。