Python编码规范.ppt

Python编码规范;目录;一 文件头;二 注释;注释范例说明： #!/usr/bin/env python # 在文件头第一行设置 Python 解释器 # -*- encoding: utf-8 -*- # 第二行：设置文件编码 # Copyright (c) 2011 - xcluo xcluo@ # 第三行：版权信息放在文件头部,文件编码之后 # 第四行：模块的 docsting 放在文件头部,版权信息之后 ”””这个如何写只有一行内容的docstrings的范例.””” ”””这个如何写有多行内容的docstrings的范例: After title is the content.You can write it as long as needed. ...... ””” ;使用docstrings的说明： 用英语撰写注释,短注释可以忽略末尾的句号 (.) docstrings 为每个模块、类或函数撰写 docstrings 推荐使用三个双引号 (”””) 来定义 docstrings 不推荐使用三个单引号 () 模块的 docsting 放在文件头部,版权信息之后 ;# 第五行： import 语句 import os import time from pyssh import getsshcmd, getcmd 说明： import 语句在模块 docstring 之后,在模块全局变量或全局常量之前 按照从一般到特殊的原则分组 import 语句,先 import 标准库,然后 import 第三方库,最后 import 程序中的自定义库 在不同分组的 import 语句之间加空行 每个 import 语句只导入一个模块 ;注释的细节：类的注释;注释的细节：函数(方法)的注释;注释的细节：代码行注释;注释的细节：语句的注释;三 编码的规范;编码1：折行/断行;需要说明的是： 长行断行， 要选择在运算符的前面 if color == WHITE or color == BLACK or \ color == BLUE: 这样的写法，不利于维护人员快速理解问题 其次断行后， 需要空一个空位 if color == WHITE or color == BLACK or \ color == BLUE: 这样的写法，也是不合规的;编码2：空行;范例1： def index(request): return render_to_response(index.html) def note(request): return render_to_response(note.html) - 很明显，这就是一个没有合理空行的代码。对于函数与函数定义之间，加上必要的空行是必须的，但是也不要加多了 - 一下空了7，8行就不好喽！;范例2： import os import sys import apppyindex.views import apppyindex.models - 这样的写法也是不规范的， 在同类型的模型导入之间，需要一定的空行； - 当然， 也不要写太多空行，一般一行就可以了； - 不知道大家还记得模型导入的顺序？;编码3：空格;范例及说明： 在二元算术、逻辑运算符前后加空格，如： a = b + c “:”用在行尾时前后皆不加空格，如分枝、循环、函数和类定义语言； 用在非行尾时两端加空格，如 dict 对象的定义： d = {key : value} 括号（含圆括号、方括号和花括号）前后不加空格，如： func(arg1, arg2) 不要是这样： func( arg1, arg2) 逗号后面加一个空格，前面不加空格；;IV 命名;命名1 常量;命名2 变量;命名3 函数;命名4 类;命名5 模块;命名6 包;命名7 缩写;V 语句;VI 赋值;VII 判断和循环;条件表达式的编写应该足够 pythonic，如以下形式的条件表达式是拙劣的： if len(alist) != 0: do_something() if alist != []: do_something() if s != : do_something() if var != None: do_something() if var != False: do_something() 上面的语句应该写成： if seq: