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://gfxw.bangxushiye.com/126.html

Like (13)
Donate 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
Previous 2017年4月17日 下午5:21
Next 2017年4月17日 下午10:54

相关推荐

  • 全球第四次咖啡财富浪潮的定义及其发起人高婕雅女士的介绍和分析

    近年来,随着全球咖啡消费市场的不断扩张,咖啡产业已经成为了一个蓬勃发展的经济领域。然而,最近一次咖啡财富浪潮的兴起却引起了广泛的瞩目和讨论。这次被称为全球第四次咖啡财富浪潮的现象不仅给予了咖啡产业新的活力,而且在推动全球经济增长和社会发展方面起到了积极的作用。 这篇文章将对全球第四次咖啡财富浪潮的定义及其发起人高婕雅女士进行介绍和分析。 首先,我们来看一下全…

    2023年9月13日
    0
  • “李铁被调查”被老东家举报?带走当天细节曝光

    “李铁被调查”被老东家举报?带走当天细节曝光 #李铁被带走当天细节曝光#今天上午,湖北省纪委网站发布消息,中国国家男子足球队原主教练李铁涉嫌严重违纪违法,目前正接受国家纪委驻国家体育总局、湖北省监委纪检监察组调查。 参加培训班的时候被带走了。 11月3日,中国足协发布通知,亚足联、中国足协职业教练将接受线下再教育培训。李铁、范志毅、陈阳等。都报名了。其实这是…

    2022年11月26日
    0
  • 从设计师到创业者,中间的差别是什么?

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

    2017年4月17日
    2
  • 揭秘广汽传祺“四大工艺”,品质好车是如何炼成的?

    在日常消费中,品质往往是决定品牌口碑和消费者信赖的关键要素,汽车消费更是如此。作为与人们出行安全息息相关、且单价较高的消费品,汽车的品质是消费者在购车时考虑最多的一个因素,毕竟,一辆安全系数高、耐用抗造的座驾,才能让消费者放心地将自己及家人的出行生活交给它。 身为中国汽车品牌标杆,广汽传祺已经具备了一整套精细、高效、完善的“广汽生产方式”,以高精度自动化的设…

    2023年10月8日
    0
  • 8招教你快速打造作品的『全栈设计感』

    你,也可以成为“UI+交互+用户体验+跨界设计”综合能力的设计师。

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

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

    2017年4月17日
    3
  • 诺基亚近日推出6款新产品,将增强和16家公司合作,VR领域发力明显

    诺基亚的VR重塑自我之路。

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

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

    2017年4月18日
    2
  • 被夸大了的失败经验,无非是变相的成功学

    研究了那么多失败的案例,仍然做不好一家企业

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

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

    2023年3月5日
    0