PEP 8 – Style Guide for Python Code #

PEP 8 #

https://peps.python.org/pep-0008

PEP 8为Python主发行版中标准库的Python代码提供编码规范。有关Python C实现中C代码的风格指南，请参阅PEP 7。 PEP 8和PEP 257（文档字符串规范）是从Guido 原始的《Python 样式指南》文章中改编而来，并结合了Barry样式指南的一些内容。 随着时间的推移，随着更多规范的制定以及语言本身的发展，本文档中的样式指南不断演变，过时的规范将会被淘汰。 许多项目都有自己的编码风格指南。如果出现冲突，项目特定的编码规范应优先于本文档中的规范。

PEP8是关于如何格式化Python代码的样式指南。

Black Formatter #

https://github.com/psf/black

Black是一款不妥协的Python代码格式化工具。使用它时，您同意放弃对细节格式的手动控制。作为回报，Black为你提供速度、确定性，并免除pycodestyle对格式化的唠叨。你将节省时间和精力，专注于更重要的事务。 经过Black格式化的代码无论在哪个项目中，外观都保持一致。格式化变得透明，你可以更加专注于内容本身。 Black通过生成尽可能小的差异，使得代码审查更加高效。

Black是一款符合PEP 8标准的自动化的格式化工具。Black会就地重新格式化整个文件。

Black是Python Software Foundation的官方项目。使用Black与Python社区共享一种共同的风格，有助于与他人进行协作。

Black提供的配置选项非常少，这使得在同一个代码库上工作的开发人员很容易就代码风格达成一致。

The Black code style #

• The Black Code Style: Current style
• The Black Code Style: Future style

Black 代码风格的变更受到稳定性政策的约束：

• The Black Code Style: Stability Policy

VS Code Extentions #

• Black Formatter

1"[python]": {
2    "editor.defaultFormatter": "ms-python.black-formatter",
3    "editor.formatOnSave": true
4}

• autoDocstring - Python Docstring Generator

1"autoDocstring.docstringFormat": "google",
2// "autoDocstring.docstringFormat": "pep257",