name == 'main' 到底是什么意思

本是古典何须时尚 2022-03-20 12:26 283阅读 0赞

# `__name__ == '__main__'`到底是什么意思 #

相信许多人初学 Python 时，常会在例子程序中看到如下语句：

if __name__ == '__main__':
        foo()  # 或其他语句

第 1 行的`__name__ == '__main__'`到底是什么意思呢？

首先，如果你永远都只执行一个 [xxx.py][]，而不去 `import`它的话，那你完全不需要了解这是什么。例如你写了一个程序，文件名叫 [hello.py][]

print("====this is hello.py====")
    def foo():
        print("hello")
    print("call foo() which is defined here") 
    foo()
    print("====this is hello.py END ====")

然后你总是直接执行它，就像这样

$ python3 hello.py 
    ====this is hello.py====
    call foo() which is defined here
    hello
    ====this is hello.py END ====

这完全没有问题。

但是，当别人想引用你的`foo()`函数时，就有问题了。

例如别人写了一个文件，名字是 [world.py][]

# world.py
    print("====this is world.py====")
    from hello import foo
    
    print("call foo() which is defined in other file")
    foo()
    print("====this is world.py END ====")

运行结果如下：

$ python3 world.py 
    ====this is world.py====
    ====this is hello.py====
    call foo() which is defined here
    hello
    ====this is hello.py END ====
    call foo() which is defined in other file
    hello
    ====this is world.py END ====

可以看到，解释器是逐行解释源码的，当执行到源码的第 3 行时，也就是 [hello.py][] 被引用时，[hello.py][] 的每一行都会被解释器读取并执行，执行效果就是结果中的3~6行，然后解释器执行源码的5~7行。

如果你不想要结果中的3~6行，该怎么做呢？

Python 解释器执行代码时，有一些内建、隐含的变量，`__name__`就是其中之一，其意义是“模块名称”。

如果该模块是被引用，那么`__name__`的值会是此模块的名称；如果该模块是直接被执行，那么`__name__`的值是`__main__`。

或许你还不明白，那我们来做个实验。

# hello.py
    print("====this is hello.py====")
    print(__name__)
    def foo():
        print("Ha")
    print("call foo() which is defined here") 
    foo()
    print("====this is hello.py END ====")

请注意上面第3行

# world.py
    print("====this is world.py====")
    print(__name__)
    from hello import foo
    print("call foo() which is defined in other file")
    foo()
    print("====this is world.py END ====")

同样，请注意上面第3行

我们看一下运行结果。

对于第一个：

$ python3 hello.py 
    ====this is hello.py====
    __main__
    call foo() which is defined here
    Ha
    ====this is hello.py END ====

从结果的第3行可以看出，对于直接运行的模块，其模块名是 `__main__`

对于第二个：

$ python3 world.py
    ====this is world.py====
    __main__    # 因为 world.py 被直接执行，所以这里的值是 __main__
    ====this is hello.py====
    hello       # 因为 hello.py 被引用，所以这里的值是 hello
    call foo() which is defined here
    Ha
    ====this is hello.py END ====
    call foo() which is defined in other file
    Ha
    ====this is world.py END ====

注意到第5行了吗？这里的“hello”正是 [hello.py][] 被引用时的模块名称。

由此可见，`__name__`的值在模块被直接执行时与被引用时是不同的。

回到上面的问题：当一个模块被引用时，如何不执行该模块的语句？答案就是靠判断`__name__`是否等于 `__main__`。当一个模块被直接执行时，其`__name__`必然等于`__main__`;当一个模块被引用时，其`__name__`必然等于文件名（[不含.py][.py]）;

# 总结 #

之所以常看见这样的写法，是因为该程序可能有“单独执行”（例如执行一些单元测试）与“被引用”两种情况，鉴于这两种情况中`__name__`的值是不同的:当一个模块被直接执行时，其`__name__`必然等于`__main__`;当一个模块被引用时，其`__name__`必然等于文件名（[不含.py][.py]）。所以利用判断`__name__ == '__main__'`的真假就可以将这两种情况区分出来。

# 参考资料 #

[http://blog.castman.net/教學/2018/01/27/python-name-main.html][http_blog.castman.net_2018_01_27_python-name-main.html]

[xxx.py]: http://xxx.py
[hello.py]: http://hello.py
[world.py]: http://world.py
[.py]: http://xn--ihqy2m.py
[http_blog.castman.net_2018_01_27_python-name-main.html]: http://blog.castman.net/%E6%95%99%E5%AD%B8/2018/01/27/python-name-main.html