Skip to content

理解 if __name__ == "__main__": 在 Python 中的作用

Posted on:2024年6月19日 at 23:50

在 Python 脚本中,我们经常会看到这样的代码结构:

if __name__ == "__main__":
    print("Hello, World!")

这个代码块究竟有什么作用?为什么我们需要包含这个 if 语句?让我们深入探讨一下。

背景

当 Python 解释器读取一个源文件时,它会执行两件事:

  1. 设置一些特殊变量,例如 __name__
  2. 执行文件中的所有代码。

特殊变量 __name__

在 Python 中,每个模块都有一个内置的属性 __name__。当模块被直接运行时,__name__ 的值为 "__main__";当模块被导入时,__name__ 的值是模块的名字。

示例代码

假设我们有一个文件 foo.py,其中包含以下代码:

# 假设这是 foo.py

print("before import")
import math

print("before function_a")
def function_a():
    print("Function A")

print("before function_b")
def function_b():
    print("Function B {}".format(math.sqrt(100)))

print("before __name__ guard")
if __name__ == '__main__':
    function_a()
    function_b()
print("after __name__ guard")

当 Python 解释器读取这个文件时,它会执行以下操作:

  1. 打印 "before import"
  2. 导入 math 模块。
  3. 打印 "before function_a"
  4. 定义 function_a 函数。
  5. 打印 "before function_b"
  6. 定义 function_b 函数。
  7. 打印 "before __name__ guard"
  8. 检查 __name__ 是否等于 "__main__",如果是,则调用 function_afunction_b
  9. 打印 "after __name__ guard"

执行结果

当我们直接运行 foo.py 时(python foo.py),输出如下:

before import
before function_a
before function_b
before __name__ guard
Function A
Function B 10.0
after __name__ guard

如果我们在另一个文件中导入 foo 模块(import foo),输出如下:

before import
before function_a
before function_b
before __name__ guard
after __name__ guard

为什么需要 if __name__ == "__main__":

这个条件语句的主要目的是防止模块中的某些代码在不合适的时候被执行。常见的应用场景包括:

  1. 编写可以被其他模块导入的库,同时允许脚本作为独立程序运行。
  2. 模块包含单元测试或演示代码,只有在直接运行时才执行这些代码。
  3. 提供面向高级用户的编程接口,同时允许模块作为主程序运行。