我三年前写过一篇文章:《小问题大隐患:如何正确设置 Python 项目的入口文件?》。讲到Python项目应该如何正确组织代码结构。入口文件应该在最外面,调用关系应该是从外向内调用。而不要学Java,从一个很深层的文件夹里面往外调用。

不过我在这篇文章的最后,也提到了一种例外情况,那就是工具脚本不受这个规则的限制。如下图所示。

今天有同学在问我,这种情况应该怎么调用,才能让remove_outdated_data.py正确导入models里面的模块。我们今天就来说明一下。

首先,我们来创建一个示例程序,结构如下图所示:

其中,aa.py文件的内容为:

1
2
def i_am_func():
print('我是一个函数')

test.py文件的内容为:

1
2
3
4
from models.aa import i_am_func


i_am_func()

那么,不修改任何环境变量,也不修改sys.path的情况下,我应该怎么运行test.py,才能让它正确调用i_am_func函数?

首先我们进入tools文件夹运行,显然会报错,如下图所示:

接下来,我们在项目根目录下面运行,也会报错:

那应该怎么办呢?难道必须加环境变量或者改sys.path

其实,Python已经自带了正确运行工具脚本的方法,就是-m参数。我们只需要在项目根目录执行下面这个命令就可以了:

1
python -m tools.test

如下图所示:

如果工具脚本在很深的文件夹里面,那么路径只需要使用点分割就可以了。例如下面的文件结构:


要运行second.py,那么命令就写成:

1
python -m tools.deep.folder.second

如果你的工具脚本有参数,也可以正常添加,例如:

1
python -m tools.deep.folder.second args1 args2