当前位置:首页 > 技术 > 正文内容

Python 中 if __name__ == '__main__' 的含义与用法

访客 技术 2026年6月5日 1

理解 Python 的程序入口

在许多编程语言中,程序都有一个明确的入口点,比如 C/C++ 的 main 函数,或者 Java/C# 中的 Main 方法。然而 Python 作为脚本语言,并不会在运行前编译成二进制文件,而是逐行解释执行。这意味着 Python 脚本的执行从第一行开始,没有强制规定的统一入口。

一个 Python 文件既能被直接执行,也能作为模块被导入其他脚本。无论是哪种情况,文件的顶层代码(即不在函数或类内部的代码)都会被运行。但在导入时,我们往往不希望执行某些特定代码,比如测试代码。

问题示例

假设我们有一个 const.py 文件,定义了一些常量和一个测试函数:

PI = 3.14

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

main()

直接运行 const.py 会输出 PI: 3.14

现在,我们创建 area.py 来计算圆的面积,需要导入 const.py 中的 PI:

from const import PI

def calc_round_area(radius):
    return PI * (radius ** 2)

def main():
    print("round area:", calc_round_area(2))

main()

运行 area.py 后,我们会看到:

PI: 3.14
round area: 12.56

这里,const.py 中的 main 函数也被执行了,这显然不是我们想要的。为了解决这个问题,可以使用 if __name__ == '__main__'

PI = 3.14

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

if __name__ == "__main__":
    main()

修改后,运行 area.py 只会输出 round area: 12.56,而直接运行 const.py 依然会输出 PI: 3.14

这段代码相当于为 Python 提供了一个"模拟入口"。它并非语言强制,而是一种广泛使用的编码习惯,用于区分文件是直接执行还是被导入。

__name__ 变量的作用

__name__ 是 Python 的内置变量,表示当前模块的名称。它还能反映模块在包中的结构。例如,我们有包结构如下:

a/
├── b/
│   ├── c.py
│   └── __init__.py
└── __init__.py

如果每个 .py 文件都包含 print(__name__),那么执行 python -c "import a.b.c" 会输出:

a
a.b
a.b.c

这说明 __name__ 清晰地显示出模块在包中的层次,也就是 import 语句中使用的名字。

当模块被直接运行时,它没有包层级,此时 __name__ 被设置为 __main__。例如直接运行 python a/b/c.py,输出会是:

__main__

因此,if __name__ == '__main__' 的核心逻辑是:如果模块直接被运行,则执行该代码块;如果被导入,则不执行

__main__.py 文件与 python -m 参数

这个问题还涉及到 __main__.py 和 Python 的 -m 参数。它们用于将包或模块作为脚本运行。

python xxx.py 与 python -m xxx.py 的区别

直接运行和以模块方式运行的行为有所不同。假设 run.py 内容如下:

import sys
print(sys.path)

直接运行 python run.py 的输出(简化):

['/path/to/script/directory', ...]

而以模块方式运行 python -m run.py 的输出:

['', ...]
/usr/bin/python: No module named run.py

区别在于:直接运行会将脚本所在目录加入 sys.path;而 -m 参数则将当前工作目录加入 sys.path,并且会先对模块执行 import 操作,然后再尝试运行。上面的错误是因为 run.py 并不是一个有效的模块名(应该用 python -m run)。

__main__.py 的作用

考虑以下包结构:

package/
├── __init__.py
└── __main__.py

__init__.py 内容:

import sys
print("__init__")
print(sys.path)

__main__.py 内容:

import sys
print("__main__")
print(sys.path)

使用 python -m package 运行会输出:

__init__
['', ...]
__main__
['', ...]

使用 python package 运行则会输出:

__main__
['package', ...]

总结如下:

  • 使用 -m 参数时,当前工作目录会被加入 sys.path;不使用时,则加入脚本所在目录。
  • 使用 -m 时,Python 会先导入模块或包,再执行。
  • __main__.py 是包或目录的入口程序,无论使用 python package 还是 python -m package,它都会被执行。

希望本文能帮助您深入理解 if __name__ == '__main__' 的用法及其背后的机制。Python 虽然简洁,却蕴含许多精巧的设计,掌握这些惯用法有助于写出更加优雅和实用的代码。

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。