python—命名规范

文件名
全小写,可使用下划线


应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。

模块
与包的规范同。如mymodule。


总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。

函数&方法
函数名应该为小写,可以用下划线风格单词以增加可读性。如:myfunction,my_example_function。
*注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容。

函数和方法的参数
总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。

全局变量
对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。
*注意*:应避免使用全局变量

变量
变量名全部小写,由下划线连接各个单词。如color = WHITE,this_is_a_variable = 1
*注意*:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

常量
常量名所有字母大写,由下划线连接各个单词如MAX_OVERFLOW,TOTAL。

异常
以“Error”作为后缀。

缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如:
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。
前导后缀下划线
一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:“魔”(有特殊用图)对象或者属性,例如__init__或者__file__。绝对不要创造这样的名字,而只是使用它们。
*注意*:关于下划线的使用存在一些争议。

特定命名方式
主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。
附:Google Python命名规范
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

原文地址:https://www.cnblogs.com/bianzhiwei/p/10112557.html

时间: 2024-08-03 17:09:17

python—命名规范的相关文章

Google Python 命名规范

Google Python命名规范 module_name,  模块 package_name,  包 ClassName,  类 method_name,  方法 ExceptionName,   异常 function_name,  函数 GLOBAL_VAR_NAME, 全局变量 instance_var_name,  实例变量 function_parameter_name,   参数 local_var_name.  局部变量:在方法体中声明的变量   类 总是使用首字母大写单词串.如

python 命名规范

参考Google开源项目风格指南:https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/ 转载一下其中的命名规范: 命名 module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_pa

python命名规范

1. 模块名:  通常是小写字母,单词之间用_分割:  ad_stats.py  2. 包名: 和模块名一样 3. 类名: 类名都使用单词首字母大写开头(Pascal命名风格)的规范.举例:AdStats , ConfigUtil  使用_单下划线开头的类名为内部使用,from M import *默认不被导入的情况. 4. 变量: 1)全局变量名(类变量,在java中相当于static变量): 大写字母,单词之间用_分割 NUMBER , COLOR_WRITE  对于from M impor

python——命名规范

1.项目名称首字母大写+大写式驼峰,ProjectName 2.模块名和包名全部小写+下划线驼峰module_name  package_name 3.类名称,异常首字母大写+大写式驼峰,class ClassName:   ,ExceptionName 4.全局变量.常量全部使用大写字母+下划线驼峰GLOBAL_VAR_NAME,CONSTANT_NAME 5.方法名,函数名,其余变量,参数,实例全部小写+下划线驼峰method_name,function_name,instance_var_

python 中变量的命名规范

出自:http://www.diybl.com/course/3_program/python/20111130/563643.html 模块名: 小写字母,单词之间用_分割 ad_stats.py 包名: 和模块名一样 类名: 单词首字母大写 AdStats ConfigUtil 全局变量名(类变量,在java中相当于static变量): 大写字母,单词之间用_分割 NUMBER COLOR_WRITE 普通变量: 小写字母,单词之间用_分割 this_is_a_var 实例变量: 以_开头,

后端前端命名规范

python命名规范:#类名class(静态变量): 单词首字母大写AdStats,MyClass#全局变量名:大写字母,单词之间用_分割COLOR_WRITE,from M import *导入语句#实例变量:以_开头_instance_var#私有实例变量(外部访问会报错): 以__开头(2个下划线)__private_var# 专有变量:__开头,__结尾__doc__,python的自有变量,不要以这种方式命名XXx # 普通函数:get_name() fn_my_example() #

【转】python变量命名规范

python源码和其他一些书籍,命名各种个性,没有一个比较统一的命名规范.于是总结了一些,供参考. 模块名: 模块应该使用尽可能短的.全小写命名,可以在模块命名时使用下划线以增强可读性.同样包的命名也应该是这样的,虽然其并不鼓励下划线. 主要是考虑模块名是与文件夹相对应的,因此需要考虑文件系统的一些命名规则的,比如Unix系统对大小写敏感,而过长的文件名会影响其在Windows\Mac\Dos等系统中的正常使用. 通常是小写字母,单词之间用_分割 ad_stats.py 包名: 和模块名一样 类

python 变量命名规范

python源码和其他一些书籍,命名各种个性,没有一个比较统一的命名规范.于是自己总结了一些,可供参考.模块名:小写字母,单词之间用_分割ad_stats.py 包名:和模块名一样 类名:单词首字母大写AdStatsConfigUtil 全局变量名(类变量,在java中相当于static变量):大写字母,单词之间用_分割NUMBERCOLOR_WRITE 普通变量:小写字母,单词之间用_分割this_is_a_var 实例变量:以_开头,其他和普通变量一样_price    _instance_

python之命名规范

在学习的时候每次都会遗忘类,模块,函数到底首字母是大写还是小写,此文档只供记忆使用,完整的命名规范请参考其他网络文档 例如:http://book.douban.com/reading/10700087/ 1.包,模块的命名规范 全部小写 Filename:pythonmodule.py 2.类,对象的命名规范 每个单词的首字母大写,其他小写 class MyClass: 3.函数 首字母小写,其他字母首字母大写 def myTest: