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

Like (13)
广众网的头像广众网
Previous 2017年4月17日 下午5:21
Next 2017年4月17日 下午10:54

相关推荐

  • 7年负债近200万,年销超2000万店铺在双十一关店了

    本文来自微信公众号:启阳路 4 号,作者:风暴眼,原文标题:《干电商 7 年负债近 200 万,年销超 2000 万店铺在双十一关店了》,题图来自:AI 生成 文章摘要 连续亏损,电商店铺无奈关店,负债近 200 万 • 退货率飙升至 80%,利润急剧萎缩 • 销售额 2000 万,却亏损 70 多万 • 连续亏损,电商店铺最终…

    2024年10月31日
    1300
  • 不学煤老板,600亿“珠宝大王”闷声加码长租公寓

    都说春江水暖鸭先知,一个行业当下最真实的势态,总能从资本的态度中窥视一二。 就在煤老板们纷纷抄底高端酒店的同时,” 珠宝大王 ” 周大福却把手伸向了长租公寓。 近日,有消息称由华住集团与光大安石联合成立的投资平台——安住此间获得市值 600 多亿的周大福企业的重要投资,但投资数额并未透露。 据悉,周大福企业此次作为新股东加入,将继续支…

    2024年10月23日
    1400
  • 88人被抖音集团辞退,永不录用!

    8 月 12 日,抖音集团发布《2024 年上半年抖音集团反舞弊通报》。 通报显示,抖音集团始终坚持对腐败、贿赂 ” 零容忍 ” 的态度,坚决反对一切舞弊和失信行为。如发现违反法律法规或员工行为准则的行为,一经查实,涉案员工一律辞退处理,永不录用。如相关行为涉嫌违法犯罪,集团将严格按照国家法律法规,全力配合司法机关调查,追究涉案人员的…

    2024年8月13日
    7500
  • 收评:创业板指全天大涨17.25% 两市成交额超3.45万亿创新高

    财联社 10 月 8 日电,市场全天大幅高开回落后再度走高,创业板指续创历史单日最大涨幅。沪深两市全天成交额 3.45 万亿元,较上个交易日放量 0.86 万亿,续创历史天量。盘面上,大金融股维持强势,券商股领涨,48 只券商股全线涨停;金融科技股继续走强,财富趋势、同花顺、顶点软件、汇金科技等多股涨停。半导体板块开盘大涨,中芯国际、芯原股份、台基股份、卓胜…

    2024年10月8日
    1000
  • 大佬们到底有多少财富?蔡浩宇730亿排第44,刘伟400亿

    ” 你知道的,不管是哪个领域的大佬,他们大多都有一个共性——那就是非常有钱。” 前两天(10 月 29 日),我拿着新鲜出炉的《2024 衡昌烧坊 · 胡润百富榜》正跟群友侃天侃地:虽然有关百富榜的游戏圈大佬我们刚刚写过报道,但可能是马化腾、丁磊等人的名字实在太过耳熟能详,因此在百富榜之外,不少朋友也会好奇,中国排在前头的 1000 …

    2024年11月4日
    800

发表回复

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

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

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

关注微信