关于“__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变量在以不同方式执行(直接执行和以模块的形式导入)时值不同的特性实现在模块中即能保留测试代码,又可以使测试代码在该模块被导入时不执行。

你可能感兴趣的:(关于“__name__”变量)