Python中if __name__ == '__main__':的作用和原理
- 前言
- 1. __name__的理解
- 1.1 为什么使用__name__属性?
- 1.2 __name__属性
- 2. 模块导入
- 3. `__name__与"__main__"`
- 4. `if __name__ == '__main__':`的作用
- 5. 又一例子
前言
学过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__:”
这条代码的意义之一。
1. __name__的理解
1.1 为什么使用__name__属性?
Python解释器在导入模块时,会将模块中没有缩进的代码全部执行一遍(模块就是一个独立的Python文件)。开发人员通常会在模块下方增加一些测试代码,为了避免这些测试代码在模块被导入后执行,可以利用__name__属性。
1.2 __name__属性
__name__
属性是Python的一个内置属性,记录了一个字符串。
- 若是在当前文件,name 是__main__。
- 在hello文件中打印本文件的__name__属性值,显示的是__main__
- 若是导入的文件,__name__是模块名。
- test文件导入hello模块,在test文件中打印出hello模块的__name__属性值,显示的是hello模块的模块名。
因此__name__ == '__main__'
就表示在当前文件中,可以在if __name__ == '__main__':
条件下写入测试代码,如此可以避免测试代码在模块被导入后执行。
2. 模块导入
我们知道,当我们把模块A中的代码在模块B中进行import A时,只要B模块代码运行到该import语句,模块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__':”
内部。
3. __name__与"__main__"
看到现在也许心中还是疑惑,那么现在我们来说一说“if__name__=='__main__':”
的原理。
“__name__”
是Python的内置变量,用于指代当前模块。我们修改上面用到的A模块和B模块,在模块中分别输出模块的名称:
模块A:
# 模块A
print('你好,我是模块A……')
print('模块A中__name__的值:{}'.format(__name__))
print('-------------------------')
输出结果:
你好,我是模块A……
模块A中__name__的值:__main__
-------------------------
模块B:
# 模块B
from package01 import A
print('你好,我是模块B……')
print('模块B中__name__的值:{}'.format(__name__))
输出结果:
你好,我是模块A……
模块A中__name__的值:package01.A
-------------------------
你好,我是模块B……
模块B中__name__的值:__main__
当哪个模块被直接执行时,该模块“__name__”
的值就是“__main__”
,当被导入另一模块时,“__name__”
的值就是模块的真实名称。
4. if __name__ == '__main__':
的作用
python文件通常有两种使用方法:
第一是作为脚本直接执行
第二是 import 到其他的 python 脚本中被调用(模块重用)执行。
因此 if __name__ == 'main':
的作用就是控制这两种情况执行代码的过程,在 if __name__ == 'main':
下的代码只有在第一种情况下(即文件作为脚本直接执行,在当前文件下执行代码)才会被执行,而 import 到其他脚本中是不会被执行的。
5. 又一例子
1. add_.py
# 定义一个实现加法功能的py代码
def add(a, b):
return a + b
res = add(2, 3)
print(res)
2. use_py
# 定义另一个py代码,导入add_.py中的add方法,类似模块导入
from add_ import add
res = add(2, 3)
print(f'结果是:{res}') # fiill a value
打印结果:
5
5
我们只想要一个结果5,但是输出两个,把第一个py代码中测试代码,放在__name__=='main’中,use.py执行add()就不会执行测试代码了!
if __name__=='__main__':
res = add(2, 3)
print(res)
运行use.py
,输出结果:
5
参考:Link