我在使用Django时经常遇到这种情况，因为很多功能都是从manage.py脚本执行的，但我也想让我的一些模块也可以直接作为脚本运行（理想情况下，你可以让它们成为manage.py指令，但我们还没有）。

这是这样一个项目可能看起来的模型；

├── dj_app
│   ├── models.py
│   ├── ops
│   │   ├── bar.py
│   │   └── foo.py
│   ├── script.py
│   ├── tests.py
│   ├── utils.py
│   └── views.py
└── manage.py

这里的重要部分是manage.py、dj_app/script.py和dj_app/tests.py。我们还有子模块dj_app/ops/bar.py和dj_app/ops/foo.py，它们包含了我们希望在整个项目中使用的更多项目。

问题的根源通常是希望您的dj_app/script.py脚本方法在dj_app/tests.py中包含测试用例，当您运行manage.py测试时会调用这些测试用例。

这是我如何设置项目及其导入的；

# dj_app/ops/foo.py
# Foo operation methods and classes
foo_val = "foo123"

.

# dj_app/ops/bar.py
# Bar operations methods and classes
bar_val = "bar123"

.

# dj_app/script.py
# script to run app methods from CLI

# if run directly from command line
if __name__ == '__main__':
    from ops.bar import bar_val
    from ops.foo import foo_val

# otherwise
else:
    from .ops.bar import bar_val
    from .ops.foo import foo_val

def script_method1():
    print("this is script_method1")
    print("bar_val: {}".format(bar_val))
    print("foo_val: {}".format(foo_val))


if __name__ == '__main__':
    print("running from the script")
    script_method1()

.

# dj_app/tests.py
# test cases for the app
# do not run this directly from CLI or the imports will break
from .script import script_method1
from .ops.bar import bar_val
from .ops.foo import foo_val 

def main():
    print("Running the test case")
    print("testing script method")
    script_method1()

if __name__ == '__main__':
    print("running tests from command line")
    main()

.

# manage.py
# just run the test cases for this example
import dj_app.tests
dj_app.tests.main()

.

从manage.py运行测试用例；

$ python3 manage.py
Running the test case
testing script method
this is script_method1
bar_val: bar123
foo_val: foo123

自行运行脚本；

$ python3 dj_app/script.py
running from the script
this is script_method1
bar_val: bar123
foo_val: foo123

请注意，如果尝试直接运行test.py，则会出现错误，因此不要这样做；

$ python3 dj_app/tests.py
Traceback (most recent call last):
  File "dj_app/tests.py", line 5, in <module>
    from .script import script_method1
ModuleNotFoundError: No module named '__main__.script'; '__main__' is not a package

如果我遇到了更复杂的进口情况，我通常会执行这样的操作来破解它；

import os
import sys
THIS_DIR = os.path.dirname(os.path.realpath(__file__))
sys.path.insert(0, THIS_DIR)
from script import script_method1
sys.path.pop(0)

不幸的是，这个模块需要在包中有时需要作为脚本运行。知道我怎么做吗实现这一目标？

这样的布局很常见。。。

main.py
mypackage/
    __init__.py
    mymodule.py
    myothermodule.py

…有一个mymodule.py像这样。。。

#!/usr/bin/env python3

# Exported function
def as_int(a):
    return int(a)

# Test function for module  
def _test():
    assert as_int('1') == 1

if __name__ == '__main__':
    _test()

…一个肌肉热模块。。。

#!/usr/bin/env python3

from .mymodule import as_int

# Exported function
def add(a, b):
    return as_int(a) + as_int(b)

# Test function for module  
def _test():
    assert add('1', '1') == 2

if __name__ == '__main__':
    _test()

…还有一个像这样的男人。。。

#!/usr/bin/env python3

from mypackage.myothermodule import add

def main():
    print(add('1', '1'))

if __name__ == '__main__':
    main()

…当您运行main.py或mypackage/mymodule.py时，它工作得很好，但由于相对导入，mypackage/myothermodule.py失败。。。

from .mymodule import as_int

你应该用的方式是。。。

python3 -m mypackage.myothermodule

……但它有些冗长，与#/usr/bin/env python3。

对于这种情况，最简单的解决方法是避免使用相对导入，而只使用。。。

from mymodule import as_int

…虽然，如果它不是唯一的，或者您的包结构更复杂，您需要在PYTHONPATH中包含包含您的包目录的目录，并这样做。。。

from mypackage.mymodule import as_int

…或者如果你想让它“开箱即用”，你可以先用这个。。。

import sys
import os

SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
sys.path.append(os.path.dirname(SCRIPT_DIR))

from mypackage.mymodule import as_int

这是一种痛苦，但有一个线索，为什么在一封由某个Guido van Rossum写的电子邮件中。。。

我对这件事和任何其他提议的无聊事都持反对态度__机械唯一的用例似乎是运行发生的脚本生活在模块的目录中，我一直认为反模式。要让我改变主意，你必须说服我它不是。

在包中运行脚本是否是反模式是主观的，但就我个人而言，我发现它在包含一些自定义wxPython小部件的包中非常有用，因此我可以为任何源文件运行脚本，以显示仅包含该小部件的wx.Frame，用于测试目的。

我在尝试编写一个可以作为模块或可执行脚本加载的python文件时遇到了类似的问题。

安装程序

/path/to/project/
├── __init__.py
└── main.py
    └── mylib/
        ├── list_util.py
        └── args_util.py

具有：

main.py：

#!/usr/bin/env python3
import sys
import mylib.args_util

if __name__ == '__main__':
    print(f'{mylib.args_util.parseargs(sys.argv[1:])=}')

mylib/list_util.py：

def to_int_list(args):
    return [int(x) for x in args]

mylib/args_util.py：

#!/usr/bin/env python3
import sys
from . import list_util as lu

def parseargs(args):
    return sum(lu.to_int_list(args))

if __name__ == '__main__':
    print(f'{parseargs(sys.argv[1:])=}')

输出

$ ./main.py 1 2 3
mylib.args_util.parseargs(sys.argv[1:])=6

$ mylib/args_util.py 1 2 3
Traceback (most recent call last):
  File "/path/to/project/mylib/args_util.py", line 10, in <module>
    from . import list_util as lu
ImportError: attempted relative import with no known parent package

解决方案

我决定使用Bash/Python多语言解决方案。Bash版本的程序只调用python3-m mylib.args_util，然后退出。

Python版本忽略Bash代码，因为它包含在docstring中。

Bash版本忽略Python代码，因为它使用exec停止解析/运行行。

mylib/args_util.py：

#!/bin/bash
# -*- Mode: python -*-
''''true
exec /usr/bin/env python3 -m mylib.args_util "$@"
'''

import sys
from . import list_util as lu

def parseargs(args):
    return sum(lu.to_int_list(args))

if __name__ == '__main__':
    print(f'{parseargs(sys.argv[1:])=}')

输出

$ ./main.py 1 2 3
mylib.args_util.parseargs(sys.argv[1:])=6

$ mylib/args_util.py 1 2 3
parseargs(sys.argv[1:])=6

解释

第1行：#/bin/bash；这是“shebang”线；它告诉交互式shell如何运行该脚本。Python:忽略（注释）Bash：忽略（注释）第2行：#-*-模式：python-*-可选；这被称为“模式线”；它告诉Emacs使用Python语法高亮显示，而不是在读取文件时猜测语言是Bash。Python:忽略（注释）Bash：忽略（注释）第3行：“”“truePython:将其视为以“true”开头的未分配文档字符串\nBash：将其视为三个扩展为true的字符串（其中前两个是空字符串）（即“+”+“true”=“true”）；然后它运行为true（它什么都不做）并继续到下一行第4行：exec/usr/bin/env python3-m mylib.args_util“$@”Python：仍然将其视为第3行中文档字符串的一部分。Bash：运行python3-m mylib.args_util，然后退出（它不会分析超出这一行的任何内容）第5行：“”Python：将其视为第3行中文档字符串的结尾。Bash：不解析此行

注意事项

这在Windows上不起作用：解决方法：使用WSL或批处理包装脚本调用python-m mylib.args_util。仅当当前工作目录设置为/path/to/project/时，此操作才有效。解决方法：调用/usr/bin/env时设置PYTHONPATH#!/bin/bash#-*-模式：python-*-“”“真的执行/usr/bin/env python3\PYTHONPATH=“$（cd”$（dirname“$0”）/。。“；pwd）”\-m mylib.args_util“$@”'''

这是我的项目结构

├── folder
|   | 
│   ├── moduleA.py
|   |   |
|   |   └--function1()
|   |       └~~ uses function2()
|   | 
│   └── moduleB.py
|       | 
|       └--function2()
|   
└── main.py
     └~~ uses function1()

这里我的模块A导入模块B，主导入模块A

我在模块A中添加了下面的代码段以导入模块B

try:
    from .moduleB import function2 
except:
    from moduleB import function2 

现在我可以单独执行main.py和moduleA.py

这是解决方案吗？

如果两个包都在您的导入路径（sys.path）中，并且您想要的模块/类在example.example.py中，那么要访问该类而不进行相对导入，请尝试：

from example.example import fkt

我的样板，以使包中的模块具有可独立运行的相对导入。

包/模块.py

## Standalone boilerplate before relative imports
if __package__ is None:                  
    DIR = Path(__file__).resolve().parent
    sys.path.insert(0, str(DIR.parent))
    __package__ = DIR.name

from . import variable_in__init__py
from . import other_module_in_package
...

现在，您可以以任何方式使用模块：

照常运行模块：python-m package.module将其用作模块：python-c“来自包导入模块”独立运行：python package/module.py或者使用shebang（#！/bin/env-python）：package/module.py

NB！如果模块与包同名，则使用sys.path.append而不是sys.path.insert将导致难以跟踪的错误。例如my_script/my_script.py

当然，如果您的包层次结构中有较高级别的相对导入，那么这是不够的，但在大多数情况下，这是可以的。