予。前言:应用程序目录结构和模块列在帖子的末尾。
II。问题陈述:如果没有设置PYTHONPATH应用程序运行,但单元测试失败,出现 ImportError:No module names.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__
的{{1}}。接下来是app.resources.transactions
导入,最后是unittest模块app.app
。设置PYTHONPATH允许应用程序解析models.transactions!
一种解决方案是将tests.test.app
放在models.transactions
内。但还有另一种方法可以解决这个问题吗?
为了完整性,在运行应用程序时,resources.transaction
的打印语句为:
__main__
这是预期的,并且没有尝试高于 models : models.transactions
resources: resources.transactions
app : __main__
或横向的进口。
IV。附录
A.1目录结构:
/sandbox/app
A.2模块:
(1)app:
|-- sandbox
|-- app
|-- models
|-- __init__.py
|-- transactions.py
|-- resources
|-- __init__.py
|-- transactions.py
|-- __init__.py
|-- app.py
|-- tests
|-- __init__.py
|-- test_app.py
(2)models.transactions
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)
(3)resources.transactions:
print ' model : ', __name__
class TransactionsModel:
pass
(4)tests.test_app
from models.transactions import TransactionsModel
print ' resources: ', __name__
class Transactions:
pass
答案 0 :(得分:3)
值得一提的是Flask文档说要将应用程序作为包运行,并设置环境变量:FLASK_APP
。然后,应用程序从项目根目录$ python -m flask run
运行。现在导入将包括应用程序根目录,例如app.models.transactions
。由于unittest以相同的方式运行,作为项目根目录中的包,所有导入也都在那里解析。
问题的关键可以用以下方式描述。 test_app.py需要访问sideways导入,但是如果它像以下脚本一样运行:
/sandbox/test$ python test_app.py
它有
。这意味着导入(例如__name__
==__main__
__name__
)将无法解析,因为它们是横向的而不是层次结构中的低级。要解决此问题,test_app.py可以作为包运行:
__main__
from models.transactions import TransactionsModel
开关告诉Python这样做。现在,该软件包可以访问/sandbox$ python unittest -m test.test_app
,因为它正在-m
中运行。 app.model
中的导入必须反映此更改,并变为:
/sandbox
要进行测试运行,应用程序中的导入现在必须是相对的。例如,在app.resources:
test_app.py
因此测试成功运行,但如果应用程序运行则失败!这是问题的症结所在。当应用程序作为脚本从from app.models.transactions import TransactionsModel
运行时,它会命中此相对导入from ..models.transactions import TransactionsModel
,并返回程序尝试导入顶层以上的错误。修复一个,打破另一个。
如何在不设置PYTHONPATH的情况下解决这个问题?一种可能的解决方案是使用包/sandbox/app$ python app.py
中的条件来进行条件导入。 ..models.transactions
包的外观示例如下:
__init__
.py
要克服的最后一个障碍是我们如何将其拉入__init__
。 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
但是,又是__init__
还是resources.py
?对我们来说,似乎困难刚刚进一步发展。 resources.py
提供的工具可以在这里提供帮助,例如以下内容将正确导入:
import resources
还可以使用其他方法。例如,
resources
这解决了当前环境中的错误。
另一个更直接的解决方案是在模块本身中使用绝对导入。例如,在资源中:
app.resources
关于用importlib
更改PYTHONPATH的说明
在from importlib import import_module
import_module(__name__)
。这很好用,并且只需要几行代码就可以了。此外,它仅更改执行文件的路径并在完成时还原。似乎是unittest的一个很好的用例。一个问题可能是应用程序移动到不同的环境。
答案 1 :(得分: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
或操纵{{1}之外) },你明确排除了),唯一的另一个选择是:
sys.path
但是您必须在单元测试中更改您的导入:
cd sandbox/app
python ../tests/test_app.py
换句话说,你不能吃蛋糕并吃掉它:)
在不更改Python查找路径的情况下,您需要让所有模块从同一个地方(from app import create_app
from resources.transactions import Transactions
)开始,从而保持一致。