python autopep8,python pe8规范

  python autopep8,python pe8规范

  PEP是Python Enhancement Proposal的缩写,通常翻译为“Python Enhancement Proposal”。每个PEP都是Python社区的技术文档,引导Python向更好的方向发展,其中8号增强提案(PEP 8)是针对Python语言编写的代码风格指南。虽然我们可以在语法没有问题的前提下随意写Python代码,但是在实际开发中,写出风格一致的可读代码是每个职业程序员都应该做的事情,也是每个公司的编程规范都会提出的要求。当许多人合作开发一个项目(团队开发)时,这些尤其重要。我们可以在Python的官网上从PEP 8链接中找到这个文档。让我们对这份文件的关键部分做一个简单的总结。

  相关:《Python入门教程》

  空格的使用

  1.使用空格表示缩进,而不是制表符。这对于习惯了其他编程语言的人来说简直不可理喻,因为大部分程序员都会用Tab来表示缩进。但是,你要知道Python并没有像C/C或者Java那样用花括号构造代码块的语法。在Python中,分支和循环结构都使用缩进来表示哪些代码属于同一级别。鉴于这种Python代码比许多其他语言更依赖于缩进和缩进宽度。在不同的编辑器中,Tab的宽度可能是2、4或8个字符,甚至是其他更离谱的值。用Tab表示缩进,对Python代码来说可能是一场灾难。

  2.每一层与语法相关的缩进用4个空格表示。

  3.每行的字符数不应超过79个字符。如果表达式因为太长而占用了多行,那么除了第一行之外的所有其他行都应该在正常缩进宽度上加上4个空格。

  4.函数和类的定义,代码前后要用两个空行隔开。

  5.在同一个类中,每个方法应该用一个空行隔开。

  6.二元运算符的左右两边要预留一个空格,只需要一个空格。

  标识符命名

  PEP 8提倡在Python中用不同的命名风格来命名不同的标识符,这样当你读代码的时候,你就可以确定标识符在Python中起什么作用(在这一点上,Python自己的内置模块和一些第三方模块做的不是很好)。

  1.变量、函数和属性要用小写字母拼写,如果有多个单词,要用下划线连接。

  2.类中受保护的实例属性应该以下划线开头。

  3.类中的私有实例属性应该以两个下划线开头。

  4.类和异常的名字应该用每个单词的第一个字母大写。

  5.模块级常量应该全部是大写字母,如果有多个单词,应该用下划线连接。

  6.对于类的实例方法,第一个参数应该命名为self以表示对象本身。

  7.对于类的类方法,第一个参数应该命名为cls,以表示类本身。

  表达式和语句

  在Python的禅宗中有这样一句名言(可以使用import this来查看):“应该有一种——最好只有一种——禁忌的方式来做这件事。”翻译成中文,意思是“应该并且最好只有一种确切的方法去做某事。”这句话传达的思想在PEP 8中也是无处不在的。

  1.用内联形式的否定词,而不是把否定词放在整个表达的前面。例如,如果a不是b比如果a不是b更容易理解。

  2.不要判断一个字符串、列表等。是零或没有元素。你应该通过写如果不是x来检查。

  3.哪怕if分支只有一行代码,for循环,exception catch等除外。不要把代码和if、for、except等一起写。分开写会让代码更清晰。

  4.import语句总是放在文件的开头。

  5.引入模块时,从math导入sqrt比导入math更好。

  6.如果有多个import语句,那么要分成三个部分,从上到下分别是Python标准模块、第三方模块和自定义模块。每个部分都应该按照模块名称的字母顺序排列。

郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。

留言与评论(共有 条评论)
   
验证码: