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://tj.fjcxin.com/126.html

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

相关推荐

  • 中国红牛被泰国红牛告了!华杉回应:一审判决未生效 商标有50年

    近日,“中国红牛”被“泰国红牛”告了,要求“中国红牛”旗下多款红牛饮料禁止生产、销售,并索赔3000万元一事,引起关注热议。 泰国天丝医药保健有限公司公布的最新判决书显示,2022年10月31日,吉林高院审理了泰国天丝针对中国红牛旗下的红牛维他命饮料(湖北)有限公司、北京红牛饮料销售有限公司、北京红牛饮料销售有限公司吉林分公司,侵犯红牛商标权和不正当竞争的案…

    2023年4月23日
    0
  • 干货,产品经理如何进行需求分析

    需求分析做错了,做再多也是无用功

    2017年4月17日
    2
  • 舞力全开!雕牌全民舞蹈挑战大赛精彩开启!

    天津的春天来的比以往更早一些,因为“舞力全开耀亚运 清洁除菌用雕牌”全民舞蹈挑战大赛正在如火如荼的举行! 3月4日,来自天津的数百名“舞林高手”同台竞技,在全民舞蹈挑战大赛的舞台上,既展示了曳步舞的千面魅力,又激发了天津市全民健身的向上活力。 在大赛现场,随着裁判员与运动员的宣誓,比赛拉开了帷幕,各支参赛队伍精神饱满、热情高涨,身着酷炫潮流的服装,迈着整齐的…

    2023年3月5日
    0
  • 5款最好的安卓界面设计工具推荐

    5款优秀的安卓界面设计工具,简单实用,快Get起来吧!

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

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

    2023年6月17日
    0
  • 从设计师到创业者,中间的差别是什么?

    从设计师到创业者,这中间的差别是什么,我需要做什么准备?

    2017年4月17日
    2
  • 从设计默认值开始,给用户和产品带来更好的用户体验

    默认值是你的数字产品的默认基准设定值,这些填充设置的默认值虽然常常不多,但是换个角度来看,它更像是是设计师为设计作出一些基本的“决定”,帮助用户更快的让产品运行起来,上手使用。默认值对于产品和用户而言很重要,今天的文章,我们将会探讨设计师要如何设置默认值的样式、交互和字段细节,确保给用户和产品都能带来更好的用户体验。

    2017年4月17日
    3
  • 产品终极化形态关键指标:用户洞察(User Insight)

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

    2017年4月17日
    0
  • 11家综合新闻媒体包收录

    11家综合新闻媒体包收录 城市消费网 https://www.iv-field.com/14481.html时尚消费网 https://news.qzstax.com/9060.html消费观察网 https://xfgc.lanjingkuaibao.com/10591.html中原新闻快报 https://news.gyxinw.com/7214.htm…

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

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

    2017年4月20日
    1