快速上手python命名规范

写在前面

给python的模块、函数和变量等起名是一件令人烦恼的事情,尤其是在不知道规范的情况下会造成更多的困扰。那么如何命名才算规范呢?给出了详细的解答,下面结合常用的一些方面带来一个快速上手式的解读。

命名方式

即命名的可能组合方式

常见的命名方式

名称介绍示例
小写 全部字母小写,单词间加下划线 lower_case_with_underscores
大写 全部字母大写,单词间加下划线 UPPER_CASE_WITH_UNDERSCORES
驼峰命名法 注意:在CapWords中使用首字母缩写词时,缩写词的所有字母大写,例如HTTPServerError比HttpServerError好 CamelCase
mixedCase 与驼峰命名法的区别就是首字母小写 mixedCase

另外还有一些比如末尾加一个下划线避免与关键字冲突 ,前面加一个下划线表私有类型,还有前后都加两个下划线如__init___等,在这里就不展开介绍了。

Python3命名规范

一般要点

  • 避免过于笼统或过于冗余,两者之间做好平衡
    反例:data_structure,my_list,info_map,dictionary_for_the_purpose_of_storing_data_representing_word_definitions
    正例:好:user_profile,menu_options,word_definitions
  • 避免使用小写"l",大写"O", 大写"I"

常用命名规范

名称命名方式示例备注
包(Packages) 或模块(modules) 小写 actor_critic.py  
类(Classes) 驼峰命名法 class MyDog: 对于类的示例则用小写,如dog =MyDog(‘willie’, 6)
常量(Constants) 大写 MAX_OVERFLOW  
函数和普通变量名 小写 arr,bubble_sort()  

Refs

原文地址:https://www.cnblogs.com/hzcya1995/p/13281741.html