zoukankan      html  css  js  c++  java
  • PEP8 python 编码规范整理

    决定开始Python之路了,利用业余时间,争取更深入学习Python。编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。

    PEP8 python 编码规范

    一.代码编排

    1.缩进、4个空格的缩进(编辑器都可以完成此功能),不适用Tap,更不能使用Tap和空格。

    2.每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。

    3.类和top-leve函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要在空行。

    二.文档编排

    1.模块内容的顺序:模块说明和docstring-import-globals&constants--其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。

    2.不要在一句import中导入多个库,(比如import os , sys )不推荐。

    3.如果采用from xxxx import xx引用库,可以省略“module.”,都是可能出现命名冲突,这是要采用import xx。

    三.空格的使用

    总体原则,避免不必要的空格。

    1.各种右括号钱不要加空格。

    2.逗号、冒号、分号前不要加空格。

    3.函数左括号钱不要加空格。如func(1)。

    4.序列的左括号钱不要加空格。如list[1]。

    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.类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。

    10. 类的属性有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、excep后跟具体的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的方式

  • 相关阅读:
    ruby 二进制转十进制 Integer("0b101") = 5
    开始菜单和我的文档的我的图片及我的音乐变成 my pictrues 正常图标了
    ruby watir 莫名其妙的错误
    Excel SaveAS是去掉提示框
    apache && jboss安装
    ruby require include的区别
    ruby控制鼠标
    This error is raised because the column 'type' is reserved for storing the class in case of inheritance
    用正则表达式限制文本框只能输入数字,小数点,英文字母,汉字等各类代码
    ASP.NET 如何动态修改 Header 属性如添加 Meta 标签 keywords description!
  • 原文地址:https://www.cnblogs.com/xiaohei001/p/9781011.html
Copyright © 2011-2022 走看看