python 变量下划线命名规则

2020-10-13  本文已影响0人  千千罐

单下划线和双下划线在Python变量、类、模块命名中都有不懂的含义,名称中都各有其含义。有一些是程序员之间约定俗成的,Python解释器不用强制其执行,但有些Python解释器会强制执行。

本文从以下几种不同使用方式,对下划线的用途和含义进行说明:

1. 单前导下划线 _var

1)变量
通常用于类内部变量的命名,表明该变量是该类私用变量,外部不要去访问它,但也是可以访问到的。这只是程序员之间的一个约定俗成的做法,Python解释器本身不会对它进行限制。
我们创建一个类:

class A:
   def __init__(self):
       self.foo  = 111
       self._bar = 222

实例化A,并访问它的变量,aa._bar 也是可以访问的,但既然人家这么命名了,外部最好不要去访问了

>>> aa = A()
>>> aa.foo
111
>>> aa._bar
222

2)函数和模块
和变量一样,这是一个私有函数,不建议外部程序调用该函数。
我们创建一个脚本aa.py, 里面有2个函数 _aa,bb:

def _aa():
    ''' do something'''
    print ('_aa, do something')

def bb():
    print('bb, do something')

导入aa,分别调用函数 _aa和bb,bb 可以调用,但显示无 _aa

>>> from aa import *
>>> bb()
bb, do something
>>> _aa()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name '_aa' is not defined

3)类
同变量和函数一样,都是私有变量,外部最好不要调用

2. 单末尾下划线:var_

用来避免和Python内置函数命名产生冲突,PEP8解释了这个约定。
如class或def不能用作Python中的变量名称,如果之间用,会提示错误。如果你非要用它,可以 使用 class_或 def_。
还有一些函数名,如chr,chr()是Python内置函数,用来表示ascii码对应的字符他的输入时数字,可以用十进制,也可以用十六进制。如果你非要它来表示染色体,可以用chr_来代替。当然如果你直接使用它作为变量名,它也不会报错,但最好不要这样使用。

>>> def test(name, class):
SyntaxError: "invalid syntax"
 
>>> def test(name, class_):
3. 双前导下划线 __var

在python中定义私有变量只需要在变量名或函数名前加上 "__" (两个下划线),那么这个函数或变量就会成为私有的了。

在内部,python使用一种 name mangling 技术,将__var 替换成 _classname__var,因此在外部调用__var会找不到,代替它的是_classname_var。这种处理方式叫做名称修饰(name mangling):解释器更改变量的名称,以便在类被扩展的时候不容易产生冲突。

4. 双前导和双末尾下划线 __var__

由双下划线前缀和后缀包围的变量,不会应用名称修饰,因此不会被Python解释器修改:
我们创建一个类B,dir() 查看类的所有属性,发现 存在 __aa__

##举例1
class B:
   def __init__(self):
       self.__aa__ = 'aa'

 >>> dir(B())
['__aa__', '__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__']

>>> B().__aa__
'aa'

##举例2
>>> class B:
          def __init__(self):
            self.__class__ = 'cc'

>>> B().__class__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in __init__
TypeError: __class__ must be set to a class, not 'str' object

但是,Python保留了有双前导和双末尾下划线的名称,用于特殊用途。 如,__init__对象构造函数,或 __call__ 它使得一个对象可以被调用。所有我们尽量不要使用这种方式命名变量,以免和Python解释器内置的函数发生冲突。

5. 单独单下划线 _

_ 不加任何其他字符,单独作为一个名字,用来表示某个临时的或者无关紧要的变量。

举例1:表示一个临时变量。在下面的循环中,我们不需要获取循环的索引,只是print n 行 'Hello World',可以用 "_" 来表示它只是一个临时值:

>>> n = 5
>>> for _ in range(n):
...     print('Hello World')
... 
Hello World
Hello World
Hello World
Hello World
Hello World

举例2:表示一个不关心的变量,仅仅是个占位符变量,用来占位。mlist 列表中,我只想获得1,2,4 位的变量,那 3 和 5 可以 用 _ 来占位

>>> mlist = ['A','B','C','D','E']
>>> fir,sec,_,fou,_ = mlist
>>> fir
'A'
>>> sec
'B'
>>> fou
'D'
>>> _      #_ 同时会被赋值给最后一个变量,但一般我们不去使用它
'E'

举例3 :表示由解释器评估的最近一个表达式的结果,方便进行查看。

>>> a = 1
>>> 
>>> a
1
>>> _
1
>>> b = []
>>> b
[]
>>> _
[]
>>> _.append(1)
>>> _.append(2)
>>> _.append(3)
>>> b
[1, 2, 3]

6. 参考网址:

  1. 详解Python 中的下划线命名规则:https://www.cnblogs.com/MUMO/p/5718578.html
  2. 关于python中带下划线的变量和函数的意义:https://blog.csdn.net/hudiedd/article/details/12581485
上一篇下一篇

猜你喜欢

热点阅读