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.unityuser.com/126.html

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

相关推荐

  • 抖音电商双11商城预售战报:商品曝光量同比增长2000%

    抖音电商双11商城预售战报:商品曝光量同比增长2000% #抖音电商双11预售战报:商品曝光同比增长2000%#10月31日消息,随着10月24日开启预售,抖音双11好物节正式拉开帷幕,商家进入密集冲刺阶段。抖音电商预售战报数据显示,截至10月27日24: 00,预售商品曝光量同比增长447%;抖音商城预售商品曝光量同比增长2000%;预售搜索曝光比去年同期…

    2022年 11月 5日
    1140
  • 亚马逊产品负责人详解产品优化:流程零阻力策略

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

    2017年 4月 17日
    1092
  • 亚马逊品类拓展及调研时期,卖家应该注意什么?

    亚马逊品类拓展及调研时期,卖家应该注意什么? 新品类的开展必须由许多成熟的卖家先做,但时机不好。 在这篇文章中,将说明什么时候可以展开范畴,以及应该注意什么。 一.什么情况下,你会愿意去做一个新的品类?或者愿意了解一个新的品类的信息? 第一,现在做的类别达到了理想的目标水平,再继续下去需要更多的资金、时间、精力,但是把这些资金、时间、精力投入到新的类别中就能…

    2022年 11月 5日
    1550
  • 浅谈独立站和跨境电商平台的优缺点有哪些

    浅谈独立站和跨境电商平台的优缺点有哪些 近年来,越来越多的卖家加入亚马逊的跨境电商平台,竞争十分激烈。这两年,亚马逊的平台规则越来越严格。卖家一旦违反平台规则,将面临关店处罚。所以很多卖家都在想着做独立站。其实独立站和亚马逊的跨境电商平台都各有优势。 亚马逊跨境电子商务平台的优势 流量:亚马逊是全球比较大的电商平台,所以亚马逊平台上的消费者很多,流量巨大。而…

    2022年 11月 5日
    1630
  • 第一次负责从0到1的产品时要注意哪几点?

    第一次负责从0到1的产品肯定是万分的紧张、激动,在这时千万不可大意,我根据我的经验写了些需要注意的地方。

    2017年 4月 25日
    1646
  • 干货,产品经理如何进行需求分析

    需求分析做错了,做再多也是无用功

    2017年 4月 17日
    1432
  • 11月11日京东超市7天预售报告:高端牛奶成交额同比增长230%

    11月11日京东超市7天预售报告:高端牛奶成交额同比增长230% #京东超市11.11预售7日战报:高端牛奶成交额同比增长230%#10月30日,京东超市发布了截至10月27日24: 00的11.11预售报告。战报称,今年的京东 11.11体现了“品质个性化”、“吃喝健康方便”、“功能多样化”、“农产品地标购买”四大趋势。脆饼干、水果罐头、基础功能洗发水等6…

    2022年 11月 5日
    1280
  • 产品终极化形态关键指标:用户洞察(User Insight)

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

    2017年 4月 17日
    1170
  • 跨境电商亚马逊卖家做独立站有什么优势?

    跨境电商亚马逊卖家做独立站有什么优势? 很多初入跨境电商的卖家往往会先选择跨境电商的平台,因为在平台上做跨境电商风险较小,而且可以学到很多运营经验。有一定跨境电商经验的卖家大多会再去独立站,因为独立站相比跨境电商平台有很多优势。 可以提升卖家的品牌形象。 虽然亚马逊越来越重视品牌卖家,但是随着越来越多的卖家入驻亚马逊平台,亚马逊平台上的品牌竞争也非常激烈。卖…

    2022年 11月 5日
    1480
  • Facebook平台广告投放受限的原因是什么?

    Facebook平台广告投放受限的原因是什么? Facebook平台具有用户基数大、使用时间长、广告针对性强、性价比高等优势,所以很多亚马逊公司都将Facebook引流作为站外引流的主要渠道。卖家在使用Facebook引流时,大多会使用Facebook平台的广告推广功能,而Facebook也有针对不同类型账号的广告限制,所以当卖家遇到广告限制时,可以从以下几…

    2022年 11月 5日
    1540