Python 中“if __name__=='__main__':”理解与总结

1 引言

在 Python 当中,如果代码写得规范一些,通常会写上一句if __name__==’__main__':作为程序的入口,但似乎没有这么一句代码,程序也能正常运行。这句代码多于吗?原理又在哪里?本贴对此进行总结说明。

2 程序入口

学过 Java、C、C++ 的程序员应该都知道,每次开启一个程序,都必须写一个主函数作为程序的入口,也就是我们常说的 main 函数。如下所示, main() 就是 Java 中的一个 main 函数。

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("HelloWorld");
    }
}

与 Java、C、C++ 等几种语言不通的是,Python 是一种解释型脚本语言,在执行之前不同要将所有代码先编译成中间代码,Python 程序运行时是从模块顶行开始,逐行进行翻译执行,所以,最顶层(没有被缩进)的代码都会被执行,所以 Python 中并不需要一个统一的 main() 作为程序的入口。在某种意义上讲,if __name__==’__main__':也像是一个标志,象征着 Java 等语言中的程序主入口,告诉其他程序员,代码入口在此——这是if __name__=='__main__':这条代码的意义之一。

3 模块导入

我们知道,当我们把模块 A 中的代码在模块 B 中进行 import A 时,只要 B 木块代码一运行,模块 A 的代码会率先执行。

  模块 A:

# 模块A
a = 100
print('你好,我是模块A……')
print(a)

模块 B:

# 模块B
from package01 import A
b = 200
print('你好,我是模块B……')
print(b)

运行模块 B 时,输出结果如下:
  你好,我是模块 A……
  100
  你好,我是模块 B……
  200
  如果在模块 A 中,我们有部分的代码不想在被导入到 B 时直接被运行,但在直接运行 A 时可直接运行,那该怎么做呢?那就可以用到if __name__=='__main__':这行代码了,我们队上面用到的 A 模块代码进行修改:

  A 模块代码修改为:

# 模块A
a = 100
print('你好,我是模块A……')
if __name__=='__main__':
    print(a)

B 模块不做修改,直接执行 B 模块,输出结果如下:
  你好,我是模块 A……
  你好,我是模块 B……
  200
  看到了吗,A 模块中的 a 的值就没有再被输出了。所以,当你要导入某个模块,但又不想改模块的部分代码被直接执行,那就可以这一部分代码放在if __name__=='__main__':内部。

4 “name__”与“__main

看到现在也许心中还是疑惑,为什么会这样,那么现在我们来所以说“if __name__=='__main__':”的原理。
“__name__”是 Python 的内置变量,用于自带当前模块。我们修改上面用到的 A 模块和 B 模块,在模块中分别输出模块的名称:
  模块 A

 #模块A
print('你好,我是模块A……')
print('模块A中__name__的值:{}'.format(__name__))
print('-------------------------')

模块 B:

# 模块B
from package01 import A
print('你好,我是模块B……')
print('模块B中__name__的值:{}'.format(__name__))

执行 A 模块时,输出结果:
你好,我是模块 A……


执行 B 模块时,输出结果:
  你好,我是模块 A……
  模块 A 中name的值:package01.A
  ————————-
你好,我是模块 B……

  模块 B 中__name__的值__main__

发现神奇之处了吗?当哪个模块被直接执行时,该模块"__name__"的值就是"__main__",当被导入另一模块时,"__name__"的值就是模块的真实名称。用一个类比来解释一下:记得小时候要轮流打算教室,轮到自己的时候(模块被直接执行的时候),我们会说今天是“我”(__main__)值日,称呼其他人时,我们就会直接喊他们的名字。所以,“__main__”就相当于当事人,或者说第一人称的“我”。

  所以,当运行“if __name__=='__main__':”语句时,如果当前模块时被直接执行,__name__的值就是__main__,条件判断的结果为 True,“if __name__=='__main__':”下面的代码块就会被执行。

5 总结

当该模块被直接执行时,条件成立,执行指定的入口模块代码,否则什么也不做。就相当于手动给 py 模块指定一个 main 函数一样,如果未指定直接运行 py 模块会从上到下依次执行。
“if __name__=='__main__':”语句的用处与原理大概也讲清楚了,如果没说明白,或者是我没理解到位,请给我留言。另外多说一句,if __name__=='__main__':很多时候看似无用,但是,出于代码的规范性,还是有必要的。