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://bjxw.gstypm.com/126.html

(13)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2017年4月17日 下午5:21
下一篇 2017年4月17日 下午10:54

相关推荐

  • 2023“阜新国资国企杯”·LYB李永波全球业余羽毛球锦标赛挥拍开赛!

    2023“阜新国资国企杯”·LYB李永波全球业余羽毛球锦标赛挥拍开赛! 2023年6月17日,2023“阜新国资国企杯”·LYB李永波全球业余羽毛球锦标赛在阜新市体育馆正式开赛。来自国内外的422名羽毛球爱好者挥拍阜新,再次在阜新市上演一场羽毛球视听盛宴。辽宁省体育事业发展中心主任岳伟,阜新市委常委、宣传部部长、市委教育工委书记王一民,中国羽毛球功勋教练、L…

    2023年6月17日
    1600
  • 神州鲲泰携手铸远信息推动教育行业信创适配

    在数据信息量井喷式发展、科技发展自立自强的当今时代,信创适配被赋予了重要发展意义,国产化算力日渐壮大,整体算力产业生态呈现多样化发展趋势。近日,神州鲲泰与厦门铸远信息技术有限公司针对“铸远乐私塾服务系统”完成软件鲲鹏迁移移植、数据迁移、数据平台测试测评等相关适配服务,为铸远信息更好地满足信创市场需求、服务教育行业做好技术储备。 本次适配工作主要针对乐私塾平台…

    2024年4月12日
    1990
  • 2023中国(北京)京广文化新干线活动圆满举办!

                5月10日,由广州市黄埔区文化广电旅游局、广州(黄埔)对外文化贸易基地指导,中关村e谷、北京市海淀区文化创意产业协会、中关村数字媒体产业联盟、科学城(广州)发展集团有限公司联合主办的“2023中国(北京)京广文化新干线活动”在京圆满举行。 本次交流会以“数字创e领航向·京广文化助发展”为主题,旨在加强京广文化协同和交流,形成…

    2023年5月11日
    2210
  • 中国造世界上最大液化气船:长230米 领先国际先进水平

    快科技4月26日消息,目前世界上最大的超大型液化气船计划于今日交付船东——新加坡PETREDEC公司。该船是江南造船自主研发设计的第四代超大型液化气船,总长230米,型宽36.6米,服务航速16.5节,使用双燃料动力,燃油续航达到23000海里,油耗和气耗水平领先国际水平。93000立方米超大型液化气船首次应用江南造船自主研发创新设计的舵球节能装置技术,使得…

    2023年4月26日
    1590
  • 苹果不让微信公众号做打赏,其他公司比腾讯还慌

    苹果和腾讯这两个神仙只是闹别扭,其他的小鬼便遭了殃。

    2017年4月20日
    1851
  • 在交互设计过程中,你需要持续关注的五个问题

    认真对待交互设计过程中的每一个设计环节、每一个问题,是提高交互稿质量的基石。过程中的问题很多,需要我们持续关注并解决。

    2017年4月18日
    1722
  • 屈臣氏业绩连续下滑的五大思考:零售业不能“等等看”,要“马上行动”

    行业龙头的业绩,就是市场表现的缩影

    2017年4月17日
    2132
  • 第一次负责从0到1的产品时要注意哪几点?

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

    2017年4月25日
    2016
  • 世界,您好!

    欢迎使用WPCOM。这是您的第一篇文章。编辑或删除它,然后开始您的博客!

    2017年4月14日
    5.5K2
  • 海底捞外送场景化定制拓展年轻人消费新场景:不仅送餐还送“氛围组”

    “54321上福袋!”7月14日下午,由西南交通大学主办的“美国大学生成都研学活动”中美国大学生代表在海底捞支付宝直播间展开了一场新奇的“直播带货体验”。 与此同时,来自耶鲁大学、宾夕法尼亚大学、布朗大学等高校的30名美国师生以及西南交大的师生们,在成都陕西会馆的百年川西庭院里享用到了海底捞外送的定制团餐。团餐精心选用了兼顾本地特色以及国外口味的锅底以及成都…

    2023年7月18日
    1580