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

本文发布者:dennyyang,转载请注明出处:https://www.kongyoo.com/internet/126.html

(13)
上一页 2017年4月17日 下午5:21
下一页 2017年4月17日 下午10:54

相关推荐

  • TikTok 有救了!原来出路在小红书……

    在当今数字化时代,社交媒体平台的兴衰更迭如同潮起潮落,难以预料。近期,TikTok 这颗曾经闪耀的社交新星,因面临禁令危机而陷入风雨飘摇之中,其庞大的用户群体也由此踏上寻找新 “家” 的征程。而在这场用户大迁徙中,一款来自中国的 APP —— 小红书,意外地成为了众多美国用户的首选,其背后的故事引人深思,也让我们看到了机遇与挑战并存的复杂局面。 TikTok…

    2025年1月23日
    46700
  • 联合国警告:全球贸易明年或将面临这5大风险

    联合国最新发布的报告预测,今年全球贸易额将增长3.3%,达到创纪录的33万亿美元,但同时也警示明年将面临包括贸易战升温与美国政策转变在内的五大风险。联合国贸易暨发展会议(UNCTAD)在日前发布的《全球贸易更新》报告中指出,这一增长主要得益于全球货物和服务贸易总额的预估增加,预计今年将比去年多出1万亿美元,达到33万亿美元的新高,其中服务贸易预计增长7%,货…

    2024年12月11日
    30500
  • 刚刚!TikTok 恢复在美服务,被困 12 小时后重获新生

    根据外媒消息,当地时间 1 月 19 日,在美国关闭约 12 小时后,TikTok 对许多用户来说又重新回归,就像它从未离开过一样,这归功于当选总统的唐纳德·特朗普为拯救该应用而采取的举措。 TikTok 于上周当地时间周六间在美国无法使用,随后美国政府采取紧急措施恢复该应用。当时,试图打开该应用的用户收到一条消息,称该应用已下线,并要求用户“保持关注”。 …

    2025年1月20日
    42800
  • 第一次负责从0到1的产品时要注意哪几点?

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

    2017年4月25日
    8.5K66
  • 对话交个朋友“操盘手”李牧人:罗永浩不可复制,但其他人可以

    决定加入交个朋友做电商学苑,李牧人只思考了一个下午的时间。 2021年底,交个朋友控股CEO李亮带着同样来自新东方的李牧人来到杭州。关于做电商培训的可能性,他们和罗永浩、现任交个朋友控股董事长的李钧聊了一下午。几个人聊得很兴奋,觉得这个市场规模很大、增量也在,而新东方出身的人也有一定的经验优势。很快,交个朋友电商学苑快速筹备了第一期课程,罗永浩亲自上阵。9个…

    2025年1月10日
    25900

联系我们

在线咨询: QQ交谈

邮件:5877546@qq.com

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

关注微信