Python __name__ 属性使用注意事项

name 的值取决于模块的使用方式：直接运行时为 '__main__'，被导入时为模块名。通过 if name == '__main__': 可控制代码仅在直接执行时运行，避免导入时产生副作用，提升模块复用性与测试便利性。

__name__ 是 Python 中一个非常实用的内置属性，主要用于判断当前模块是被直接运行还是被导入使用。正确理解和使用 __name__ 能有效避免意外执行代码或模块间的副作用。

理解 __name__ 的取值

每个 Python 模块都有一个 __name__ 属性，其值取决于模块的使用方式：

• 当模块被直接运行时，__name__ 的值为 '__main__'
• 当模块被 import 导入时，__name__ 的值为模块的文件名（不含 .py）

例如，有一个文件 my_module.py：

print(__name__)

if __name__ == '__main__':
    print("模块被直接运行")

直接执行 python my_module.py 会输出：

__main__
模块被直接运行

如果在另一个脚本中导入它：import my_module，则输出为：

my_module

此时不会执行 if 块中的内容。

控制主程序入口

利用 __name__ 可以清晰地分离模块的功能定义和执行逻辑。适合将测试代码或主程序入口放在 if __name__ == '__main__': 块中。

这样做的好处是：

• 模块可作为独立脚本运行，便于调试
• 被导入时不会自动执行主流程，避免副作用
• 提升代码复用性和模块化程度

避免在顶层写执行代码

如果不使用 __name__ 判断，而是在模块顶层直接写执行语句，那么每次导入该模块都会触发这些代码，可能导致：

• 重复打印、文件操作或网络请求
• 意外启动服务或进程
• 影响导入性能或引发错误

推荐做法是将执行代码封装进函数，并在 if __name__ == '__main__': 中调用：

def main():
    print("执行主逻辑")

if __name__ == '__main__':
    main()

单元测试中的应用

在编写简单测试时，可以直接在模块末尾添加测试逻辑：

def add(a, b):
    return a + b

if __name__ == '__main__':
    assert add(1, 2) == 3
    print("所有测试通过")

这样既不影响其他模块导入使用 add 函数，又能方便地本地验证功能。

基本上就这些。合理使用 __name__ 是编写健壮、可复用模块的基本习惯，尤其在项目结构复杂时尤为重要。