Python 运行单元测试作为包导入错误

Question

我。前言：post.

末尾列出应用目录结构和模块

二．问题陈述：如果未设置 PYTHONPATH 应用程序运行s，但单元测试失败并显示 ImportError：没有名为 models.transactions 的模块。尝试导入时会发生这种情况 app.py 中的交易。如果 PYTHONPATH 设置为 /sandbox/app 应用程序和 unittest 运行没有错误。解决方案的约束是不必设置 PYTHONPATH，并且 sys.path 不必以编程方式修改。

三。详细信息：考虑设置 PYTHONPATH 并且 test_app.py 是运行作为包 /sandbox$ python -m unittest tests.test_app 的情况。查看 __main__ 的打印语句散落在整个代码中：

 models   :  app.models.transactions
 models   :  models.transactions
 resources:  app.resources.transactions
 app      :  app.app
 test     :  tests.test_app

单元测试首先导入应用程序，因此有 app.models.transactions。接下来导入那个app 尝试次数为 resources.transactions。导入时，它会自己导入 models.transactions，并且然后我们看到 __name__ 对应 app.resources.transactions。接下来是 app.app 导入，最后是单元测试模块 tests.test.app。设置 PYTHONPATH 允许应用程序解析 models.transactions!

一种解决方案是将 models.transactions 放在 resources.transaction 中。但是还有另一种方法来处理这个问题吗？

为了完整性，当应用程序是运行时，__main__ 的打印语句是：

 models   :  models.transactions
 resources:  resources.transactions
 app      :  __main__

这是预料之中的，并且没有尝试在 /sandbox/app 以上或横向导入。

四.附录

A.1目录结构：

|-- sandbox
    |-- app
        |-- models
            |-- __init__.py
            |-- transactions.py 
        |-- resources
            |-- __init__.py
            |-- transactions.py        
        |-- __init__.py
        |-- app.py
    |-- tests
        |-- __init__.py
        |-- test_app.py

A.2 模块：

(1) 应用程序：

from flask import Flask
from models.transactions import TransactionsModel
from resources.transactions import Transactions
print '     app      : ', __name__
def create_app():
    app = Flask(__name__)
    return app
app = create_app()
if __name__ == '__main__':
    app.run(host='127.0.0.1', port=5000, debug=True)

(2) models.transactions

print '     model    : ', __name__
class TransactionsModel:
    pass

(3) resources.transactions:

from models.transactions import TransactionsModel
print '     resources: ', __name__ 
class Transactions:
    pass

(4) tests.test_app

import unittest 
from app.app import create_app
from app.resources.transactions import Transactions   
print '     test     : ', __name__ 
class DonationTestCase(unittest.TestCase):
    def setUp(self):
        pass
    def tearDown(self):
        pass
    def test_transactions_get_with_none_ids(self):
        self.assertEqual(0, 0) 
if __name__ == '__main__':
    unittest.main()

Answer 1

TL;DR：如果可以，您应该更改两个导入：

from models.transactions import TransactionsModel
from resources.transactions import Transactions

到

from app.models.transactions import TransactionsModel
from app.resources.transactions import Transactions

更长的版本

当你说：

If the PYTHONPATH is not set the application runs...

你运行这个应用程序怎么样？我猜是这样的……

cd sandbox/app
python app.py

因为 app.py 中的导入不正确（缺少最顶层的 app 模块）或者运行宁 app 应该同样失败。

IMO 你也不需要（严格地）使 tests 成为一个模块（即，你可以删除 tests/__init__.py）并且只运行测试如下：

python tests/test_app.py

重点是 .（您的当前目录）默认情况下始终包含在 PYTHONPATH 中，并且从那里模块是 loaded/searched 用于导入 - 在这种情况下，当你的测试执行 from app.app import create_app 第一行 app.py:

from models.transactions import TransactionsModel

会报错（没有./modelsmodule/directory）。

