浅析python 中name = 'main' 的作用

「爱情、让人受尽委屈。」 2022-07-12 07:28 125阅读 0赞

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

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

“Make a script both importable and executable”

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

这句话，可能一开始听的还不是很懂。下面举例说明：

先写一个模块：

\#module.py

def main():

print "we are in %s"%\_\_name\_\_

if \_\_name\_\_ == '\_\_main\_\_':

main()

这个函数定义了一个main函数，我们执行一下该py文件发现结果是打印出”we are in \_\_main\_\_“,

说明我们的if语句中的内容被执行了，调用了main()：

但是如果我们从另我一个模块导入该模块，并调用一次main()函数会是怎样的结果呢？

\#anothermodle.py

from module import main

main()

其执行的结果是：we are in module

但是没有显示”we are in \_\_main\_\_“,也就是说模块\_\_name\_\_ = '\_\_main\_\_' 下面的函数没有执行。

这样既可以让“模块”文件运行，也可以被其他模块引入，而且不会执行函数2次。这才是关键。

**总结一下：**

如果我们是**直接执行某个.py文件的时候，该文件中那么”\_\_name\_\_ == '\_\_main\_\_'“是True**,

但是我们如果从另外一个.py文件通过import导入该文件的时候，这时\_\_name\_\_的值就是我们这个py文件的名字而不是\_\_main\_\_。

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

1、这段代码的功能

一个python的文件有两种使用的方法，

第一是直接作为脚本执行，

第二是import到其他的python脚本中被调用（模块重用）执行。

**因此if \_\_name\_\_ == 'main': 的作用就是控制这两种情况执行代码的过程**，

在if \_\_name\_\_ == 'main': 下的代码只有在第一种情况下（即文件作为脚本直接执行）才会被执行，

而import到其他脚本中是不会被执行的。

举个例子，下面在test.py中写入如下代码：

print "I'm the first."

if \_\_name\_\_=="\_\_main\_\_":

print "I'm the second."

并直接执行test.py，结果如下图，可以成功print两行字符串。

即，if \_\_name\_\_=="\_\_main\_\_": 语句之前和之后的代码都被执行。

![python脚本测试][python]

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

import test

执行import\_test.py脚本，输出结果如下：

![if \_\_name\_\_=="\_\_main\_\_"演示][if _name_main]

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

2、运行的原理

每个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\_\_打印出来。文件内容和结果如下，

![python脚本][python 1]

可以看出，此时变量\_\_name\_\_的值为"\_\_main\_\_";

再执行import\_test.py，模块内容和执行结果如下：

![\_\_name\_\_变量][name]

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

Python脚本和模块都是一个以.py结束的文件，那程序是如何判断一个.py文件是作为脚本还是模块呢？

关键是一个名为\_\_name\_\_的变量，如果它的值是\_\_main\_\_，则不能作为模块，只能作为脚本直接运行。

所以在很多脚本的最后都有一段类似下面的语句，限制只能以脚本方式运行，不作为模块：

if \_\_name\_\_ == '\_\_main\_\_':

main()

def test():![None.gif][]

print"test is running"![None.gif][]![None.gif][]

if\_\_name\_\_ == "\_\_main\_\_":\#自运行时调用该程序块![None.gif][]

print"test main is working"![None.gif][]![None.gif][]

if\_\_name\_\_ == "test":\#import时调用该程序块![None.gif][]

print"test is invoked"

自执行效果如图：

![python_test.JPG][]

import执行效果如图：

![python_test1.JPG][]

执行test()方法效果如图：

![python_test0.JPG][]

通过这个例子，**python应用模块的自**[**测试**][Link 1]**程序都放在 if \_\_name\_\_ == "\_\_main\_\_" 条件块下**是多么方便。

\#hello.py

def sayHello():

str="hello"

print(str);

if \_\_name\_\_ == "\_\_main\_\_":

print ('This is main of module "hello.py"')

sayHello()

python作为一种脚本语言，我们用python写的各个module都可以包含以上那么一个累死c中的main函数，只不过python中的这种\_\_main\_\_与c中有一些区别，主要体现在：

1、当单独执行该module时，比如**单独执行**以上hello.py： python hello.py，则输出

This is main of module "hello.py"

hello

可以理解为"if \_\_name\_\_=="\_\_main\_\_":" 这一句与c中的main()函数所表述的是一致的，即作为入口；

2、 当该module被其它module 引入使用时，其中的"if \_\_name\_\_=="\_\_main\_\_":"所表示的Block不会被

执行,这是因为此时module被其它module引用时，**其\_\_name\_\_的 值将发生变化，\_\_name\_\_的值将会是**

**module的名字**。比如在python shell中import hello后，查看hello.\_\_name\_\_：

>>> import hello

>>> hello.\_\_name\_\_

'hello'

>>>

3、 因此，在python中，当一个module作为整体被执行时,**moduel.\_\_name\_\_的值将是"\_\_main\_\_"；**

而当一个 module被其它module引用时，**module.\_\_name\_\_将是module自己的名字**，

当然一个module被其它module引用时，其 本身并不需要一个可执行的入口main了。

可以说python中的这种用法很灵活啊。

[python]: http://www.dengfeilong.com/uploads/allimg/161117/2-16111FZF0c1.png
[if _name_main]: http://www.dengfeilong.com/uploads/allimg/161117/2-16111F91315108.png
[python 1]: http://www.dengfeilong.com/uploads/allimg/161117/2-16111F9194cA.png
[name]: http://www.dengfeilong.com/uploads/allimg/161117/2-16111F92531a4.png
[None.gif]: /images/20220711/da2e0f8440ab44ee9d0704a133d37f00.png
[python_test.JPG]: /images/20220711/eb3572fe3c5d46c79430797012412129.png
[python_test1.JPG]: /images/20220711/fb9d917d30eb4753afe4a54a73c4542c.png
[python_test0.JPG]: /images/20220711/800b5879d0544fcbbf9e71235727b11f.png
[Link 1]: http://lib.csdn.net/base/softwaretest