PEP8 Python 编码规范整理

决定开始Python之路了,利用业余时间,争取更深入学习Python。编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。所以今天根据PEP8整理了一份,以后都照此编码了,还会持续更新。

一 代码编排

1 缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。

2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。

3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

二 文档编排

1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。

2 不要在一句import中多个库,比如import os, sys不推荐。

3 如果采用from XX import XX引用库,可以省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。

三 空格的使用

总体原则,避免不必要的空格。

1 各种右括号前不要加空格。

2 逗号、冒号、分号前不要加空格。3 函数的左括号前不要加空格。如Func(1)。4 序列的左括号前不要加空格。如list[2]。5 操作符左右各加一个空格,不要为了对齐增加空格。6 函数默认参数使用的赋值符左右省略空格。7 不要将多句语句写在同一行,尽管使用‘;’允许。8 if/for/while语句中,即使执行语句只有一句,也必须另起一行。

四 注释

总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。

1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

# Description : Module config. # # Input : None # # Output : None

2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x但是这种方式尽量少使用。3 避免无谓的注释。

五 文档描述

1 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。2 如果docstring要换行,参考如下例子,详见PEP 257

“””Return a foobang Optional plotz says to frobnicate the bizbaz first. “””

六 命名规范

总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。1 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。2 模块命名尽量短小,使用全部小写的方式,可以使用下划线。3 包命名尽量短小,使用全部小写的方式,不可以使用下划线。4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。5 异常命名使用CapWords+Error后缀的方式。6 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。7 函数命名使用全部小写的方式,可以使用下划线。8 常量命名使用全部大写的方式,可以使用下划线。9 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。11 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

七 编码建议

1 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。2 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。3 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。4 异常中不要使用裸露的except,except后跟具体的exceptions。5 异常中try的代码尽可能少。比如:

try: value = collection[key] except KeyError: return key_not_found(key) else: return handle_value(value)

要优于

try: # Too broad! return handle_value(collection[key]) except KeyError: # Will also catch KeyError raised by handle_value() return key_not_found(key)

6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如

Yes: if foo.startswith(‘bar’):优于No: if foo[:3] == ‘bar’:7 使用isinstance()比较对象的类型。比如Yes: if isinstance(obj, int): 优于No: if type(obj) is type(1):8 判断序列空或不空,有如下规则Yes: if not seq:if seq:优于No: if len(seq)if not len(seq)9 字符串不要以空格收尾。10 二进制数据判断使用 if boolvalue的方式。

本文来自投稿,不代表酌月明目液官方立场,若不慎侵害您的权益请联系站长删除,如若转载,请注明出处:http://skek.cn/126.html

(13)
微信 微信加好友 微信加好友
上一篇 2017-04-17 15:49:01
下一篇 2017-04-21 15:20:09

相关推荐

  • 减肥的正确方法?减肥可以吃红薯吗

    减肥的正确方法 减肥的正确方法包括以下几个方面: 总之,减肥需要综合运用饮食、运动、睡眠、作息和心态等多个方面的调整,才能取得最佳效果。同时,也需要注意健康减肥的方式,不要盲目节食或使用减肥药物,以免对身体造成损害。 减肥可以吃红薯吗 在减肥期间可以吃红薯。红薯属于粗粮,热量低于米饭的热量,并含有膳食纤维和果胶,可以帮助延缓胃排空,食用后会有饱腹感,适量吃红…

    2023-12-28
    10500
  • 为什么你每次和开发沟通需求,都像打仗一样?

    今天不谈产品规划,也不谈框架,更不谈原型,咱们谈谈为什么你的需求每次和开发沟通,都像打仗一样?

    2017-04-21
    3.8K01
  • 亚马逊产品负责人详解产品优化:流程零阻力策略

    你需要打磨出最佳的用户体验路径。永远留意那些会造成阻力的流程和功能——那些不好的产品总是忽略了这些。这很费力但是值得。并且这个过程并不如你想象的那么难。有时候,阻碍用户和你产品之间的可能只是两颗电池。

    2017-04-17
    1.6K02
  • 减肥吃什么能瘦下来?吃什么可以减肥

    减肥吃什么能瘦下来 减肥可以选择低脂肪、高纤维的食物: 1. 新鲜的蔬菜和水果:如芒果、苹果、火龙果、猕猴桃、芹菜、菠菜等,含有丰富的营养,低热量高纤维,可降低食欲,有助于控制摄入量,减肥纯植物微信cncnme。。 2. 避免油腻和甜食:不利于减肥,可能会增加体重。 3. 运动减肥:可以每天早晚进行锻炼。 吃什么可以减肥 减肥可选择以下食物: 1. 高蛋白低…

    2023-09-25
    2.4K00
  • 减肥最快的办法是什么?可以吃香蕉吗

    减肥最快的办法是什么 减肥最快的办法因个人情况而异,并不存在一种绝对快速的方法适用于所有人。一般而言,减肥最快的方法应该综合考虑以下几个方面: 总之,减肥需要综合考虑饮食、运动、睡眠、作息和心态等多个方面的调整,才能取得最佳效果。同时,也需要注意健康减肥的方式,不要盲目节食或使用减肥药物,以免对身体造成损害。在减肥过程中,应根据个人情况选择适合自己的方法,并…

    2023-12-28
    16600

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注

联系我们

联系我们

工作时间:周一至周日,8:30-22:30,节假日不休息

关注微信
关注微信
分享本页
返回顶部