Python 编码风格指南中译版 Google SOC
Google为Python项目提供了一系列编码规范,这些规范适用于大中小型项目,旨在提高代码的可读性和一致性,便于长期维护和管理。本指南不仅涉及Python编程语言的基本准则,也涵盖了具体的编码风格。 在Python语言方面,推荐使用pychecker工具以发现代码中可能存在的问题。在导入模块和包时,虽然可以使用import*的方式,但为了可读性和避免命名冲突,建议不要滥用。完整路径导入是指在导入模块时指定完整的路径,这样做可以明确模块来源,有助于解决模块命名冲突的问题。异常处理是Python中一种强大的错误管理方式,应该正确使用。全局变量的使用应保持谨慎,因为过度使用可能会使代码难以跟踪和维护。内嵌、本地或内部类和函数在Python中是可以使用的,它们能够提高代码组织性和封装性。 ListComprehensions(列表推导式)提供了一种简洁的方式来进行列表生成和处理,只要它们易于理解和阅读即可采用。此外,对于默认迭代器和运算符的使用,生成器的运用,以及使用apply、filter、map和reduce函数进行函数式编程,在单行表达式中都是可接受的。 Python编码风格方面,建议避免使用分号,且每行代码的长度控制在最多80个字符以内。圆括号的使用要吝啬,不要过度依赖它们。对于缩进,建议使用两个空格,而不是Tab,这一点与PEP8编码风格指南不同。空行的使用也有明确规则,函数和类之间用两个空行分隔,类的方法之间用一个空行。在代码行内空格的使用上,要尽量保持节俭。 注释方面,应该使用Python的docstrings(文档字符串),以及块注释和行内注释来提高代码的可读性。类应该继承自object,以便使用Python的面向对象特性。字符串操作时,应避免使用多次的“+”和“+=”操作符进行字符串拼接,以提高性能。TODO注释应采用统一的格式,例如“TODO(username)”,并在适当的位置注明。import语句的分组、排序和其它高级特性,例如线程,由于Google App Engine不支持,应避免使用。 总体来说,该编码风格指南强调了代码的一致性、可读性和可维护性,提供了详细的规范和建议,使Python开发者能够更好地遵循既定的规则,从而保障代码质量和项目长期发展。需要注意的是,虽然这些规范是强制性的,但出于必要性和特殊情况,某些规范可能被允许不执行。不过,在这些情况下,仍然需要遵循指南末尾提出的一致性建议。如果开发者对这些规范有疑问,可以通过发送邮件到开发者邮件列表进行询问,并在邮件标题中注明“Python style:”以便归档和查找相关讨论。
剩余22页未读,继续阅读
- 粉丝: 0
- 资源: 6
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助