Python运行Unittest作为包导入错误

Question

I.前言：应用程序目录结构和模块列在帖子的末尾。

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

III。详细信息：考虑设置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__为app.resources.transactions。接下来是app.app导入，然后是unittest模块tests.test.app。设置PYTHONPATH允许应用程序解析models.transactions！

一种解决方案是将models.transactions放入resources.transaction。但还有另一种方法可以解决这个问题吗？

为了完整起见，在运行应用程序时，__main__的print语句是：

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

这是预期的，并没有尝试进口高于/sandbox/app或横向进口。

IV。附录

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）app：

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

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

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

/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)用resources.py改变PYTHONPATH的注释。这很好用，并且只需要几行代码就可以了。此外，它仅更改执行文件的路径并在完成时还原。似乎是unittest的一个很好的用例。一个问题可能是应用程序移动到不同的环境。

Answer 2

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查找路径的情况下，你需要让所有模块从同一个地方（.）开始，从而保持一致。