关于“__name__”变量

“__name__”是一个python内建的系统变量。这一点可以通过dir(__builtins__)来查看(参见《Python基础笔记》的No.21):

>>> dir(__builtins__)
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BufferError', 'BytesWarning', 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False', 'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', 'ImportWarning', 'IndentationError', 'IndexError', 'KeyError', 'KeyboardInterrupt', 'LookupError', 'MemoryError', 'NameError', 'None', 'NotImplemented', 'NotImplementedError', 'OSError', 'OverflowError', 'PendingDeprecationWarning', 'ReferenceError', 'RuntimeError', 'RuntimeWarning', 'StandardError', 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError', 'Warning', 'WindowsError', 'ZeroDivisionError', '_', '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs', 'all', 'any', 'apply', 'basestring', 'bin', 'bool', 'buffer', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'cmp', 'coerce', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'execfile', 'exit', 'file', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input', 'int', 'intern', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'long', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'raw_input', 'reduce', 'reload', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'unichr', 'unicode', 'vars', 'xrange', 'zip']

为了说明这个变量的用途,我们举如下示例。
现在我在c:\temp目录中新建一个test.py程序,里面的内容如下:

print '__name__:',__name__

直接执行代码,结果如下:

__name__: __main__

下面我们把刚才建立的test.py程序做为一个模块导入到python中再看看导入的结果是什么。

>>> import os
>>> os.chdir(r'c:\temp')  #因为test.py是存放在c:\temp目录中的,此处将c:\temp目录设置为当前目录才可以import test导入模块
>>> import test
__name__: test

从上面的结果可以看出来同一个程序文件(test.py),直接执行和当作模块用“import”导入两种执行方式,__name__变量的值是不一样的。

直接执行时,__name__变量的值是“__main__”(注意,是__main__,不是__name__)。
以模块的方式导入执行时,__name__变量的值是模块的名称,此处为文件名“test”。

这种特性对我们编程有什么用处呢?

通常我们编写自己的模块文件时如果要对该模块中的函数进行测试和调试,一般会在所有的类和函数定义的最下面编写测试代码。但这些测试代码在其他调用程序调用该模块(import ModuleName)时被执行,这种情况并不是我们需要的。那我们要做的就是每次在编写模块并测试结束后手工删除测试代码。那有没有更好的办法即能让我们保留测试代码,又可以在其他程序调用此模块时不执行测试代码呢?
我们重新修改之前的test.py程序如下:

#-*-coding:utf-8-*-     #因为代码中包括中文,增加该条语句告诉python中文字符的编码格式
class test1(object):
    def __init__(self):
        pass
    def pr(self):
        print 'a'
def pr1():
    print '1'

'''以下是测试代码'''
if __name__=='__main__':
    t1=test1()
    t1.pr()
    pr1()

我们直接执行test.py程序,结果如下:

a
1

下面将test.py以模块的形式导入到python中去,再看看执行结果。

>>> import os
>>> os.chdir(r'c:\temp')
>>> import test      #此处在导入模块后并没有执行测试代码
>>> a=test.test1()
>>> a.pr()
a
>>> test.pr1()
1

如果我们尝试着将test.py中的if __name__=='__main__':语句删除,并取消相应的缩进再导入该模块看看。
test.py代码如下:

#-*-coding:utf-8-*-
class test1(object):
    def __init__(self):
        pass
        
    def pr(self):
        print 'a'
        
        
def pr1():
    print '1'

'''以下是测试代码'''
t1=test1()
t1.pr()
pr1()

导入的python中的结果如下:

>>> import os
>>> os.chdir(r'c:\temp')
>>> import test    #因为删除掉“if __name__=='__main__':”,在导入的同时,测试代码就执行了
a
1

从以上示例可以看出,可以使用name变量在以不同方式执行(直接执行和以模块的形式导入)时值不同的特性实现在模块中即能保留测试代码,又可以使测试代码在该模块被导入时不执行。

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

推荐阅读更多精彩内容