Python的PEP8风格 | StriveZs的博客

Python的PEP8风格

《Python Enhancement Proposal#8》又叫PEP8,它是针对Python代码格式而编订的风格指南。尽管可以在保证愈发正确的情况下可以随意编写Python代码,但是,采用一致的风格来书写可以令代码更加易懂、更加易读。采用和其他Python程序员相同的风格来写代码,也可以使项目更利于多人协作。即使代码只会由你自己阅读,遵守这套风格也依然可以令后续的修改变得容易一些。 以下为几条应该遵守的规则: 1.使用space(空格)来表示缩进,而不是tab(制表符) 2.和语法相关的每一层缩进都用4个空格来表示 3.每行的字符数不应超过79 4.对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加上四个空格 5.文件中的函数与类之间应该用两个空格隔开 6.在使用下标来获取列表元素、调用函数或关键字参数赋值的时候,不要再两旁添加空格 7.为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只写一个就好 8.对于函数、变量及属性应该用小写字母来拼写,各单词之间以下划线相连,例如:lower_case 9.类中受保护的实例属性,应该以单个下划线开头,例如:_protected 10.类中私有的实例属性,应该以两个下划线开头,例如:_private 11.类与异常,应该以每个单词首字母均大写的形式来命名,例如:BusStation 12.模块级别的常量,应该全部采用大写字母来拼写,各单词之间以下划线相连,例如:ALL_MAPS 13.类中的实例方法,应该把首个参数命名为self(在PyCharm中自动生成),来表示对象自身 14.类方法的首个参数,应该命名为cls,以表示该类自身 15.采用内联形式的否定词,而不要把否定词放在整个表达式前面,例如:应该写入if a is not b而不是if not a is b 16.不要通过检测长度的办法(使用len)来判断somelist或somelist[i]是否为[]或为空值,而是应该采用if not somelist/if not somelist[i]这种写法来检查,如果不为空的话会自动将其赋值为True 17.不要编写单行的if语句、for循环、while循环及except复合语句,而是应该把这些数据分成多行来书写,以示清晰 18.import语句应该总是放在文件开头 19.引用模块时,应该使用该模块的绝对名而不是根据模块的路径来引用,例如:应写成from bar import foo 而不是仅写为import foo (注:这里指的是再调用外部包时所使用的,而不是python自己带的或者已经安装的) 20.文件中的那些import语句应该按照顺序划分为成三个部分,分别表示标准模块、第三方模块以及自用模块,在每一部分中,各个import语句应该按模块的字母顺序来排列 21.当编写Python代码时,总是应该遵守PEP8的风格指南,方便代码的移植和阅读 22.与广大Python开发者采用同一套编码风格,可以是项目更加利于多人协作,同样可以令后续的修改工作变得更加容易

StriveZs wechat
Hobby lead  creation, technology change world.
  • Post author: StriveZs
  • Post link: 1584.html
  • Copyright Notice: All articles in this blog are licensed under CC BY-NC-SA 3.0 unless stating additionally.