Python中 if __name__ == '__main__': 的含义与作用

基本含义

if __name__ == '__main__': 是Python中一个常见的代码结构，用于判断当前模块是作为主程序直接运行，还是被导入到其他模块中。

为什么需要这样写

主要作用

  1. 模块的双重角色：

    • 既可以被其他模块导入使用（作为库）
    • 也可以直接运行（作为主程序）

  2. 防止意外执行：

    • 放在这个条件块下的代码只有在直接运行该文件时才会执行
    • 当文件被导入时，这部分代码不会自动执行

  3. 测试代码隔离：

    • 可以把测试代码或演示代码放在这个块中
    • 确保这些代码不会在模块被导入时运行

工作原理

  • 当Python文件直接运行时，__name__ 会被设为 '__main__'
  • 当文件被导入时，__name__ 会被设为模块的名称（文件名去掉.py后缀）

示例说明

1
2
3
4
5
6
7
# mymodule.py
def useful_function():
    print("这是一个有用的函数")

if __name__ == '__main__':
    print("正在运行测试...")
    useful_function()

  • 如果直接运行 python mymodule.py，会输出：

    1
    2
    正在运行测试...
    这是一个有用的函数

  • 如果在另一个文件中 import mymodule，则只会导入 useful_function，不会执行测试代码

最佳实践

  1. 这是Python社区广泛采用的惯用写法
  2. 特别适合既包含可重用函数又包含测试代码的模块
  3. 使得模块更加干净、专业，便于其他开发者使用

这种结构让Python模块既能独立运行完成特定任务，又能作为库被其他代码安全地导入使用。