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的方式。

转载,请注明出处:https://www.tuilafen.com/126.html。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,请发送邮件至756710817@qq.com 举报,一经查实,本站将立刻删除。

(13)
上一篇 2017年 4月 17日 下午5:21
下一篇 2017年 4月 17日 下午10:54

相关推荐

  • 产品终极化形态关键指标:用户洞察(User Insight)

    互联网终极化形态必将是其对应企业的商业化形态,依托营销的方式销售其产品并获得盈利是互联网企存活下去的根本。而对于用户的深度解读是产品业务线开展的参考依据,用户洞察概念在互联网产品上的应用也将越来越凸显其重要意义。

    2017年 4月 17日
    1.5K00
  • 如何构建强势企业品牌营销策划管理?

    如何构建强势企业品牌营销策划管理?品牌营销策划的目的是要为企业的品牌营销活动提供一个科学的指导方案,使企业品牌营销活动更具有效率,以便成功的塑造和传播品牌的形象,最终产生品牌价值。 1、明天趋势取代今天优势企业家要有战略洞察力,任何有理想的企业家都不应该仅满足于亦步亦趋和摸着石头过河,也不应该仅着眼于一时一地的得失,而应该站在全球化竞争的角度,在纷繁复杂中找…

    2022年 12月 10日
    2300
  • 红酒品牌策划方案_葡萄酒营销推广策划书

    今天的红酒市场已进入一个新时代,新的消费群体已成为市场的主要消费者。他们有想法,个性,品味和强大的消费能力。与此同时,红酒公司的产品开发尚不确定。对于普通人来说,每天喝200ml红酒有很多好处。 红酒品牌策划方案如何做? 红酒品牌策划方案如何做? 虽然红葡萄酒很好,但每天喝一点的人并不多。主要原因是红葡萄酒的保存相对较差。一旦打开,必须在三天内完成,否则很容…

    2022年 12月 10日
    2400
  • 有哪些类型的企业网络营销方案?

    有哪些类型的企业网络营销方案?网络营销目标与传统营销目标相同,即确定开展网络营销后达到的预期目的,以及制订相应的步骤,组织有关部门和人员参与。小编建议大家在制订网络营销方案时,必须考虑到与企业的经营战略目标是否相一致,与企业的经营方针是否吻合,与现有的营销策略是否产生冲突,这就要求在制订方案时必须有企业战略决策层、策略管理层和业务操作层的相关人员参与讨论,并…

    2022年 12月 10日
    4500
  • 电商行业网络营销模式特点

    如今电商行业发展趋势呈上升状态,电子商务的前提就是建立在网络的基础上,如果离开了网络,电子商务是根本不可以发展得起来。那么电商行业网络营销模式有哪些? 电商行业网络营销模式 1、电子商务有何特点电子商务通常具有因特网本身所具有的开放性、全球性、低成本、高效率的特点,也成为电子商务的内在特征,并使得电子商务大大超越了作为一种新的贸易形式所具有的价值,它不仅会改…

    2022年 12月 10日
    4100

发表回复

登录后才能评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信