【Python 基础篇】Python中的 __name__ == ‘__main__’ 详解

学习过C语言或者Java语言的盆友应该都知道程序运行必然有主程序入口main函数,而python却不同,即便没有主程序入口,程序一样可以自上而下对代码块依次运行,然后python不少开源项目或者模块中依然存在 __name__ == “__main__” 这种写法,具体是上面意思呢?

一. 语义解释

1.  关于 __name__

__name__ 是python的内置属性,是系统全局变量!每一个py文件都有一个属于自己的__name__。

但有个使用规则,请注意如下两点:

(1)如果py文件作为模块被导入(import),那么__name__就是该py文件的文件名(也称模块名)

(2)如果py文件直接运行时,那么__name__默认等于字符串”__main__”

简单的例子,打比方:

假如你名字是张三,在朋友眼中,你是张三(__name__ == '张三');在你自己眼中,你是你自己(__name__ == '__main__')

2.  关于__main__

“__main__” 实际上就是一个字符串,用来鉴别程序入口,没有太多花里胡哨的东西.

3.  关于 __name__ == “__main__”

当.py文件被直接运行 (Ctrl+Shift+F10)时, if __name__ == “__main__” 之下的代码块将被运行,该语句就相当与python的main主函数入口,示例代码如下:

a.新建一个 my_name.py 文件,作为模块文件:

# coding = utf-8
# 定义一个函数并打印 __name__
def prit_name():
    print("my_name.py __name__:", __name__)
 
if __name__ == "__main__":
    prit_name()

b.新建一个 python_main.py 文件,作为启动文件 (Ctrl+Shift+F10)

# coding = utf-8
# 导入 my_name 模块
import my_name
 
# 定义一个函数并打印 __name__
def prit_name():
    my_name.prit_name()
    print("python_main.py __name__:", __name__)
 
if __name__ == "__main__":
    prit_name()

  输出结果:

my_name.py __name__: my_name
python_main.py __name__: __main__

由此可见,作为启动文件 python_main.py ,该文件的内置属性 __name__ 等于 “__main__”,而my_name.py 作为导入模块,该模块的 __name__ 等于文件名(也称模块名字),所以my_name.py 中的 表达式 if __name__ == “__main__” 并不成立!

当直接将my_name.py作为启动文件时 (Ctrl+Shift+F10),输出:

my_name.py __name__: __main__

二. 代码作用

1.__name__ == “__main__” 作为启动py文件的main函数入口

2.一个项目中必然会包含多个模块文件,每个模块文件在自己写完代码之后会做一些简单的测试用于检测bug 或者 对自己的函数调用写一个简单的示例,而恰到好处的是:__name__ == “__main__” 既不会影响你的测试代码,也不会影响别人调用你的接口函数。