PEP 8 部分规则

一些应该遵守的规则

遵循一定的规则能使代码更加整洁、规范,提高可读性。PEP 8 是针对 Python 代码格式而编订的风格指南,下面列举出一些重要的 PEP 8 的规则。

代码格式

  • 使用 space 表示缩进而不是 tab。
  • 和语法相关的每一层缩进都用 4 个空格表示。
  • 每行字符数不应超过 79。
  • 占据多行的表达式,除首行外其余各行都应在缩进级别上再加四个空格。
  • 文件中的函数与类使用两个空行隔开。
  • 同一个类中,各方法间用一个空行隔开。
  • 使用下标获取列表元素、调用函数或给关键字复制的时候,不要在两旁加空格。
  • 变量赋值时,赋值符号左右各加一个空格即可。

命名

  • 变量、函数及属性使用小写单词下划线相连,如 my_car
  • 受保护的实例属性,单下划线开头,如 _len_of_bmw
  • 私有实例属性,双下划线开头, 如 __color_of_bmw
  • 类与异常,大驼峰命名,如 CarFactory
  • 模块级别常量,全大写用下划线相连, 如TOTAL_PRICE
  • 类中的实例方法,首个参数应为 self,以表示该对象自身。
  • 类方法的首个参数应该为 cls, 以表示类自身。

表达式和语句

  • 使用 if a is not b 而不是 if not a is b, 不要把否定词放在整个表达式前面。
  • 不要通过 if len(somelist)==0 之类的语句来判断列表是否为空,应该使用 if not somelistif somelist
  • 不要编写单行的 if 语句、forwhile 循环及 except 复合句,应该分成多行,使得层级更加清晰。
  • import 语句应该放在文件开头
  • import 时不应简写,应该使用 from package import module 而不是直接 import module
  • import 语句应该分为三部分,分别表示标准模块库、第三方模块及自用模块
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容