注: 本文中所有实验都在python3.6下进行

为什么引入这个选项？

python的执行文件中包含一个-m的选项，这种用法最初在python2.4中引入，随后经过PEP338的修改成为现在这种形式。从PEP中我们可以知道该参数出现的目的是帮助我们更方便的执行python库中的脚本，而各种库也可以利用这种方式来提供一些实用的功能。

该参数具体功能是什么？

该选项在python的帮助文档的说明如下:

-m mod : run library module as a script (terminates option list)

即将python库中的模块以脚本的模式运行（并截断选项列表）。说明十分简洁，那这句话到底是什么意思呢？直接执行python aaa/bbb.py 和python -m aaa.bbb又有什么区别呢？下面我们通过一个实验来回答上面的问题。

我们来执行一段简单的实验代码(Github链接)，代码如下：

  1. 总体结构 
     ├── outter.py
 └── package1
     ├── __init__.py
     └── main.py
  2. outter.py 
     def load_outter_method():
     print("outter method excuted")
  3. __init__.py 
     print("package1 loaded")
  4. inner.py: 
     import sys
 # from outter import load_outter_method

 print("module inner loaded")

 if __name__ == "__main__":
     print("module __main__ method excuted")
     print("package name:",__package__)
     print("package name:",__name__)
     print("path",sys.path)

     # load_outter_method()

我们在run-lib-as-script分别通过两种方式执行inner.py

执行 python package1/inner.py的输出:

module inner loaded
module __main__ method excuted
package name: None
package name: __main__
path: ['/Users/twer/PROJECTS/python/python-features/run-lib-as-script/package1', '/Users/twer/anaconda/envs/eminfo_backend/lib/python36.zip', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6/lib-dynload', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6/site-packages']

执行 python -m package1.inner的输出:

package1 loaded
module inner loaded
module __main__ method excuted
package name: package1
package name: __main__
path: ['', '/Users/twer/anaconda/envs/eminfo_backend/lib/python36.zip', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6/lib-dynload', '/Users/twer/anaconda/envs/eminfo_backend/lib/python3.6/site-packages']

从上面两个输出的对比我们可以发现两种执行方式有以下几点不同:

  1. 通过python -m执行一个包内脚本会首先将执行package1的__init__.py文件，并且__package__变量被赋上相应的值；而 python xxx.py方式不会执行__init__.py并且__package__变量为None
  2. 两种执行方法的sys.path不同（注意每个path输出中的第一条），Python中的sys.path是Python用来搜索包和模块的路径。通过python -m执行一个脚本时会将当前路径加入到系统路径中,而使用python xxx.py执行脚本则会将脚本所在文件夹加入到系统路径中（如果取消inner.py中的注释会报找不到模块的错误）。

所以如果是运行自己写的简单脚本，两种运行方式可能没有区别，但是如果运行三方包中的脚本使用python -m会把整个包加入到sys.path中，可以减少引用问题。

python -m 的实现原理

python中有一个叫做runpy的模块，这就是python -m的具体实现（执行python -m modulename等同于运行runpy.run_module(modulename)）。如果想要进一步了解python -m可以阅读该模块源代码。

Python -m 的的实用功能：

  • python -m venv 创建虚拟环境（venv是python3自带的环境管理工具，和virtualenv用法类似）
  • python -m http.server 启动一个http服务器，可以用于文件共享
  • python -m idlelib 启动IDLE，一个python自带可开发环境

更多实用模块脚本可以再这里找到