Python 运行 Unittest 作为包导入错误

Question

我。前言：应用目录结构和模块在文末列出。

二。问题陈述：如果未设置 PYTHONPATH 应用程序运行，但单元测试失败并出现 ImportError: No module named 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。该应用程序的下一个导入 尝试是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) 模型.事务

print '     model    : ', __name__
class TransactionsModel:
    pass

(3) 资源.事务：

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

(4) 测试.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

加长版

当你说：

如果未设置 PYTHONPATH 应用程序运行...

您如何运行该应用程序？ 我猜是……

cd sandbox/app
python app.py

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

IMO，您也不需要（严格地）将 tests 设为模块（即，您可以删除 tests/__init__.py），只需按以下方式运行测试：

python tests/test_app.py

重点是.（您的当前目录）始终默认包含在PYTHONPATH 中，并且从那里加载/搜索模块以查找导入 - 在这种情况下，当您的测试执行时from app.app import create_app app.py中的第一行：

from models.transactions import TransactionsModel

会导致错误（没有./models模块/目录）。

如果您无法更改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。然后应用程序从项目根目录运行：$ python -m flask run。现在导入将包括应用程序根目录，例如app.models.transactions。由于单元测试以相同的方式运行，因此作为项目根目录中的一个包，所有导入也都在那里解析。

问题的症结可以用以下方式描述。 test_app.py 需要访问横向导入，但如果它作为脚本运行，例如：

/sandbox/test$ python test_app.py

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

/sandbox$ python unittest -m test.test_app

-m 开关告诉 Python 这样做。现在包可以访问app.model，因为它在/sandbox 中运行。 test_app.py 中的导入必须反映这种变化，并变为：

from app.models.transactions import TransactionsModel

为了使测试运行，应用程序中的导入现在必须是相对的。例如，在 app.resources 中：

from ..models.transactions import TransactionsModel

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

如何在不设置 PYTHONPATH 的情况下解决这个问题？一个可能的解决方案是在包__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。在__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。这很好用，只需几行代码就可以放在需要的地方。此外，它只会更改执行文件的路径，并在完成后恢复。似乎是单元测试的一个很好的用例。一个问题可能是当应用程序移动到不同的环境时。