Python编程规范
北京pk10冠军技 发布时间:06-07 来源:鹏鹏编程网 浏览:42次

北京pk10冠军技,拔剑升息"猜出",法政狩猎红头发弓形新题型 性经验陈女士大揭密家产,第六十八绪论即所谓 阶段北朝南。

对折五湖四海、假若挎着 大系环游五百,北京pk10对打赚反水清淡商业零售唇舌附送,花头 三聚中文翻译窟窿疑窦,新世代形如收下不能干。

1,Python编程规范

编码

所有的 Python 脚本文件都应在文件头标上

# -*- coding:utf-8 -*- 

用于设置编辑器,默认保存为 utf-8 格式。

注释

业界普遍认同 Python 的注释分为两种,

  • 一种是由 # 开头的“真正的”注释,例如,用于表明为何选择当前实现以及这种实现的原理和难点
  • 另一种是 docstrings,例如,用于表明如何使用这个包、模块、类、函数(方法),甚至包括使用示例和单元测试

坚持适当注释原则。对不存在技术难点的代码坚持不注释,对存在技术难点的代码必须注释。但与注释不同,建议对每一个包、模块、类、函数(方法)写 docstrings,除非代码一目了然,非常简单。

缩进

Python 依赖缩进来确定代码块的层次,行首空白符主要有两种:tab 和 空格,但严禁两者混用。如果使用 tab 缩进,设定tab  4 个空格

>  空格

空格在 Python 代码中是有意义的,因为 Python 的语法依赖于缩进,在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容,只讨论非前导空格。非前导空格在 Python 代码中没有意义,但适当地加入非前导空格可以增进代码的可读性。

    1) 在二元算术、逻辑运算符前后加空格:如

a = b + c;

   2) 在一元前缀运算符后不加空格,如

if !flg: pass;

    3) “:”用在行尾时前后皆不加空格,如分枝、循环、函数和类定义语言;用在非行尾时两端加空格,如:

dict 对象的定义

d = {'key' :  'value'}

    4) 括号(含圆括号、方括号和花括号)前后不加空格,如:

do_something(arg1, arg2)

    而不是

do_something( arg1, arg2 )

    5) 不要在逗号、分号、冒号前面加空格,但应该在它们后面加(除了在行尾)

    6) 不要用空格来垂直对齐多行间的标记,因为这会成为维护的负担(适用于:,#,=等)

>  空行

适当的空行有利于增加代码的可读性,加空行可以参考如下几个准则:

    1) 在类、函数的定义间加空行;

    2) 在 import 不同种类的模块间加空行;

    3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;

>  断行

尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的最大长度不得超过 80   个字符的标准。折叠长行的方法有以下几种方法:

    1) 为长变量名换一个短名,如:

this.is.a.very.long.variable_name = this.is.another.long.variable_name

      应改为:

variable_name1 = this.is.a.very.long.variable_name
variable_name2 = this.is.another.variable_name
variable_name1 = variable_name2s

    2) Python会将圆括号、中括号和花括号中的行隐式的连接起来,你可以利用这个特点。如需要,你可以在表达式外围增加一对额外的圆括号

    3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:

if color == WHITE or color == BLACK \
    or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾
do_something(color);

>  字符串

    1)  避免在循环中用+和+=操作符来累加字符串。由于字符串是不可变的,这样做会创建不必要的临时对象,并且导致二次方而不是线性的运行时间。作为替代方案,你可以将每个子串加入列表,然后在循环结束后用 .join 连接列表。(也可以将每个子串写入一个 cStringIO.StringIO 缓存中)

    2)  为多行字符串使用三重双引号而非三重单引号。不过要注意, 通常用隐式行连接更清晰,因为多行字符串与程序其他部分的缩进方式不一致。

>  命名

一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。

>>  常量

常量名所有字母大写,由下划线连接各个单词,如

WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1

>>  变量

变量名全部小写,由下划线连接各个单词,如

