彻底理解 Python 中的 if name == ‘main’

引言

在 Python 相关代码中，我们经常会遇到如下代码段：

<code># stuff if __name__ == "__main__": # do stuff</code>

本文将以简单易懂的例子解释这段代码的作用，以及我们何时需要使用 if __name__ == "__main__"。

特殊变量

当我们正常运行 Python 脚本时，脚本中的特殊变量 __name__ 的值一般为 "__main__"。我们来看个示例：

<code># first.py print(__name__)</code>

我们在终端中运行上述脚本，得到输出为：

<code>__main__</code>

观察上述输出，当我们运行脚本 first.py 时，变量 __name__ 的值被设置为 "__main__"。

复杂的例子

现在，让我们举一个多文件的例子，假设我们有三个脚本，分别为 a.py, b.py 和 c.py。

其中，a.py 的内容如下：

<code># a.py print("__name__ in a.py:", __name__) from b import * from c import *</code>

b.py 的内容如下：

<code># b.py print("__name__ in b.py:", __name__)</code>

c.py 的内容如下：

<code># c.py print("__name__ in c.py:", __name__)</code>

如果我们运行命令 python a.py，得到结果如下：

<code>__name__ in a.py: __main__ __name__ in b.py: b __name__ in c.py: c</code>

解释如下：

• 在脚本 a.py 中，__name__ 的值为 __main__，因为我们运行的是脚本 a.py。
• 而在脚本 b.py 和 c.py 中，__name__ 的值分别为 b 和 c，因为它们不是直接运行的脚本，而是被 a.py 调用的。

使用场景

在一个项目工程中，我们通常会创建多个 Python 文件，而不是将所有代码都写在一个文件中。因此，我们需要一个主文件作为项目的入口，其他文件包含一些辅助性的函数实现。

假设我们有两个 Python 文件 main.py 和 helper.py，内容如下：

main.py：

<code>from helper import * print(greet("bob"))</code>

helper.py：

<code>def greet(name): return "hello " + name print(greet("testname"))</code>

当我们运行命令 python main.py 时，得到输出：

<code>hello bob hello testname</code>

在这种情况下，helper.py 中的测试语句 print(greet("testname")) 也被执行。虽然我们可以通过添加或屏蔽注释来控制这个测试语句的输出，但使用 if __name__=="__main__" 可以更方便地达到这个目的。

解决方案

我们可以对上述情况进行代码改进：

main.py：

<code>from helper import * print(greet("bob"))</code>

helper.py：

<code>def greet(name): return "hello " + name if __name__ == "__main__": print(greet("testname"))</code>

这样，当我们执行命令 python main.py 时，只会输出：

<code>hello bob</code>

解释如下：

• helper.py 中的 __name__ 变量此时的值为 "helper"，所以 helper.py 中的 if 语句不成立，测试语句 print(greet("testname")) 不会被执行。
• 而当我们单独运行 python helper.py 时，__name__ 的值为 "__main__"，所以测试语句会被执行，输出相应结果。

总结

本文详细介绍了 Python 中常见的 if __name__=="__main__"，并重点分析了其背后的原理及应用场景。