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.jiancaiye.com/index.php/2017/04/17/pep8-python-%e7%bc%96%e7%a0%81%e8%a7%84%e8%8c%83%e6%95%b4%e7%90%86/

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

相关推荐

  • 干货,产品经理如何进行需求分析

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

    2017年4月17日
    1.1K02
  • 广发期货:钢材需求存韧性,铁水高位!

    【现货和基差】 唐山钢坯维稳至3570元每吨。华东螺纹+20至3860元每吨,10月和1月基差分别为97和29元每吨。热卷+40至3930元每吨,热卷10月和1月合约基差分别为-47和-3元每吨。【利润】 现货利润稳中有跌,昨日焦炭提涨100元,高炉利润再次收缩。螺纹长流程利润-39元每吨,电炉利润-144元每吨。热轧利润下降,接近成本线。【供给】 铁水产量…

    2023年9月20日
    36800
  • 奋楫笃行二十载,踵事增华正当时

    奋楫笃行二十载,踵事增华正当时

    碧水源创办于2001年,是中关村国家自主创新示范区高新技术企业,于2010年在深交所创业板上市,成为创业板上市公司龙头股之一。作为世界一流的膜技术企业之一,碧水源坚定科技创新和高质量发展两条主线,以自主研发的膜技术解决中国“水脏、水少、饮水不安全”三大问题,持续为城乡生态环境建设提供整体解决方案。现已发展为中国环保行业、水务行业标杆企业、全球领先的膜装备生产制造商和供应商之一,位列“全球水务50强”第36名。

    截止目前,碧水源两次获得国家科学技术进步奖二等奖,一次获得教育部科学技术进步奖一等奖,净水产品为中国航天、APEC峰会、“一带 一路”国际高峰论坛提供健康直饮水服务。

    品牌严选丨三大净水器品牌推荐,共创健康水源新商机!_1

    三驾马车并驾齐驱,科技新品闪耀江湖

    水质净化是一个利国利民、大势所趋的事,水污染的不断加剧、人们健康意识的不断提高必然加速净水器的普及,最终成为家家户户的必需品。碧水源拥有三大净水产品,分别是家用净水、商用净水、户外净水,搭载碧水源核心纳滤技术,既能去除水中细菌、病毒、有机污染物及重金属等有害物质,又保留了人体需要的钾、钠、钙、镁等矿物元素,以此全面覆盖生活中的用水场景,实现全方位净水健康。

    品牌严选丨三大净水器品牌推荐,共创健康水源新商机!_2

    「水质净化革命」进行时:碧水源再出大招!推出装配式水厂——“水膜方”!集约化、标准化、模块化是“水膜方”的三大突破:更高、更快、更强是“水膜方”的三大特点,市政、工业、医疗是“水膜方”的三大应用场景,相较于同类型产品在经济效益、科学技术、社会效益等方面都有显著的突破升级,是一款打开装配式水厂市场的新产品,将在污水治理高质量发展中发挥重要作用,实现经济与环境效益的最大化,为生态文明建设保驾护航!

    品牌严选丨三大净水器品牌推荐,共创健康水源新商机!_3

    承担社会责任,打开国际市场

    实力愈胜,责任更大。碧水源先后参与了长江流域、黄河流域、南水北调丹江口水源地等多个水环境敏感地区的治理;碧水源MBR膜占中国膜法水处理市场份额的70%以上,日水处理总规模超过2000万吨,每年可为国家新增高品质再生水超70亿吨。今年7、8月份,碧水源成功进军中东欧和非洲市场,将中国技术带出国门,是我国自主化产品输出海外市场的优异成果。未来,碧水源将秉承“承担社会责任,建设生态文明”的企业宗旨,通过强化战略引领、创新驱动,为治理水环境、开发新水源、保障饮水安全以及城乡生态环境建设作出积极贡献,不断开拓新领域新赛道,在全球视野中彰显中国企业的巨大创新力量。

    2023年9月1日
    15700
  • 亚马逊产品负责人详解产品优化:流程零阻力策略

    你需要打磨出最佳的用户体验路径。永远留意那些会造成阻力的流程和功能——那些不好的产品总是忽略了这些。这很费力但是值得。并且这个过程并不如你想象的那么难。有时候,阻碍用户和你产品之间的可能只是两颗电池。

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

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

    2017年4月17日
    1.6K00

发表回复

登录后才能评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

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

关注微信
建材业-建材人的生意圈