python -m是拿来干啥用的?

最近看一个project(FCOS)的时候看到一个命令行参数:python -m。就报着好奇心,想要把它搞明白。
其中很多博客都转载这一篇:[python]自问自答:python -m参数?,但是经过测试后,只适用于python2.x的环境下,对于现在大家都用python3了,里面有点不太正确(但不否定全部)。这里总结一下自己的试验:

实验环境

Ubuntu 18.04.1 LTS + python3.7

例子

我有这么一个文件结构:

├── try_demo
│   ├── package1
│   │   ├── __init__.py
│   │   ├── module1.py
│   ├── package2
│   │   ├── __init__.py
│   │   ├── module2.py

里面的内容是:

  • 两个init.py都是空的
  • module1.py:
import sys
print("module1 is running!")
print("module1 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))
  • module2.py:
import sys
print("module2 is running!")
print("module2 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))

从下面这句话可以看出,-m这个命令行参数就是像运行一个脚本一样运行模块:
-m mod : run library module as a script (terminates option list)
所以我们试验一下(注意,既然是运行模块,就不要有.py后缀):

  1. 没有-m参数
(base) lsm@lsm:~/文档/try_demo$ python package2/module2.py
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文档/try_demo/package2
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文档/FCOS
  1. 带-m参数
(base) lsm@lsm:~/文档/try_demo$ python -m package2.module2
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文档/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文档/FCOS

可以看到,除了调用方式不一样之外,sys.path也不一样:

  • try_demo目录下调用python package2/module2.py时得到:/home/lsm/文档/try_demo/package2
  • try_demo目录下调用python -m package2.module2时得到:/home/lsm/文档/try_demo

可以看到,不带-m参数时是把当前模块module2.py目录.../try_demo/package2添加到sys.path中,而-m参数时是把当前包package2目录.../try_demo添加到sys.path
<font face="微软雅黑" color=#FF8C00 size=6> 然鹅这有什么用呢 </font>

改进例子

我在module2.py的第二行加一句话,就能体会出作用:

import sys
from package1 import module1
print("module2 is running!")
print("module2 __name__ is:", __name__)
print("now sys.path is:")
print('\n'.join(sys.path))

再来看一下两种情况下的输出:

  1. 没有-m参数
(base) lsm@lsm:~/文档/try_demo$ python package2/module2.py
Traceback (most recent call last):
  File "package2/module2.py", line 2, in <module>
    from package1 import module1
ModuleNotFoundError: No module named 'package1'
  1. 带-m参数
(base) lsm@lsm:~/文档/try_demo$ python -m package2.module2
module1 is running!
module1 __name__ is: package1.module1
now sys.path is:
/home/lsm/文档/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文档/FCOS
module2 is running!
module2 __name__ is: __main__
now sys.path is:
/home/lsm/文档/try_demo
/home/lsm/miniconda3/lib/python37.zip
/home/lsm/miniconda3/lib/python3.7
/home/lsm/miniconda3/lib/python3.7/lib-dynload
/home/lsm/miniconda3/lib/python3.7/site-packages
/home/lsm/文档/FCOS

其实这个结果也是我们意料之内的,因为python解释器在导入import的时候会去搜索sys.path下的模块,当不带-m参数时,sys.path只包括到/home/lsm/文档/try_demo/package2,当然不知道还有一个package1,而当-m参数时,sys.path能包括到/home/lsm/文档/try_demo,此时package1就在/home/lsm/文档/try_demo下呀

至此可以总结出-m能给我们的好处是:已知一个模块的名字,但不知道它的文件路径,那么使用“-m”就意味着交给解释器自行查找,在所有模块命名空间中查找,定位到脚本的路径,则当成脚本执行。

拓展(expansion)

“-m”之后也可以直接接一个包的名字,那么解释器经过前面提到的查找过程,先定位到该包,但是会去执行它的__main__子模块,也就是说,在包目录下必须要实现一个__main__.py文件。
换句话说,假设有个包的名称是“packname”,那么,“python -m packname”,其实就等效于python -m packname.__main__

赶紧试验一下是不是:

  1. 在package1下没有main.py文件
(base) lsm@lsm:~/文档/try_demo$ python -m package1
/home/lsm/miniconda3/bin/python: No module named package1.__main__; 'package1' is a package and cannot be directly executed
  1. 在package1下有main.py文件,里面只写print("this is package1.__main__")这一句话
(base) lsm@lsm:~/文档/try_demo$ python -m package1
this is package1.__main__

TODO

眼尖的小伙伴都已经看出来了在改进例子中的运行带-m参数的命令时,出现了:
module1 __name__ is: package1.module1,不再是__main__,这个下次再查查为什么?我想跟大家都在用的用法:__name__ == '__main__'有关联吧?

参考(references)

Python 中 -m 的典型用法、原理解析与发展演变
官方文档对于-m介绍
官方文档对于Executing modules as scripts的介绍

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容