name 是魔法函数的一种,如果大家想详细了解和魔法函数相关的知识点击这里,里面整理了Python中常见的魔法函数用法,都有详细的代码解析。
每次开启一个程序,都必须写一个主函数作为程序的入口,也就是我们常说的 main 函数。如下,main() 就是 Java 中的一个 main 函数。
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
与 Java 不同,Python 是一种解释型脚本语言,在执行之前不需要将所有代码先编译成中间代码,Python 程序运行是从模块顶行开始,逐行进行翻译执行,所以最顶层(没有被锁进)的代码都会被执行,所以 Python 中并不需要一个统一的 main() 作为程序的入口。在某种意义上讲,if __name__ == '__main__': 也像是一个标志,象征着 Java 等语言中的程序入口,告诉其他程序员,代码入口在此,这是 if __name__ == '__main__': 这条代码的意义之一。
__name__ 的理解
为什么使用 __name__ 属性?
Python 解释器在导入模块时,会将模块中没有缩进的代码全部执行一遍(模块就是一个独立的 Python 文件)。开发人员通常会在模块下方增加一些测试代码,为了避免这些测试代码在模块被倒入后执行,可以利用 __name__ 属性。
__name__ 属性
__name__ 属性是 Python 的一个内置属性,记录了一个字符串。
若是当前文件,__name__ 是 __main__。
print(__name__)
# __main__
若是导入的文件,__name__ 是模块名
import re
print(re.__name__)
# re
因此 __name__ == '__main__' 就表示在当前文件中,可以在 if __name__ == '__main__': 条件下写入测试代码,如此可以避免测试代码在模块被导入后执行。
模块导入
当我们把模块 A 中的代码在模块 B 中进行 import A 时,只要 B 模块代码运行到该 import 语句,模块 A 的代码会被执行。
# 模块 A
a = 100
print("This is A")
print(a)
# 模块 B
from package import A
b = 200
print("This is B")
print(b)
运行模块 B 时,输出结果如下:
> This is A
> 100
> This is B
> 200
如果在模块 A 中,我们有部分代码不想在被导入到 B 时直接被运行,但在直接运行 A 时可直接运行,那该怎么做呢?可以用到 if __name__ = '__main__': 这行代码,对 A 模块进行修改:
# 模块 A
a = 100
print("This is A")
if __name__ = '__main__':
print(a)
B 模块不做修改,直接执行 B 模块,输出结果如下:
This is A
This is B
200
A 模块中的 a 的值就没有再被输出了。所以,当你要导入某个模块,但又不想该模块的部分代码被直接执行,那就可以这一部分代码放在 if __name__ = '__main__': 内部。
__name__ 和 __main__
那么现在看一看 if __name__ = ''__main__: 的原理。 __name__ 是 Python 的内置变量,用于指代当前模块。我们修改上面用到的 A 模块和 B 模块,在模块中分别输出模块的名称:
# 模块 A
print("This is A")
print("A __name__ is {}".format(__name__))
print("-------------")
# 模块 B
from package import A
print("This is B")
print("B __name__ is {}".format(__name__))
# 执行 A 模块时,输出结果:
> This is A
> A __name__ is __main__
> -------------
# 执行 B 模块时,输出结果:
> This is A
> A __name__ is package.A
> -------------
> This is B
> B __name__ is __main__
当哪个模块被直接执行时,该模块 __name__ 的值就是 __main__,当被另一模块导入时,__name__ 的值就是模块的真实名称。用一个类比来解释一下:记得小时候要轮流打算教室,轮到自己的时候(模块被直接执行的时候),我们会说今天是“我”(__main__)值日,称呼其他人时,我们就会直接喊他们的名字。所以,'__main__'就相当于当事人,或者说第一人称的“我”。
所以,当运行 if __name__ == '__main__': 语句时,如果当前模块时直接执行,__name__ 的值就是 __main__,条件判断结果为 True,if __name__ == '__main__': 下面的代码块就会被执行。