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

(1093)

相关推荐

  • 看小说好几年了越来越挑剔了现在书荒求推荐好看的穿越重生古言文笔要好不要幼稚的

      么智障也写已赞过已踩过你对这个回覆的评价是?评论收展开全数老是讲我也书荒 良多小说看着我就像骂人这起  个下面的环节词可选中1个或多,关材料搜刮相。材料”搜刮整个问题也可间接点“搜刮。  去看《梦落青春》《陌上相思烬》展开全数若是要古言的书我保举你,经出书的册本文笔很好是已。回覆的评价是?评论收已赞过已踩过你对这个起

    好闻分享 2022年7月19日
    400
  • 页数怎么设置(如何删除word空白页)

    如果实在有比狗皮膏药还难缠的空白页无法删除 这里说一个万能的删除WORD空白页的办法 在原文档末尾多回车几下,然后把回车以上的所有内容全部复制到新建WORD文档 欸,我新建一个,把需要的内容原封不动地复制过来,欸,崭新的没有空白页的文档就做好啦 源文档直接永久删除干净,清清爽爽每一天!!!

    2022年6月30日 好闻分享
    10.0K00
  • 飞秒多少钱(飞秒激光价格)

    齐鲁晚报·齐鲁壹点记者 张如意 通讯员 汪心海 王鹏策 十一长假期间,山东第一医科大学附属眼科医院(山东省眼科医院)角膜屈光科迎来假期第一个手术日,大厅中人来人往。据了解,在中秋节后的第一天,十一长假中第一个手术日,角膜屈光科在一天内进行五十余台近视手术。 日前,山东省眼科医院发起“庆双节十一假期钜惠”活动,10月1日——8日,于该院接受激光近视手术,均可享…

    2022年7月7日
    10.0K00
  • 关于青春的个性签名

      可选中1个或多个下面的环节词,搜刮相关材料。也可间接点“搜刮材料”搜刮整个问题。  6.我们都是芳华的过客,一路疯过,一路闹过,一路笑过。最初是在一路抱着痛哭,然后各奔工具  8.芳华是个感动季候,动不动就许下这个许诺,哪个许诺,等光阴一过,一切不外是白纸一张  13.那些年爱过的人,那些年犯过的傻,那些年我们一路说过得将来,你们还记得吗

    好闻分享 2022年7月17日
    500
  • 2017年愚人节整人恶搞短信祝福语大全,愚人节经典短信祝福(图

      得糊涂做人难,而不涂要糊;智若愚干事大,而不蠢要愚;痴不癫处世假,而不笨要痴。充愣装傻,是福吃亏。傻福傻人,常乐知足。人节愚,愚起来高兴!  了动物园了秋游去不!园发布闭园通知方才合肥动物!5个月为期近!要闭园为什么?  花骨朵粉红,小熊衫白白,跳小碎步蹦蹦跳,蜜含笑容甜甜美。的造型最可爱,的行径最活跃,的哲人节过最愉快!友朋,欢愉节日!整人短哲人节信 …

    好闻分享 2022年7月19日
    200
  • 我已记不清你的面容

    自我来到这个世界 我就不曾认真的去看过你的 里,你总是通过诉说来 怀念作为一个的 ,常年在外,让瘦小的你,独自十月怀胎; 父亲,从未在你需要的时候,让你找到依靠; 父亲,从不体贴你的不易和,让你感受到。。。。。。 而你,起早贪黑,一个人带着我 在山间,在田野,在梦里。 你细数着,父亲的过错 倾诉着自己的不幸福 我,从来都是你的掌中宝 打、骂、罚、爱 你是一个…

    好闻分享 2022年7月14日
    10.0K00
  • 1114佳软推荐:内涵段子手必装APP,好污

      最大的内涵社区内涵段子国内,涵会友以内,有我们才懂你的诙谐只!新颖最风行的段子一扫而光收集上最,队每日更新专业编纂团!支撑原创上传内涵段子强力,深深被藏匿的你空有一身内涵却,你的组织了是时候找到!如斯不只,以审核其他网友的段子身为内涵高手的你还可,新颖段子各类原创,内涵内不,了算你说!  个星球上最暴笑的实在糗事糗事百科手机客户端是这,界各地五花八门的糗…

    好闻分享 2022年7月19日
    600
  • 情话高手!石佛一个词甜死媳妇,呆嫂高调秀恩爱

      如许一个场景:履历了8连客从这段文字傍边不难脑补出,:牛仔之旅横贯全明星十几天离家之后(注,回到过圣城)这期间邓肯,回到本人的家里邓肯拖着箱子,看到爱人出此刻门口未施粉黛的瓦妮莎,洗头心中略微有些尴尬想着本人今天还没有,到女友之后可是邓肯看,她搂在怀里放下箱子将,亲爱的你今无邪美只说了一句:“。”  前妻艾米-邓肯离婚邓肯在2013年跟,与瓦妮莎在一路的…

    好闻分享 2022年7月19日
    200
  • 如何知道妻子的微信聊天记录,老婆出轨了怎么恢复聊天记录

    夫妻之间总是有人会想要知道自己另外一半的微信聊天信息内容,如果我们想要知道自己妻子的微信聊天记录,对于我们来说该用什么方法才可以知道自己妻子的微信聊天记录内容呢?在这里为大家准备的就是有关于如何知道妻子的微信聊天记录的方法和内容较长,希望能够对大家有所帮助,欢迎大家阅读参考界限。 怎么查 1 想要调查自己老婆的微信聊天记录,对于我们来说永远要比调查普通人的微…

    2022年7月11日
    10.0K00
  • 如何还原不小心删除的微信聊天记录

    微信从一开始出现到如今这么红火,可以说它就是淋漓尽致体现了社交大熔炉的APP,因为所有的社交关系都可以囊括在这样一档APP当中,但是有的时候微信也会出现各种各样的bug或者说因为我们的操作不当,导致一些聊天记录的丢失或者说消灭。可是聊天记录这种东西对于很多人来说都是非常重要的,尤其是通过这个APP办公的人们来说,这些聊天记录都是他们重要的证据,一旦因为自己没…

    2022年7月11日
    10.0K00

发表回复

您的电子邮箱地址不会被公开。




分享本页
返回顶部