摘要:
- PEP8 是 python 官方出品的 Python 编码规范
- 官方英文原版
- 网友中文翻译版:
- 本人整理的极简版(见下文)
- Black 是 python 官方出品的、遵守PEP8的、自动格式化工具
pip install black $black mycode.py
PSF & PEP
PSF(Python Software Foundation),Python的官方组织。PSF 提供的文档包括:
- Python Doc (API手册)
- Guide:
- 资源列表:PSF收集的各种语言的学习、开发资源
- PEP :Python Enhancement Proposals、Python 增强建议书
PEP 是 PSF 写出、收纳、提供给社区参考使用、包含新特性、规范性等内容的说明文档。
PEP在 github 上撰写、管理,自动编译html、同步到 网站 上,从2000年开始创建,至今(2019.5)仍非常活跃,如果是python的developer,建议star或watch它,实时跟踪。
PEP分了8类: 核心类、已提交、已接收、讨论中、讨论完、归档、拒绝、废弃 。
- 有些pep很庞大,如:pep8(python编程规范);也有些很简短,如:pep7(c编程规范)
- 有些pep很一本正经,如:pep569(Python 3.8 Release Schedule);有些也很搞怪,如:pep20(Zen of Python,20条禅学)
要贡献 PEP,需要参考 pep12 的模板来写,并且 PEP 不是用 markdown 写的,而是 ReStructuredText,也是标记(markup)语言,语法比 markdown 稍复杂一点点,这里有一些语法说明:
普通 Python 开发人员必读的PEP有:
- 编码规范
- 文档规范
PEP8 Style Guide for Python Code
核心类 pep 是 PEPs of PEPs,目前只有9个, PEP8 位列其中,内容是 Python 的编码规范,Python开发人员必读文档之一。
PEP8 从2001年创建,至今有141次提交:
修改(提交)集中