📜  __name__== __main__ 在 python 中(1)

📅  最后修改于: 2023-12-03 15:29:16.402000             🧑  作者: Mango

小白程序员必读:name==main 在 Python 中

当你写 Python 程序时,你可能经常遇到这样的代码段:

if __name__ == "__main__":
    # do something

这段代码被称为 Python 程序的入口点,那么这段代码具体是什么意思呢?本篇文章将向你介绍 name==main 在 Python 中的作用。

name

在 Python 中,每个模块都有一个特殊的属性,表示模块的名称。这个属性叫做 __name__,它包含了当前模块的名称。

当你在 Python 中执行一个文件时,Python 解释器会把当前执行的模块的 __name__ 设置为 "__main__",如果你以模块的形式导入这个文件,那么这个 __name__ 就会被设置成文件名。例如,假设我们有一个名为 test.py 的文件,可以在 Python 解释器中运行它:

$ python test.py

这时 __name__ 就被设置为 "__main__",因为这个文件是当前执行的文件。如果我们在另外一个 Python 文件中 importtest.py

import test

那么 test.py 中的 __name__ 就会被设置为 "test",因为现在它不是当前执行的文件了。

name==main

回到这个原始的代码段:

if __name__ == "__main__":
    # do something

这段代码使用了 Python 的条件语句,如果当前模块(文件)的 __name__ 等于 "__main__",说明这个模块是当前执行的模块,而不是被其他模块导入的模块。因此,这个条件成立,就会执行 # do something 后面的代码。

这样做的好处是,可以让你在开发一个模块时,同时编写一些测试代码,在测试代码中执行某些操作来验证模块的功能是否正常。如果这个模块被导入到其他的模块中,测试代码不会被执行,如果这个模块是当前执行的模块,测试代码会被执行。

示例

为了更好地理解 name==main 的作用,我们来看一个简单的例子。我们创建一个 hello.py 文件,并编写以下内容:

def say_hello():
    print("Hello World!")
    
if __name__ == "__main__":
    say_hello()

这个 hello.py 文件中有一个叫做 say_hello() 的函数,该函数只会输出一行 Hello World!。同时,文件的入口点也被定义为 say_hello() 函数,这意味着如果这个文件被作为当前执行的模块,那么 say_hello() 函数会被执行。

我们创建另一个 main.py 文件,利用 hello.py 中的函数并测试它们是否可行:

import hello

hello.say_hello()

在这个例子中,我们事先定义好了一个 hello.py 文件,该文件中包含了一个 say_hello() 函数。main.py 文件导入了 hello.py 中的内容,并直接调用了 say_hello() 函数。当 main.py 文件被执行时,由于 hello.py 中的条件语句 if __name__ == "__main__": 不成立,因此不会出现多余的输出。

总的来说,__name__==__main__ 这个条件语句为 Python 开发者编写模块和程序提供了一种简单有效的方式,来实现模块和程序的分离,同时也为代码的测试和部署提供了便利。

结论

在 Python 中,__name__==__main__ 是一个很常用的条件语句。它使得开发者可以在一个文件中写入测试代码,并通过控制 __name__ 来避免测试代码被导入后执行。

这对于编写函数库或接口程序的开发者来说非常有用,因为它使得开发者能够在不改变已有的代码结构的情况下轻松测试新的代码。

为了保证代码的可读性和易于维护,我们强烈建议你在编写 Python 程序时使用 __name__==__main__ 来做模块和程序的分离。


注:本文参考了 Python 入门指南 - name == "main" 和代码分解 的相关内容。