Python日常开发编码规范

命名规范

(1)应该避免的名称

  • 单字符名称, 除了计数器和迭代器
  • 包/模块名中的连字符(-
  • 双下划线开头并结尾的名称(Python保留,例如__init__

(2)命名约定

  • 所谓“内部(Internal)”表示仅模块内可用,或者在类内是保护或私有的
  • 用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含)
  • 用双下划线(__)开头的实例变量或方法表示类内私有
  • 将相关的类和顶级函数放在同一个模块里。不像Java,没必要限制一个类一个模块
  • 对类名使用大写字母开头的单词(如CapWords, 即Pascal风格),但是模块名应该用小写加下划线的方式(如lower_with_under.py)。尽管已经有很多现存的模块使用类似于CapWords.py这样的命名,但现在已经不鼓励这样做,因为如果模块名碰巧和类名一致,这会让人困扰

(3)Python之父Guido推荐的规范

其他规范

未完待续