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://lnxw.aqxyhb.com/126.html

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

相关推荐

  • 中国造世界上最大液化气船:长230米 领先国际先进水平

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

    2023年4月26日
    3130
  • 尼尔森:中国的白酒市场从渠道驱动转型为消费驱动

    随着茅台、五粮液的降价,未来高端白酒价格将进入下行通道,同时白酒行业也将迎来新的变化,白酒行业可能会像乳品、啤酒等行业一样进入整合阶段,受到更多人的追捧。

    2017年4月18日
    2070
  • 全智速剪仪软件揭示故事板设计与取景之间的联系

    故事板设计是一种视觉表现手法,通常在电影、电视和动画等视觉艺术制作过程中用于描述镜头序列。取景则是指在画面中展示拍摄对象的比例和位置,包括远景、全景、中景、近景和特写等。在故事板设计中,取景的选择对画面的构成、视角和情感传达有着重大影响。 以下是故事板设计与取景的具体关系: (1)大特写:故事板的尺寸最适合为6或7框。主要侧重于描绘局部微妙变化,如人物的脸部…

    2024年3月29日
    1450
  • 从设计默认值开始,给用户和产品带来更好的用户体验

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

    2017年4月17日
    1613
  • 多功能合成机软件分享提高视频剪辑节奏感的实用技巧

    初次涉足视频剪辑,我们常常会对剪辑节奏感到困惑。这是一种难以言说,只能通过体验来理解的概念,简单而复杂。有些人能迅速掌握,而有些人可能需要更多的时间去摸索。因为每一个视频的节奏都是独一无二的,每次创作都需要我们重新寻找并适应新的节奏。 首先,我们需要了解,视频中的事件有其主次关系,有因果铺垫,剧情快慢起伏,这些元素的理解有助于我们更好地把握剪辑节奏。 如何掌…

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

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

    2017年4月17日
    1392
  • 清火龙工具——爆款短视频需要的指标

    在数字化时代,短视频已经成为人们获取信息、推广获客的重要方式。每天数亿的用户在各大短视频平台上浏览、点赞、评论和转发。对于内容创作者来说,爆款短视频需要的指标是什么,能吸引更多的用户关注,成为最为重要的问题。接下来展开说说这些方法。 1、完播率 完播率是算法短视频是否受用户喜欢的重要指标之一。它指的是用户观看视频的完整程度,即视频被播放到最后的比例。一个高的…

    2024年4月1日
    770
  • 国内外巨头加码云大战,“小清新”网易也要云上升级

    一直以低调著称的网易也坐不住,要进行云上升级了。

    2017年4月18日
    1981
  • 视图离音仪软件自己剪辑和原创有啥区别?

    如果你是短视频初学者,可能会面临着不知道该创作什么内容的困扰,甚至想要通过复制他人的作品来吸引更多的粉丝。有些人因此获得了众多的关注,而有些人却依然处于停滞不前的状态。复制他人的作品也是需要技巧的,如果你直接下载去水印的视频,那么你可能会面 临被限制播放或者封号的风险。下面我将为你介绍几种能够通过原创方式剪辑短视频的方法。 1. 合拍功能 合拍是抖音平台的一…

    2024年3月29日
    620
  • 河南周口一5岁男孩上菜摔倒后先向爸爸道歉:爸爸,对不起,我把鱼弄洒了

    河南周口一5岁男孩上菜摔倒后先向爸爸道歉:爸爸,对不起,我把鱼弄洒了 #5岁男孩上菜摔倒后先向爸爸道歉#4月20日,据西部决策报道,近日在河南周口,一名5岁男童帮一名顾客端烤鱼,不慎摔倒在地。男孩不顾疼痛向父亲道歉,顾客很热情的拿起烤鱼说还可以吃,也引起了网友的关注。 监控视频显示,一名男生拿着一盆烤鱼正准备端给客人。男孩年纪小,只比桌子高一个头。结果上菜过…

    2023年4月21日
    2890