原标题:python编程规范你必须要弄懂
大家今晚利用1个小时看python基础视频教程 28-31节 ,自己监督自己。跟着学习哈!一定要做到!
1.Python编程规范
>编码
所有的 Python 脚本文件都应在文件头标上
# -*- coding:utf-8 -*-
用于设置编辑器,默认保存为 utf-8 格式。
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) 为长变量名换一个短名,如:
this. is.a.very.long.variable_name = this. is.another.long.variable_name
应改为:
variable_name1 = this. is.a.very.long.variable_namevariable_name2 = this. is.another.variable_namevariable_name1 = variable_name2s
2) Python会将圆括号、中括号和花括号中的行隐式的连接起来,你可以利用这个特点。如需要,你可以在表达式外围增加一对额外的圆括号
3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:
ifcolor == WHITE orcolor == BLACK orcolor == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾do_something(color);
私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
>>函数
函数名的命名规则与变量名相同。
>>类
对类名使用大写字母开头的单词(如CapWords, 即Pascal风格),不使用下划线连接单词。如:
classThisIsAClass(object):pass
>>模块
模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如
module.py_internal_module.py
>>包
包的命名规范与模块相同。
>>缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
1) 常用的缩写,如 XML、ID等,在命名时也应只大写首字母,如
classXmlParser(object):pass
2) 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式,如去除元音、包含辅音的首字符等方式,例如:
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。
>赋值
对于赋值语言,主要是不要做无谓的对齐,如:
a = 1# 这是一个行注释variable = 2# 另一个行注释fn = callback_function # 还是行注释没有必要做这种对齐,原因有两点:一是这种对齐会打乱编程时的注意力,大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难,因为人眼的横向视野很窄,把三个字段看成一行很困难,而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳:
a = 1# 这是一个行注释variable = 2# 另一个行注释fn = callback_function # 还是行注释
>语句
通常每个语句应该独占一行。不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行。如果是if语句, 只有在没有else时才能这样做。特别地,绝不要对 try/except 这样做,因为try和except不能放在同一行。
在我写代码的过程中我一直密切的在关注着编程规范 ,良好的编程习惯能够让你快速的走上编程道路,而且不用走弯路。返回搜狐,查看更多
责任编辑: