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

(13)
银率网的头像银率网
上一篇 2017年4月17日 下午5:21
下一篇 2017年4月17日 下午10:54

相关推荐

  • 环卫龙头侨银股份成立人机交互技术公司,加速布局AI应用领域

    7月24日,银率网从侨银股份处了解到,近日,侨银股份与爱化身科技共同成立天奈人机交互技术(广州)有限责任公司,双方将依托侨银股份在“天、空、地、水、生活、生产”一体化城市数智管理与智能作业体系中积累的多场景实践,结合爱化身科技多模态交互智能体平台的技术优势,把AI能力渗透到更细分的城市服务场景中,从而催生全新的、更人性化的智能化应用。(银率网 何明俊)

    2025年7月24日
    1300
  • 盒马鲜生:未来一年新开100家店,门店总数将超过500家

    银率网获悉,8月7日,盒马公布了最新开店计划,盒马鲜生计划财年内(2025年4月至2026年3月)开出近100家门店,新增超过50个覆盖城市,届时盒马鲜生门店数将超过500家。过去一年,盒马转向聚焦盒马鲜生和社区折扣店两个主力业态,陆续退出X会员店等探索型项目,作为盒马的主力业态,目前,盒马鲜生已布局全国超过50个城市,截至今年3月底门店已达420家。(银率…

    2025年8月7日
    1500
  • 油价调整:注意,预计上调610元/吨,油价还在涨!

    今日是新一轮油价调整周期的第3个工作日,当前预计油价上涨610元/吨,相比昨日的油价预计涨幅增加30元/吨,折合每升油价上涨0.46-0.55元。远超油价上调红线,油价要大涨! 注意,油价大涨中 注意,在紧张的中东局势支撑下,国际油价重新上涨,国内预计油价涨幅继续上升中。目前才第3个工作日,距离油价调整还有11天,很难想象接下来国内油价能被推到什么高位。 这…

    2025年6月20日
    5400
  • 特朗普怒骂鲍威尔“木头脑袋”:每年6000亿白烧,全怪这个蠢蛋

    据CNBC报道,特朗普周四在白宫发言时再次施压美联储,要求将利率下调两个百分点,并称美联储主席鲍威尔是“蠢蛋”。他表示,若降息,美国每年可节省6000亿美元,“但我们就是无法让这个人去做”。 特朗普称,若通胀上升,他支持加息,但目前数据显示通胀正在下降。他还警告称,“我可能得采取一些强硬措施”。 此前数小时,美国劳工部数据显示,5月美国生产者价格涨幅低于预期…

    2025年6月13日
    5600
  • 美国要下场,黄金却怂了!

    隔夜,现货黄金遭遇猛烈抛售,大幅下挫近20美元,最终收报于3369.33美元。今日欧市盘中,黄金窄幅震荡,目前在3366美元附近徘徊。 美联储发出警告! 隔夜,美股三大股指涨跌不一,截至收盘,道指跌0.1%,报42171.66点;标普500指数跌0.03%,报5980.87点;纳指涨0.13%,报19546.27点。 消息面上,美联储公布6月利率决议,将基准…

    2025年6月20日
    5100

发表回复

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

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

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

关注微信