Python 中 if name == 'main' 的意义

说明

《Python 教程》持续更新中，提供建议、纠错、催更等加作者微信: gairuo123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》和《Python之光》。

在 Python 中，if __name__ == '__main__' 是一种惯用的代码块，用于判断当前脚本是否作为主程序直接运行，还是被其他模块导入并调用。

简单解释

当一个Python脚本作为主程序直接运行时，__name__ 变量的值会被设置为 '__main__'。如果脚本被其他模块导入并调用，__name__ 变量的值则会是该模块的名字。

因此，通过 if __name__ == '__main__'，我们可以在脚本中编写一些在作为主程序运行时才执行的代码。这样的代码通常包含一些初始化操作、测试语句或执行特定任务的代码块。

下面是一个示例：

# 脚本中的一些代码...

def some_function():
    pass
    # 函数定义...

# 脚本中的其他代码...

if __name__ == '__main__':
    # 只有当脚本作为主程序直接运行时才会执行的代码
    # 可以在这里调用函数、执行特定任务等
    some_function()

这样，当脚本被作为主程序直接运行时，some_function() 函数会被调用。但如果脚本被其他模块导入并调用，some_function() 不会自动执行。

通过这种方式，我们可以将一些在脚本作为主程序时才需要执行的代码与可重用的函数或类定义分离，提高代码的模块化和可复用性。

详细解释

当一个 Python 脚本包含 if __name__ == '__main__' 的条件语句时，它的执行逻辑如下：

如果脚本作为主程序直接运行（即通过命令行执行该脚本），__name__ 的值将被设置为 __main__。
如果脚本被其他模块导入并调用，__name__ 的值将是该模块的名字（而不是 __main__）。

让我们通过一个具体的案例来说明这个逻辑。

假设我们有两个 Python 脚本文件：main.py 和 helper.py。

helper.py 文件内容如下：

def greet(name):
    print(f"Hello, {name}!")

print("This statement is always executed in helper.py.")

main.py 文件内容如下：

import helper

print("This statement is always executed in main.py.")

if __name__ == '__main__':
    print("This statement is only executed when main.py is run directly.")
    helper.greet("Alice")

现在，我们来运行 main.py 文件和观察输出的结果。

当我们在命令行中直接运行 main.py 文件时，输出如下：

This statement is always executed in helper.py.
This statement is always executed in main.py.
This statement is only executed when main.py is run directly.
Hello, Alice!

我们可以看到：

helper.py 中的语句 "This statement is always executed in helper.py." 总是会被执行，因为它在 import helper 时就会被执行。
main.py 中的语句 "This statement is always executed in main.py." 总是会被执行，因为它在 import helper 后面。
if __name__ == '__main__': 条件为真，所以在主程序直接运行 main.py 时，下面的语句 "This statement is only executed when main.py is run directly." 会被执行，并调用 helper.greet("Alice")。

现在，让我们尝试导入 main.py 并调用其中的函数。在另一个 Python 脚本中，我们写入以下代码：

import main

main.helper.greet("Bob")

当我们运行这个新的脚本时，输出如下：

This statement is always executed in helper.py.
This statement is always executed in main.py.

我们可以看到：

helper.py 中的语句 "This statement is always executed in helper.py." 仍然会被执行，因为 main.py 导入了 helper.py。
main.py 中的语句 "This statement is always executed in main.py." 也会被执行，因为导入 main.py 会执行其中的代码。
if __name__ == '__main__': 条件为假，所以下面的语句 "This statement is only executed when main.py is run directly." 不会被执行，因为我们只是导入了 main.py，而不是直接运行它。

通过使用 if __name__ == '__main__' 条件语句，我们可以在脚本作为主程序直接运行时执行特定的代码块，而在被导入时避免执行这些代码块。这样可以使我们的脚本更加灵活和可重用。

参考

https://note.nkmk.me/en/python-if-name-main/
https://realpython.com/if-name-main-python/
https://aiacademy.jp/media/?p=1478

Python 命令行执行脚本

更新时间：2023-06-12 03:55:12 标签：python if 名称

Python 中 if __name__ == '__main__' 的意义

简单解释

详细解释

参考

Python 中 if name == 'main' 的意义