python中 if __name__ == ‘__main__‘

很多新手刚开始学习python的时候经常会看到python 中__name__ = \'__main__\' 这样的代码，可能很多新手一开始学习的时候都比较疑惑，python 中__name__ = '__main__' 的作用，到底干嘛的？

有句话经典的概括了这段代码的意义：

“Make a script both importable and executable”

意思就是说让你写的脚本模块既可以导入到别的模块中用，另外该模块自己也可执行。

这句话，可能一开始听的还不是很懂。

if __name__ == '__main__':的作用

一个python文件通常有两种使用方法，第一是作为脚本直接执行，第二是 import 到其他的 python 脚本中被调用（模块重用）执行。因此 if __name__ == 'main': 的作用就是控制这两种情况执行代码的过程，在 if __name__ == 'main': 下的代码只有在第一种情况下（即文件作为脚本直接执行）才会被执行，而 import 到其他脚本中是不会被执行的。举例说明如下：

1) 直接执行

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2021/4/2 15:42
# @File    : test.py

print("this is one")

print('__name__',__name__)


if __name__ == '__main__':
    print("this is two")

 

直接执行 test.py，结果如下图，可以成功 print 两行字符串。即，if __name__=="__main__": 语句之前和之后的代码都被执行。

2) 通过 import 执行

然后在同一文件夹新建名称为 import_test.py 的脚本，输入如下代码：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2021/4/2 15:46
# @File    : import_test.py

import  test

执行 import_test.py 脚本，输出结果如下：

只输出了第一行字符串。即，if __name__=="__main__": 之前的语句被执行，之后的没有被执行。

if __name__ == '__main__':的运行原理

每个python模块（python文件，也就是此处的 test.py 和 import_test.py）都包含内置的变量 __name__，当该模块被直接执行的时候，__name__ 等于文件名（包含后缀 .py ）；如果该模块 import 到其他模块中，则该模块的 __name__ 等于模块名称（不包含后缀.py）。

而 “__main__” 始终指当前执行模块的名称（包含后缀.py）。进而当模块被直接执行时，__name__ == 'main' 结果为真。

为了进一步说明，我们在 test.py 脚本的 if __name__=="__main__": 之前加入 print(__name__)，即将 __name__ 打印出来。文件内容和结果如下：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2021/4/2 15:42
# @File    : test.py

print("this is one")

print('__name__',__name__)


if __name__ == '__main__':
    print("this is two")

可以看出，此时变量__name__的值为"__main__"。

再执行 import_test.py，执行结果如下：

 

此时，test.py中的__name__变量值为 test，不满足 __name__=="__main__" 的条件，因此，无法执行其后的代码。

 

总结一下：

如果我们是直接执行某个.py文件的时候，该文件中那么”__name__ == '__main__'“是True,但是我们如果从另外一个.py文件通过import导入该文件的时候，这时__name__的值就是我们这个py文件的名字而不是__main__。

这个功能还有一个用处：调试代码的时候，在”if __name__ == '__main__'“中加入一些我们的调试代码，我们可以让外部模块调用的时候不执行我们的调试代码，但是如果我们想排查问题的时候，直接执行该模块文件，调试代码能够正常运行！