如果您无法更改 app.py 应用程序模块中的导入，或者受到其他限制，我能想到的唯一选择（除了修改 PYTHONPATH 或操纵 sys.path，你明确排除），唯一的其他选择是：

cd sandbox/app
python ../tests/test_app.py

但是你必须在你的单元测试中改变你的导入：

from app import create_app
from resources.transactions import Transactions

换句话说，你不能吃你的蛋糕:) 在不更改 Python 查找路径的情况下，您需要让所有模块从同一个位置 (.) 开始，从而保持一致。

Answer 2

前面值得一提的是，Flask文档中说运行将应用程序打包，并设置环境变量：FLASK_APP。然后应用程序从项目根运行s：$ python -m flask run。现在导入将包括应用程序根目录，例如 app.models.transactions。由于 unittest 以相同的方式运行作为项目根目录中的包，所有导入也在那里解析。

问题的关键可以用下面的方式来描述。 test_app.py 需要访问横向导入，但如果它运行像这样的脚本：

/sandbox/test$ python test_app.py

它有 <code>__name__==__main__。这意味着导入，例如 from models.transactions import TransactionsModel，将不会被解析，因为它们是横向的，而不是在层次结构中较低的。要解决此问题，test_app.py 可以运行作为一个包：

/sandbox$ python unittest -m test.test_app

-m 开关告诉 Python 这样做。现在包可以访问 app.model，因为它在 /sandbox 中运行ning。 test_app.py 中的导入必须反映此更改并变成如下内容：

from app.models.transactions import TransactionsModel

要进行测试运行，应用程序中的导入现在必须是相对的。例如，在 app.resources:

from ..models.transactions import TransactionsModel

因此测试运行成功，但如果应用程序运行则失败！这就是问题的症结所在。当应用程序运行作为来自 /sandbox/app$ python app.py 的脚本时，它会遇到此相对导入 ..models.transactions 和 returns 程序试图导入到顶层以上的错误。修复一个，破坏另一个。

如何在不设置 PYTHONPATH 的情况下解决这个问题？一种可能的解决方案是在包 <code>__init__.py 中使用条件来进行条件导入。 resources 包的示例如下：

if __name__ == 'resources':
    from models.transactions import TransactionsModel
    from controllers.transactions import get_transactions
elif __name__ == 'app.resources':
    from ..models.transactions import TransactionsModel
    from ..controllers.transactions import get_transactions

要克服的最后一个障碍是我们如何将其拉入 resources.py。在 <code>__init__.py 中完成的导入绑定到该文件并且对 resources.py 不可用。通常会在 resources.py 中包含以下导入：

import resources

但是，再一次，是 resources 还是 app.resources？对我们来说，困难似乎已经越走越远了。 importlib 提供的工具可以在这里提供帮助，例如以下将进行正确的导入：

from importlib import import_module
import_module(__name__)

还有其他方法可以使用。例如，

TransactionsModel = getattr(import_module(__name__), 'TransactionsModel')

这修复了当前上下文中的错误。

另一个更直接的解决方案是在模块本身中使用绝对导入。例如，在资源中：

models_root = os.path.join(os.path.dirname(__file__), '..', 'models')
fp, file_path, desc = imp.find_module(module_name, [models_root])
TransactionsModel = imp.load_module(module_name, fp, file_path, 
    desc).TransactionsModel
TransactionType = imp.load_module(module_name, fp, file_path, 
    desc).TransactionType

关于使用 sys.path.append(app_root) 更改 PYTHONPATH 的注意事项在 resources.py。这很好用，只需几行代码就可以了。此外，它只更改执行文件的路径并在完成后恢复。似乎是单元测试的一个很好的用例。一个问题可能是当应用程序被移动到不同的环境时。

Python 运行单元测试作为包导入错误

Python Run Unittest as Package Import Error

python

python-import

importerror

python-unittest

pythonpath

Python 运行 单元测试作为包导入错误

Python Run Unittest as Package Import Error

python

python-import

importerror

python-unittest

pythonpath

Python 运行单元测试作为包导入错误