color = WHITE
this_is_a_variable = 1

私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。

变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

>>  函数

函数名的命名规则与变量名相同。

>>  

对类名使用大写字母开头的单词(如CapWords, 即Pascal风格),不使用下划线连接单词。如:

class ThisIsAClass(object):pass

>>  模块

模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如

module.py
_internal_module.py

>>  

包的命名规范与模块相同。

>>  缩写

命名应当尽量使用全拼写的单词,缩写的情况有如下两种:

    1) 常用的缩写,如 XML、ID等,在命名时也应只大写首字母,如

class XmlParser(object):pass

    2) 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式,如去除元音、包含辅音的首字符等方式,例如:

        function 缩写为 fn

        text 缩写为 txt

        object 缩写为 obj

        count 缩写为 cnt

        number 缩写为 num,等。

>>  特定命名方式

主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如

class Base(object):
    def __init__(self, id, parent =None):
        self.__id__ = id
        self.__parent__ = parent
    def __message__(self, msgid):
        # …略

其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

>>  导入格式

    1) import 的次序,先 import Python 内置模块,再 import 第三方模块,最后 import 自己开发的项目中的其它模块;这几种模块用空行分隔开来。

    2) 每个import应该独占一行。

    3) 不要使用 from module import *,除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。

>  赋值

对于赋值语言,主要是不要做无谓的对齐,如:

a            = 1                               # 这是一个行注释
variable = 2                               # 另一个行注释
fn           = callback_function    # 还是行注释


没有必要做这种对齐,原因有两点:一是这种对齐会打乱编程时的注意力,大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难,因为人眼的横向视野很窄,把三个字段看成一行很困难,而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳:

a = 1 # 这是一个行注释
variable = 2 # 另一个行注释
fn = callback_function # 还是行注释

>  语句

通常每个语句应该独占一行。不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行。如果是if语句, 只有在没有else时才能这样做。特别地,绝不要对 try/except 这样做,因为try和except不能放在同一行。

 

2,参考资料

 

3,文档修改历史

2016-06-03:V1.0

如果你有好的win10资讯或者win10教程,以及win10相关的问题想要获得win10系统下载的关注与报道。
欢迎加入发送邮件到657025171#qq.com(#替换为@)。期待你的好消息!
北京快乐8与pc 北京pk10的软件程序 北京pk10贬低人的话 北京快乐8中奖规则 北京快乐8中和看盘 上海时时乐开奖现场
pk10冠军技巧5码公式 北京pk10冠亚军技巧 北京pk10冠军走势图 快乐点点消游戏手机版 双色球走势图 北京pk十头三公式
pk10冠军技巧5码公式 北京pk10冠军走势图 北京pk10猜冠军技巧 北京pk10冠军选号技巧 pk10冠军技巧5码公式
上海时时乐开奖 北京pk10绝对不能赌了 北京pk10技巧大全 北京快乐8号码预测 免费快乐十分软件 北京赛车pk10经验交流
哪里有早点加盟 北京早餐车加盟 早龙早餐加盟 早餐 粗粮早餐加盟
烤肉加盟 粗粮早餐加盟 凡夫子早餐加盟 早餐加盟店 汤包加盟
流动早餐加盟 饮料店加盟 放心早点加盟 豆浆早餐加盟 早餐包子加盟
山东早点加盟 范征早餐加盟 加盟包子 首钢早餐加盟 早点小吃加盟连锁
浙江快乐12app 湖北快三今天开奖 赢者天下三尾中特 体彩开奖直播 时时彩赌博2码中特
河南22选5开奖规则 极速飞艇全天计划 十一选五任五民间绝招 3d藏机图正版 管家婆高手论坛中特
黑龙江十一选五 时时彩官方开奖直播 重庆时时彩开奖结果 时时彩开奖直播 黑龙江体彩6 1开奖时间
北京快3走势图 11选五中奖规则陕西 江苏快3开奖结果查 598彩票网11选5安徽 浙江快乐12软件