1.python的一些规范

Python的一些规范

1.标识符

• 定义：允许作为名字的有效字符串集合
• 名字必须有实际意义，可读性好
• 首字母必须是字母或下划线(_)
• 剩下的字符可以是字母和数字或者下划线
• 大小写敏感
• 两种风格：conn_obj或ConnObj
• 不能使用关键字，不能使用内建

2.专用下划线标识符

• _xxx:不能用from module import *导入

• xxx:系统定义名字

• __xxx:类中私有变量

• 下划线对于解释器来说有特殊意义，而且是内建标识符所使用符号，不建议自定义变量以下划线开头

• 但是如果是类中的私有变量，__xxx将会是一个好习惯

• 补充：

    系统变量__name__会根据python文件被加载方式的不同得出不同的值
    python文件被当作模块导入：__name__=模块名或者文件名
    python文件被执行:__name__='__main__'
    在我们使用python编写一个软件时，应该只有一个主程序中包含大量顶级代码（就是没有缩进的代码，
    python解释器读取到顶级代码会立即执行），其他.py文件应该只有少量顶级代码，所有功能都应该封装在函数或类中
    通常在文件结尾结合__name__变量，编写测试代码 
  

3.编写模块基本风格

1. 标题
2. 文档注释
3. 模块导入
4. 变量定义
5. 类定义语句
6. 函数定义语句
7. 主程序

4. 测试代码

#_*_coding:utf-8_*_
#!/usr/bin/env python

'''
This is an example module
'''

import sys,os

debug=True

class Test:
    '''
    test class
    '''
    pass

def main():
    '''
    test func
    :return: 
    '''
    pass

if __name__ == '__main__':
    main()