理解python中的if __name__ == '__main__'

1.摘要

通俗的理解：假如你叫小明的.py，在朋友眼中，你是小明;在你自己眼中，你是你自己。name == 'main'(name == '小明')(name == 'main')

if name == 'main'的意思是：当的.py文件被直接运行时，之下的代码块将被运行;当的.py文件以模块形式被导入时，之下的代码块不被运行。if name == 'main'if name == 'main'

2.程序入口

对于很多编程语言来说，程序都必须要有一个入口，比如C，C ++，以及完全面向对象的编程语言的Java，C＃等。如果你接触过这些语言，对于程序入口这个概念应该很好理解，C ，C ++都需要有一个主函数作为程序的入口，也就是程序的运行会从主函数开始。同样，Java和C＃必须要有一个包含主要方法的主类，作为程序入口。

而Python的则不同，它属于脚本语言，不像编译型语言那样先将程序编译成二进制再运行，而是动态的逐行解释运行。也就是从脚本第一行开始运行，没有统一的入口。

一个Python的源码文件（的.py）除了可以被直接运行外，还可以作为模块（也就是库），被其他的.py文件导入。不管是直接运行还是被导入，的.py文件的最顶层代码都会被运行（Python的用缩进来区分代码层次），而当一个的.py文件作为模块被导入时，我们可能不希望一部分代码被运行。

2.1一个.py文件被其他.py文件引用

假设我们有一个const.py文件，内容如下：

<span style="color:#737373"><code class="language-python">PI = 3.14

def main():
    print("PI:", PI)

main()

# 运行结果：PI: 3.14</code></span>

现在，我们写一个用于计算圆面积的area.py文件，area.py文件需要用到const.py文件中的PI变量从const.py中，我们把PI变量导入area.py：

<span style="color:#737373"><code>from const import PI

def calc<em>round<em>area</em></em><em><em>(radius):</em></em><em><em>
    return PI <em> (radius *</em> 2)

def main():
    print("round area: ", calc<em>round<em>area(2))

main()

'''
运行结果：
PI: 3.14
round area:  12.56
'''</em></em></em></em></code></span>

2.2修改const.py，添加`if name == "main"`

我们看到const.py中的主要函数也被运行了，实际上我们不希望它被运行，因为const.py提供的主函数只是为了测试常量定义。这时派上了用场，我们把const.py改一下，添加：if name == 'main'if name == "main"

<em><em><em><code class="language-python">PI = 3.14

def main():
    print("PI:", PI)

if <strong>name</strong> == "<strong>main</strong>":
    main()</code></em></em></em>

运行const.py，输出如下：

<em><em><em><code class="language-python">PI: 3.14</code></em></em></em>

运行area.py，输出如下：

<em><em><em><code class="language-python">round area:  12.56</code></em></em></em>

如上，可以我们看到相当于Python的模拟的程序入口，Python的本身并没有这么规定，这只是一种编码习惯。由于模块之间相互引用，不同模块可能有这样的定义，而程序入口只有一个到底。哪个程序入口被选中，取决于这的值。if name == 'main'name

3。 `name`

3.1 `name`反映一个包的结构

name是内置变量，可用于反映一个包的结构假设我们有一个包一，包的结构如下：

<em><em><em><code>a
├── b
│   ├── c.py
│   └── <strong>init</strong>.py
└── <strong>init</strong>.py</code></em></em></em>

在包一中，文件的内容都为：c.py，init.py，init.py

<em><em><em><code class="language-python">print(<strong>name</strong>)</code></em></em></em>

当一个文件的.py（模块）被其他的.py文件（模块）导入时，我们在命令行执行

<em><em><em><code class="language-shell">python -c "import a.b.c"</code></em></em></em>

输出结果：

<em><em><em><code>a
a.b
a.b.c</code></em></em></em>

由此可见，name可以清晰地反映一个模块在包中的层次。

3.2 `name`表示当前模块的名字

name是内置变量，可用于表示当前模块的名字。我们直接运行一个的.py文件（模块）

<em><em><em><code>python a/b/c.py</code></em></em></em>

输出结果：

<em><em><em><code><strong>main</strong></code></em></em></em>

由此我们可知：如果一个的.py文件（模块）被直接运行时，则其没有包结构，其name值为main，即模块名为main。

所以，的意思是：当的.py文件被直接运行时，之下的代码块将被运行;当的.py文件以模块形式被导入时，之下的代码块不被运行。if name == 'main'if name == 'main'if name == 'main'

4. `main.py`文件与`python -m`

Python中的-m参数用于将一个模块或者包作为一个脚本运行，而main.py文件相当于是一个包的“入口程序“。

4.1运行Python程序的两种方式

python xxx.py，直接运行xxx.py文件
python -m xxx.py，把xxx.py当做模块运行

假设我们有一个文件run.py，内容如下：

<em><em><em><code>import sys

print(sys.path)</code></em></em></em>

我们用直接运行的方式启动

<em><em><em><code>python run.py</code></em></em></em>

输出结果（为了说明问题，输出结果只截取了重要部分，下同）：

<em><em><em><code>['/home/huoty/aboutme/pythonstudy/main', ...]</code></em></em></em>

然后以模块的方式运行：

<em><em><em><code class="language-shell">python -m run.py</code></em></em></em>

输出内容

<em><em><em><code>['', ...]
/usr/bin/python: No module named run.py</code></em></em></em>

由于输出结果只列出了关键的部分，应该很容易看出他们之间的差异：

直接运行方式是把run.py文件所在的目录放到了sys.path的属性中
以模块方式运行是把你输入命令的目录（也就是当前工作路径），放到了sys.path属性中。

以模块方式运行还有一个不同的地方：多出了一行No module named run.py。的错误实际上以模块方式运行时，巨蟒先对run.py执行一遍进口，所以print(sys.path)被成功执行，然后Python中才尝试运行run.py模块，但是在路径变量中并没有run.py这个模块，所以报错。正确的运行方式，应该是python -m run。

4.2 `main.py`的作用

仍然先看例子，假设我们有如下一个包封装：

<em><em><em><code>package
├── <strong>init</strong>.py
└── <strong>main</strong>.py</code></em></em></em>

其中，文件init.py的内容

<em><em><em><code>import sys

print("<strong>init</strong>")
print(sys.path)</code></em></em></em>

其中，文件main.py的内容

<em><em><em><code>import sys

print("<strong>main</strong>")
print(sys.path)</code></em></em></em>

接下来，我们运行这个包，使用python -m package运行，输出结果：

<em><em><em><code><strong>init</strong>
['', ...]

<strong>main</strong>
['', ...]</code></em></em></em>

使用python package运行，输出结果：

<em><em><em><code><strong>main</strong>
['package', ...]</code></em></em></em>

总结一下

当加上-m参数时，Python的会把当前工作目录添加到sys.path中中;而不加-m时，Python中则会把脚本所在目录添加到sys.path中中。
当加上-m参数时，巨蟒会先将模块或者包导入，然后再执行。
__main.py文件是一个包或者目录的入口程序。的英文不管用python package还是用python -m package运行，__main.py文件总是被执行。