Python代码规范和命名规范

Python代码规范和命名规范

zoerywzhou@163.com

http://www.cnblogs.com/swje/

作者：Zhouwan

 2018-4-1

Python之父Guido推荐命名规范包括如下几点：

1.文件名、模块名和包名采用小写字母并且以下划线分隔单词的形式；

　　如:regex_syntax,py_compile,_winreg

2.类名或异常名采用每个单词首字母大写的方式

　　 如：BaseServer,ForkingMixIn,KeyboardInterrupt

• 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

3.全局或者类常量，全部使用大写字母，并且以下划线分隔单词；

　　 如：MAX_LOAD

4.其余变量命名包括方法名，函数名，普通变量名则是采用全部小写字母，并且以下划线分隔单词的形式命名。

　　如：my_thread

• 私有函数在函数前加一个下划线_

5.以上的内容如果是内部的，则使用下划线开头命名。

　　如：__init__,__new__ 参考：

 

1、编码

• 如无特殊情况, 文件一律使用 UTF-8 编码
• 如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识

2、引号

简单说，自然语言使用双引号，机器标示使用单引号，因此 代码里 多数应该使用 单引号

• 自然语言 使用双引号 "..."
  例如错误信息；很多情况还是 unicode，使用u"你好世界"
• 机器标识 使用单引号 '...'
  例如 dict 里的 key
• 正则表达式 使用原生的双引号 r"..."
• 文档字符串 (docstring) 使用三个双引号 """......"""

3、空行

• 模块级函数和类定义之间空两行；
• 类成员函数之间空一行；

class A:

    def __init__(self):
        pass

    def hello(self):
        pass

def main():
    pass

• 可以使用多个空行分隔多组相关的函数
• 函数中可以使用空行分隔出逻辑相关的代码

其他代码规范详见https://blog.csdn.net/warm77/article/details/78353632

 

参考：https://blog.csdn.net/it_dream_er/article/details/51999302