Python 运行 Unittest 作为包导入错误

Question

一、前言：应用程序目录结构和模块列于文末。

二、问题陈述：如果未设置 PYTHONPATH，则应用程序运行，但单元测试失败并显示ImportError: No module named models.transactions。尝试在 app.py 中导入交易时会发生这种情况。如果 PYTHONPATH 设置为/sandbox/appapplication 和 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

unittest 首先导入应用程序，因此有app.models.transactions. 应用程序尝试的下一个导入是resources.transactions. 当它被导入时，它会自己导入models.transactions，然后我们看到__name__for app.resources.transactions。接下来是app.app 导入，最后是 unittest 模块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) 资源.交易：

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

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

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

/sandbox/test$ python test_app.py

它有。这意味着导入（例如）将不会被解析，因为它们是横向的并且不在层次结构中较低的位置。要解决此问题，可以将 test_app.py 作为包运行：__name__==__main__from models.transactions import TransactionsModel

/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) 只是关于使用in更改 PYTHONPATH 的注释resources.py。这工作得很好，并且只需几行代码即可位于需要的位置。此外，它仅更改执行文件的路径并在完成后恢复。似乎是单元测试的一个很好的用例。一个问题可能是应用程序何时移动到不同的环境。