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

相关推荐

  • 我真不是神医完整版64集最后一集

    我真不是神医完整版64集最后一集 《我真不是神医》的剧情概要揭示了一个关于误会、成长和责任的故事。以下是对剧情的详细解读: 加微信9.9元观看全集 初露锋芒:李不凡原本是一个普通的青年,但一次偶然的机会,他因为好心帮助他人而被误认为是神医。这个误会让他开始反思自己的生活态度和价值观。他意识到,虽然自己并不是真正的医生,但他可以利用这个机会去帮助更多的人。 挑…

    2024年10月16日
    0
  • 萌兔智剪器软件新手如何掌握跳跃剪辑的技巧

    跳跃剪辑是剪辑艺术中的一种方法,它以其独特的方式打破了影视作品中时间和空间的连续性,为电影、电视节目、广告以及其他媒体制作中的叙述提供了新的视角。这种技术最早被视为一种违反传统剪辑原则的错误方法,直到法国新浪潮时期,它被正式认可为一种创新的编辑技术并广泛应用于各种影视制作中。 本质上,跳跃剪辑通过剪除时间线上的某些部分,跳过一些动作或场景,以便在不影响观众理…

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

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

    2017年4月21日
    1
  • 萌兔智剪器软件视频剪辑的人物开场怎样合理安排?

    在制作影视作品中,如何妥善地安排角色的首次亮相是至关重要的。这主要通过描绘主人公的日常生活、背景和性格等因素,为故事拉开序幕。这种开场方式有助于观众迅速理解并记住主角,并为整个影视剧的发展设定基调。 首先,我们需要确定谁是关键角色。一部影视作品中最重要的角色通常有两个,即主角和反派。从戏份来看,主角的戏份自然会比反派多一些,所以通常情况下,主角的开场设计会比…

    2024年3月28日
    0
  • 全智速剪仪软件影视剪辑中的动态轴线和静态轴线

    轴线在视频制作中的应用可以被归纳为以下三类: 一、运动轴线 或称为动态轴线,它描绘了拍摄对象的运动路径或方向。在视频剪辑和动画制作中,用以描述物体在场景中移动的方式。 遵循运动轴线的原则,若要保持屏幕上运动主体方向的整体连贯性(包括同向、异向),那么各个镜头的拍摄总方向应保持在这条轴线的同侧。 运动轴线只是一个虚设的线,其形态可以是直线,也可以是曲线。根据运…

    2024年3月28日
    0
  • 被夸大了的失败经验,无非是变相的成功学

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

    2017年4月17日
    3
  • 一次看完大结局《我真不是神医》全剧大结局1-125集全剧合集免费

    一次看完大结局《我真不是神医》全剧大结局1-125集全剧合集免费 《我真不是神医》的剧情概要揭示了一个关于误会、成长和责任的故事。以下是对剧情的详细解读: 加微信9.9元观看全集 初露锋芒:李不凡原本是一个普通的青年,但一次偶然的机会,他因为好心帮助他人而被误认为是神医。这个误会让他开始反思自己的生活态度和价值观。他意识到,虽然自己并不是真正的医生,但他可以…

    2024年10月16日
    0
  • 从设计师到创业者,中间的差别是什么?

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

    2017年4月17日
    2
  • 萌兔智剪器软件掌握视频编辑的七个关键步骤

    视频编辑入门基础: 随着移动互联网的快速发展,新媒体平台如微信公众号、微博、抖音等迅速崛起,企业纷纷借助这些平台进行营销。自2017年以来,短视频平台的流量激增,不仅孕育了众多网红公司,也使得明星和普通人通过直播销售商品成为可能,从而推动了对新媒体视频编辑人才的需求。 视频编辑的七个必学技能: 1.启动项目并导入素材 启动一个新的编辑项目是编辑工作的第一步。…

    2024年4月1日
    0
  • 视图离音仪软件对于探索非传统编辑思维的全面理解

    非传统编辑思维是一种不受常规时间和空间观念以及其他线性规则限制的编辑方式。它强调在编辑过程中,灵活运用各种素材,创造出独特的叙述结构、视觉效果和情感表达。 非传统编辑思维包括两个主要部分:一、突破线性的时空关系,对故事进行新的拆解和组合;二、将编辑的依据从简单的因果逻辑关系延伸到人物的情绪和心理变化。由于经过重新组合后的故事线索呈现片段式的连接,多个线索同时…

    2024年4月1日
    0