python编码规范_v1.0.docx

Python编码规范编码所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 。设置编辑器，默认保存为 utf-8 格式。注释坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数（方法）写 docstrings，除非代码一目了然，非常简单。缩进代码缩进使用4个空格。行首空白符主要有两种：tab 和空格，但严禁两者混用。如果使用 tab 缩进，设定 tab 为 4 个空格。命名规则1）命名格式module_name,package_name,ClassName,method_name,ExceptionName, function_name,GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name.TypePublicInternalPackageslower_with_underModuleslower_with_under_lower_with_underClassesCapWords_CapWordsExceptionsCapWordsFunctionslower_with_under()_lower_with_under()Global/Class ConstantsCAPS_WITH_UNDER_CAPS_WITH_UNDERGlobal/Class Variableslower_with_under_lower_with_underInstance Variableslower_with_under_lower_with_under (protected)or __lower_with_under (private)Method Nameslower_with_under()_lower_with_under()(protected)or__lower_with_under() (private)Function/Method Parameterslower_with_underLocal Variableslower_with_under2）用 has 或 is 前缀命名布尔元素is_connect?=?Truehas_member?=?False3）用复数形式命名序列members?=?[user_1,?user_2]4）用显式名称命名字典person_address?=?{user_1:10?road?WD,?user_2?:?20?street?huafu}5）避免通用名称诸如 list, dict, sequence 或者 element 这样的名称应该避免。6）避免现有名称诸如 os, sys 这种系统已经存在的名称应该避免。空行?适当的空行有利于增加代码的可读性，加空行可以参考如下几个准则：1）?在类、函数的定义间加空行；2）?在 import 不同种类的模块间加工行；3）?在函数中的逻辑段落间加空行，即把相关的代码紧凑写在一起，作为一个逻辑段落，段落间以空行分隔；分号不要在行尾使用分号行的长度行的最大长度最好不超过80个字符。不要超过满屏时编辑器的显示字符数。不要使用反斜杠（\）分隔行，建议在括号（包括圆括号-()、方括号-[]、大括号-{}）中换行。Yes: foo_bar(self, width, height, color=black, design=None, x=foo, emphasis=None, highlight=0) if (width == 0 and height == 0 and color == red and emphasis == strong):对于需要断行的字符串，可以在括号中进行分割，编译时python会自动对字符串进行连接Yes:x = (This will build a very long long long long long long long long string)函数的长度不要超过?30 行代码, 即可显示在一个屏幕类，可以不使用垂直游标即可看到整个函数类的长度不要超过200行代码，不要有超过10个方法模块的长度不要超过500行括号有节制地使用括号，不要给条件语句、return语句加括号Yes: if foo:bar() while x:x = bar() if x and y:bar() if not x:bar() return foo for (x, y) in dict.items(): ...N