Python中PEP8风格之带下划线的变量和函数的意义

Python的代码风格一般由PEP8来描述。这个文档描述了Python风格的方方面面，一般开发人员遵循这个规定风格，可以最大限度的保持代码风格的相似性，便于开发人员之间的交流和维护。

在Python中，下划线是比较特殊的字符，含有下划线的也许有合数的意义。现在对根据PEP8规定的风格，来说明带下划线的变量和函数的意义。

• 变量
• 前面带一个_的变量：表明这是一个私有变量，外部类最好不要调用它。这只是一种声明，因为Python中没有所谓的私有变量一说，所以外部类还是可以访问的。
• 前带两个，后带两个的变量：标明是内部变量，外部类访问不了。
• 大写加下划线的变量：标明是不会发生改变的全局变量。
• 函数
• 前带_的函数：声明是私有函数，只是一种声明。
• 前带两个，后带两个的函数：标明是特殊函数。

以上是带下划线的函数和变量的总结。

具体请看下面的例子：

• 变量
• 常量 : 大写加下划线，对于不会发生改变的全局变量，使用大写加下划线。
  USER_CONSTANT
• 私有变量 : 小写和一个前导下划线
  _private_value
  Python 中不存在私有变量一说，若是遇到需要保护的变量，使用小写和一个前导下划线。但这只是程序员之间的一个约定，用于警告说明这是一个私有变量，外部类不要去访问它。但实际上，外部类还是可以访问到这个变量。
• 内置变量 : 小写，两个前导下划线和两个后置下划线
  class
  两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突，用户定义的变量要严格避免这种风格，以免导致混乱。

• 函数和方法：总体而言，函数和方法应该使用，小写和下划线。小写和下划线已成为规范。

• 私有方法 ： 小写和一个前导下划线
  def _secrete(self):
  print "don't test me."
  这里和私有变量一样，并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时，Python 的名称改编特性将发挥作用)。特殊函数后面会提及。

• 特殊方法 ： 小写和两个前导下划线，两个后置下划线：
  def add(self, other):
  return int.add(other)
  这种风格只应用于特殊函数，比如操作符重载等。

• 函数参数 : 小写和下划线，缺省值等号两边无空格
  def connect(self, user=None):
  self._user = user

• 类

  • 类总是使用驼峰格式命名，即所有单词首字母大写其余字母小写。类名应该简明，精确，并足以从中理解该类所完成的工作。常见的一个方法是使用表示其类型或者特性的后缀，例如:
    SQLEngine
    MimeTypes

  • 对于基类而言，可以使用一个 Base 或者 Abstract 前缀：
    BaseCookie
    AbstractGroup

  • 如下类，示例
    class UserProfile(object):
    def init(self, profile):
    return self._profile = profile

        def profile(self):
           return self._profile
    

• 模块和包

  • 除特殊模块 init 之外，模块名称都使用不带下划线的小写字母
    import os
    import sys
  • 若是它们实现一个协议，那么通常使用lib为后缀，例如:
    import smtplib

• 关于参数

• 不要用断言来实现静态类型检测
  断言可以用于检查参数，但不应仅仅是进行静态类型检测。 Python是动态类型语言，静态类型检测违背了其设计思想。断言应该用于避免函数不被毫无意义的调用。

• 不要滥用 *args 和 **kwargs
  *args 和 **kwargs 参数可能会破坏函数的健壮性。它们使签名变得模糊，而且代码常常开始在不应该的地方构建小的参数解析器。

• 其他

• 使用 has 或 is 前缀命名布尔元素
  is_connect = True
  has_member = False

• 用复数形式命名序列
  members = ['user_1', 'user_2']

• 用显式名称命名字典
  person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}

• 避免通用名称
  诸如 list, dict, sequence 或者 element 这样的名称应该避免。

• 避免现有名称
  诸如 os, sys 这种系统已经存在的名称应该避免。

• Python编码风格的一些数字

  • 一行列数 : PEP 8 规定为 79 列，这有些苛刻了。根据自己的情况，比如不要超过满屏时编辑器的显示列数。这样就可以在不动水平游标的情况下，方便的查看代码。
  • 一个函数 : 不要超过 30 行代码, 即可显示在一个屏幕类，可以不使用垂直游标即可看到整个函数。
  • 一个类 : 不要超过 200 行代码，不要有超过 10 个方法。
  • 一个模块 不要超过 500 行。

• 验证脚本
  可以安装一个 pep8 脚本用于验证你的代码风格是否符合 PEP8。

   >>easy_install pep8
  
   >>pep8 -r --ignoire E501 Test.py
  
   #这个命令行的意思是，重复打出错误，并且忽略 501 错误(代码超过 79 行)。