python 变量下划线命名规则

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

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

  • 单前导下划线:_var (不具有protected属性,靠自觉)
  • 单末尾下划线:var_(不具有protected属性,靠自觉)
  • 双前导下划线:__var (具有protected属性,无法调用,会提示错误)
  • 双前导和末尾下划线:__var__ (具有protected属性,无法调用,会提示错误)
  • 单独单下划线:_
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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,548评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,069评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,985评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,305评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,324评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,030评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,639评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,552评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,081评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,194评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,327评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,004评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,688评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,188评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,307评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,667评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,337评论 2 358