Python基础 I-01 编程规范

编程规范

一、参考

转载【PEP8编程规范中文版】

二、规范

此时你已经可以写一些更长更复杂的 Python 程序，是时候讨论一下 编码风格 了。大多数语言可以写（或者更明白的说， 格式化 ）作几种不同的风格。有些比其它的更好读。让你的代码对别人更易读是个好想法，养成良好的编码风格对此很有帮助。

对于 Python，PEP 8 引入了大多数项目遵循的风格指导。它给出了一个高度可读，视觉友好的编码风格。每个 Python 开发者都应该读一下，大多数要点都会对你有帮助：

2.1、Python命名规范

规范	说明	备注
module_name	模块
package_name	包
ClassName	类	总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。
method_name	方法	小写+下划线 注意：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容。
ExceptionName	异常
function_name	函数	小写+下划线 注意：混合大小写仅被允许用于这种风格已经占据优势的时候，以便保持向后兼容。
GLOBAL_VAR_NAME	全局变量	对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线。
注意:应避免使用全局变量
instance_var_name	实例
function_parameter_name	参数	如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线
local_var_name	本变量

2.2、特别说明

变量

小写，由下划线连接各个单词。如color = WHITE，this_is_a_variable = 1
注意：
1.不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识。
3.变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量

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

异常

以“Error”作为后缀。

文件名

全小写,可使用下划线

包

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。

模块

与包的规范同。如mymodule。

缩写

命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1.常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2.命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如：
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num，等。
前导后缀下划线
一个前导下划线：表示非公有。
一个后缀下划线：避免关键字冲突。
两个前导下划线：当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。
注意：关于下划线的使用存在一些争议。

特定命名方式

主要是指 xxx 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如
class Base(object):
def init(self, id, parent = None):
self.id = id
self.parent = parent
def message(self, msgid):
其中 id、parent 和 message 都采用了系统保留字命名法。

二、2.2、其他规范

• 使用 4 空格缩进，而非 TAB
  在小缩进（可以嵌套更深）和大缩进（更易读）之间，4空格是一个很好的折中。TAB 引发了一些混乱，最好弃用
• 折行以确保其不会超过 79 个字符
  这有助于小显示器用户阅读，也可以让大显示器能并排显示几个代码文件
• 使用空行分隔函数和类，以及函数中的大块代码
• 可能的话，注释独占一行
• 使用文档字符串
• 把空格放到操作符两边，以及逗号后面，但是括号里侧不加空格：a = f(1, 2) + g(3, 4)
• 统一函数和类命名
  推荐类名用 驼峰命名， 函数和方法名用 小写_和_下划线。总是用 self 作为方法的第一个参数（关于类和方法的知识详见 初识类 ）
• 不要使用花哨的编码，如果你的代码的目的是要在国际化环境。Python 的默认情况下，UTF-8，甚至普通的 ASCII 总是工作的最好
• 同样，也不要使用非 ASCII 字符的标识符，除非是不同语种的会阅读或者维护代码。