Python __name__ 与 __main_

本文链接：https://blog.csdn.net/likuoelie/article/details/147165961

在 Python 中，__name__ 和 __main__ 是与模块执行相关的内置概念，主要用于区分一个 Python 文件是被直接运行还是作为模块导入。以下是简洁且全面的讲解，涵盖它们的定义、作用和使用场景。如果需要更深入的示例或其他细节，请告诉我！

1. `name` 的定义

__name__: 每个 Python 模块（即 .py 文件）都有一个内置变量 __name__，它表示模块的名称。
值的情况:
- 如果文件被直接运行（如 python script.py），Python 将 __name__ 设置为 "__main__"。
- 如果文件被导入为模块（如 import script），__name__ 被设置为模块的名称（通常是文件名，不含 .py）。

2. `main` 的含义

"__main__" 是一个字符串，表示当前模块是程序的入口点（即直接运行的脚本）。
当 __name__ == "__main__" 为真时，意味着代码是在直接运行该文件，而不是被其他模块导入。

3. 典型用法

最常见的使用方式是通过 if __name__ == "__main__": 来控制代码的执行范围。

示例:

假设有一个文件 my_module.py：

# my_module.py
def say_hello():
    print("Hello from my_module!")

print(f"__name__ is: {__name__}")

if __name__ == "__main__":
    print("This file is being run directly!")
    say_hello()

直接运行（python my_module.py）：
输出：

__name__ is: __main__
This file is being run directly!
Hello from my_module!

作为模块导入（在另一个文件 main.py 中）：
```
# main.py
import my_module
```
输出：
```
__name__ is: my_module
```
注意：if __name__ == "__main__": 块中的代码不会执行。

4. 为什么需要 `if name == "main":`

隔离测试代码：
- 将测试代码或仅在直接运行时需要的代码放在 if __name__ == "__main__": 块中。
- 避免这些代码在模块被导入时意外执行。
模块复用：
- 确保模块的功能（如函数、类）可以被其他文件安全导入，而不会触发不必要的副作用（如打印输出或启动程序）。
清晰的程序入口：
- 明确指定程序的起点，符合 Python 的设计习惯。

示例：模块复用

# math_utils.py
def add(a, b):
    return a + b

if __name__ == "__main__":
    # 测试代码，仅在直接运行时执行
    print(f"Testing add: {add(2, 3)}")  # 输出: Testing add: 5

# use_math.py
from math_utils import add
print(add(5, 7))  # 输出: 12
# 测试代码不会运行

5. 实际应用场景

测试模块功能：

在模块文件中添加测试用例，只在直接运行时执行。

def factorial(n):
    return 1 if n == 0 else n * factorial(n - 1)

if __name__ == "__main__":
    print(factorial(5))  # 输出: 120

命令行工具：

脚本作为独立程序运行时，解析命令行参数并执行。

import sys

def main():
    args = sys.argv[1:]
    print(f"Arguments: {args}")

if __name__ == "__main__":
    main()

避免副作用：
- 防止模块被导入时执行耗时操作（如启动服务器、写入文件）。

6. 注意事项

__name__ 的值：
- 对于直接运行的文件，总是 "__main__"。
- 对于导入的模块，是模块名（如 my_module）。
- 对于交互式解释器（如 Python 的 REPL），__name__ 也是 "__main__"。
包中的 __main__.py：
- 在 Python 包中，__main__.py 文件可以用作包的入口点。
- 运行包：python -m mypackage 会执行 mypackage/__main__.py。
```
# mypackage/__main__.py
print("Running package as main!")
```
性能：
- if __name__ == "__main__": 本身没有性能开销，是标准实践。
误区：
- 不要误以为 if __name__ == "__main__": 是必需的。如果模块只设计为导入使用，可以不写。

7. 进阶细节

动态修改 __name__：
- 极少情况下，__name__ 可以被修改，但不推荐，因为会破坏预期行为。

多线程/多进程：

在使用 multiprocessing 时，if __name__ == "__main__": 尤为重要，避免子进程重复执行导入代码。

from multiprocessing import Process

def worker():
    print("Worker running")

if __name__ == "__main__":
    p = Process(target=worker)
    p.start()
    p.join()