/python-style-guide

谷歌开源项目Python风格指南与编写简洁可读代码的建议

Google开源项目Python编码风格指南


@作者:鱼丸粗面zhuoyin94@163.com

Google开源项目Python编码风格指南[1]中文翻译,翻译过程中主要参考了项目[2]与项目[3],但在细节方面捋顺了一些含义,并根据最新指南添加了部分内容。

其中本项目文件组织结构:

  • google-python-style-guide-cn.md:谷歌开源项目的Python语言指南[1]。主要包括四大部分内容:
    • 背景(Background)。介绍Python在谷歌的应用。
    • Python语言规范(Python Language Rules)。介绍Python语言的一些格式检查工具的使用与语法应用的一系列定义、优势、劣势与最终规范决定。
    • Python风格规范(Python Style Rules)。如何写出具有Python风格的代码。
    • 最后的话(Parting Words)。最后给出的编码的总体性原则。
  • the-art-of-readable-code.md:编写一般性可读代码的一些规范,主要内容总结自文献[4]。
  • tct-python-coding-guide.md:基于Google的Google Python Style Guide编写可读代码的艺术总结的适用于团队Python 3.x开发的简明指南。
  • .//doc_pdf//Style guides for Google-originated open-source projects.pdf:当前翻译的谷歌开源项目Python语言规范的版本(其中项目[1]的内容长期更新,因此目前本翻译版本已经落后于实际指导),可与中文译版对照学习。

囿于个人水平有限,在翻译过程也有部分不甚解或者理解不到位的内容。如有疑问,请在issue中按照模板进行提问,并在issue中进行讨论,谢谢各位!同时感谢开源社区(项目[2]与项目[3])的前序翻译版本,大家在学习过程中也可一并对照项目[2]与项目[3]检视细节上的不一致之处。

References


[1] https://google.github.io/styleguide/pyguide.html

[2] https://github.com/shendeguize/GooglePythonStyleGuideCN

[3] https://github.com/zh-google-styleguide/zh-google-styleguide

[4] 编写可读代码的艺术:Duncan S P. The Art of Readable Code[J]. Software Quality Professional, 2012, 14(2): 47.

[5] 代码整洁之道:Martin R C. Clean code: a handbook of agile software craftsmanship[M]. Pearson Education, 2009.