Python命名规范

朱雀 2024-03-31 04:59 79阅读 0赞

![ab48d91028bb5080fb3aabd03986e2a7.jpeg][]

一，包名、模块名、局部变量名、函数名

全小写+下划线式驼峰

example：this\_is\_var

二，全局变量

全大写+下划线式驼峰

example：GLOBAL\_VAR

三，类名

首字母大写式驼峰

example：ClassName()

四，关于下划线

以单下划线开头，是弱内部使用标识，from M import \* 时，将不会导入该对象（python 一切皆对象）。

以双下划线开头的变量名，主要用于类内部标识类私有，不能直接访问。模块中使用见上一条。

双下划线开头且双下划线截尾的命名方法尽量不要用，这是标识

example for 1：

module\_1 模块中定义变量 var\_1, \_var\_2, \_\_var\_3

\#module\_1

var\_1

\_var\_2

\_\_var\_3

module\_2 模块中代码如下：

\#module\_2\_error  
‘’’  
以下划线开头的变量不会别导入  
‘’’  
from module\_1import \*

print var\_1  
print \_var\_2 \#将报错  
print \_\_var\_3 \#将报错

执行到第6，7行将会报错，因为凡是以下划线开头的对象都不会被导入。

既然是弱内部使用标识，就还是有使用办法的，只需单独导入即可：

\#module\_2\_solution

from module\_1import \* \# 导入所有的不是下划线开头的对象

from module\_1import \_var\_2, \_\_var\_3\# 显式导入下划线开头的对象

print var\_1  
print \_var\_2\# 不会报错  
print \_\_var\_3 \# 不会报错

example for 2:

\#module\_error  
‘’’  
双下划线开头的变量不能被直接访问  
‘’’

class MyClass():  
def **init**(self):  
self.var\_1= 1  
self.\_var\_2= 2  
self.\_\_var\_3= 3

if **name**==“**main**”:  
obj= MyClass()  
print obj.var\_1  
print obj.\_var\_2  
print obj.\_\_var\_3 \# 这里将会出错

需要定义函数来获取双下划线开头的变量

\#module\_solution

‘’’  
需要定义函数来获取双下划线开头的变量  
‘’’

class MyClass():  
def **init**(self):  
self.var\_1= 1  
self.\_var\_2= 2  
self.\_\_var\_3= 3

def get_var_3(self):
        return self.__var_3

*  1
 *  2

if **name**==“**main**”:  
obj= MyClass()  
print obj.var\_1  
print obj.\_var\_2  
print obj.get\_var\_3() \# 不会再报错

四，其他要注意的

不要像c等语言里面一样去用开头字母标识变量类型（如 iValue），因为python在解释的时候才确定类型。

因为异常也是一个类，所以遵守类的命名规则。此外，如果异常实际上指代一个错误的话，应该使用“Error”做后缀。

命名应当尽量使用全拼写的单词，缩写的情况有如下两种：常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。例如：function 缩写为 fn, text 缩写为 txt, object 缩写为 obj, count 缩写为 cnt, number 缩写为 num 等。

转自：[https://www.weidianyuedu.com][https_www.weidianyuedu.com]

[ab48d91028bb5080fb3aabd03986e2a7.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/41e7a040173c4092961328e1b1ca6756.jpeg
[https_www.weidianyuedu.com]: https://www.weidianyuedu.com