python命名规范-google-styleguid

google-styleguid

命名

Tip
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

应该避免的名称

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

命名约定

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

Python之父Guido推荐的规范

Main

Tip
即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.
在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 if name == ‘main’ , 这样当模块被导入时主程序就

def main():      ...if __name__ == '__main__':    main()

顶级代块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.

https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

---

python命名规范

1、包名、模块名，小写；多个单词时，下划线分割

login.pyuser_login.py

2、类名，首字母大写，多个单词时，用驼峰

class Login:class UserLogin:

3、方法名，小写，多个单词时，下划线分割

def login:def user_login:

4、变量名，小写，多个单词时，下划线分割

user = user

5、常量名，大写，多个单词时，下划线分割

MAX_OVERFLOW

6、参数名，全小写

def login(self, user, password):