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

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

相关推荐

  • 亚马逊初学者运营过程中容易出现的误区

    亚马逊初学者运营过程中容易出现的误区 相信很多亚马逊卖家在做店铺之前都学习了很多关于亚马逊店铺的运营知识,并且能够正常地把店铺运营起来,但是在运营一段时间后就会陆续出现很多问题,那一定是卖家在店铺运营的时候陷入了一些误区,比如以下这几点。 没没有重视店铺的选品问题 亚马逊平台上一直有一句话就是:“七分靠选品,三分靠运营”,相信很多卖家在了解亚马逊的时候就知道…

    2022年 11月 5日
    290
  • 抖音生活服务成都营商惠民计划推动网上销售额突破2.3亿

    抖音生活服务成都营商惠民计划推动网上销售额突破2.3亿 #抖音生活服务成都助商惠民计划带动线上销售额超2.3亿#10月30日,在成都市商务局等相关部门的联合指导下,由抖音生活服务发起、字节跳动公益联合主办、众创空间支持的“这就是我爱成都”助商惠民计划于9月26日在成都启动。 这一个月来,#这是我在成都最喜欢的话题。累计线上曝光量达4.6亿,收到短视频投稿超1…

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

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

    2017年 4月 17日
    460
  • 急速国际已成为亚马逊的官方跨境物流服务提供商

    急速国际已成为亚马逊的官方跨境物流服务提供商 #急速国际成为亚马逊官方合作跨境物流服务商#10月29日消息,快捷国际近日正式完成与亚马逊的自提轨道对接,成为亚马逊官方认可的跨境物流服务商。使用国际物流快速发货的卖家,可以在亚马逊后台直接选择国际马克快速发货。具体来说,适用快速国际航运标志的车站是北美站、欧洲站、日本站和澳大利亚站;分数可以寄到12个国家,包括…

    2022年 11月 5日
    430
  • 亚马逊品类拓展及调研时期,卖家应该注意什么?

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

    2022年 11月 5日
    350
  • 跨境电商亚马逊卖家做独立站有什么优势?

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

    2022年 11月 5日
    420
  • 京东将于10月31日推出双11的“猜价格赢免单”的新玩法

    京东将于10月31日推出双11的“猜价格赢免单”的新玩法 #京东将于10月31日推出双11“猜价格赢免单”玩法#10月30日消息,京东 11.11将于10月31日晚8点全面开启。今年京东 11.11推出了“猜价格赢免费单”的新玩法。用户参与互动猜价将有机会享受“免账单”优惠。京东 11.11“猜价格赢免费票”将于10月31日正式开启,持续至11月10日,每晚…

    2022年 11月 5日
    500
  • DHL快递升级广州港设施和航线,助力跨境电商品牌出海

    DHL快递升级广州港设施和航线,助力跨境电商品牌出海 #DHL快递升级广州口岸设施、航线 助力跨境电商品牌出海#10月29日消息,本月,DHL快递广州港一系列设施及航线升级项目陆续投入运营,包括在白云国际机场设立专属航空快件集疏运区、扩建陆侧货运仓库、加密美国航线等。,将进一步提升运营能力,提高转运时效,为跨境电商品牌出海提供有力保障。 本月初,DHL快递在…

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

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

    2022年 11月 5日
    610
  • 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日
    350