对于一个简单的Python模块来说，非常常见的目录结构似乎是将单元测试分离到它们自己的测试目录中:
new_project/
antigravity/
antigravity.py
test/
test_antigravity.py
setup.py
etc.
我的问题很简单，实际运行测试的通常方式是什么?我怀疑这对每个人来说都是显而易见的，除了我，但你不能只是从测试目录运行python test_antigravity.py，因为它的导入antigravity将失败，因为模块不在路径上。
我知道我可以修改PYTHONPATH和其他与搜索路径相关的技巧，但我不能相信这是最简单的方法——如果您是开发人员，这很好，但如果用户只是想检查测试是否通过，那么期望他们使用这种方法是不现实的。
另一种替代方法是将测试文件复制到另一个目录中，但这似乎有点愚蠢，并且没有注意到将它们放在一个单独的目录中。
那么，如果您刚刚下载源代码到我的新项目，您将如何运行单元测试?我更喜欢这样的答案:“要运行单元测试，请执行x。”
当前回答
如果你使用VS Code，并且你的测试与你的项目位于同一级别，那么运行和调试你的代码就不能开箱即用。你能做的就是改变启动方式。json文件:
{
"version": "0.2.0",
"configurations": [
{
"name": "Python",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "${config:python.pythonPath}",
"program": "${file}",
"cwd": "${workspaceRoot}",
"env": {},
"envFile": "${workspaceRoot}/.env",
"debugOptions": [
"WaitOnAbnormalExit",
"WaitOnNormalExit",
"RedirectOutput"
]
}
]
}
这里的关键行是envFile
"envFile": "${workspaceRoot}/.env",
在项目的根目录中添加.env文件
在.env文件中添加项目根目录的路径。这将临时添加
PYTHONPATH = C: \ \ PYTHON项目\ \ ROOT_DIRECTORY
路径到你的项目，你将能够使用调试单元测试从VS Code
其他回答
如果您正在寻找命令行解决方案:
基于以下目录结构(使用专用源目录进行概括):
new_project/
src/
antigravity.py
test/
test_antigravity.py
Windows:(在new_project中)
$ set PYTHONPATH=%PYTHONPATH%;%cd%\src
$ python -m unittest discover -s test
如果您想在批for循环中使用此语句，请参阅此问题。
Linux:(在new_project中)
$ export PYTHONPATH=$PYTHONPATH:$(pwd)/src [I think - please edit this answer if you are a Linux user and you know this]
$ python -m unittest discover -s test
使用这种方法，还可以在必要时向PYTHONPATH添加更多目录。
这种方式将允许您从任何您想要的地方运行测试脚本，而不会从命令行中破坏系统变量。
这将把主项目文件夹添加到python路径中，其位置相对于脚本本身，而不是相对于当前工作目录。
import sys, os
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
将其添加到所有测试脚本的顶部。这将把主项目文件夹添加到系统路径中，因此从那里导入的任何模块现在都可以工作了。你在哪里做测试并不重要
显然，您可以更改project_path_hack文件以匹配您的主项目文件夹位置。
如果在测试目录中有多个目录，则必须向每个目录添加__init__.py文件。
/home/johndoe/snakeoil
└── test
├── __init__.py
└── frontend
└── __init__.py
└── test_foo.py
└── backend
└── __init__.py
└── test_bar.py
然后一次运行所有测试，运行:
python -m unittest discover -s /home/johndoe/snakeoil/test -t /home/johndoe/snakeoil
来源:python -m unittest -h
-s START, --start-directory START
Directory to start discovery ('.' default)
-t TOP, --top-level-directory TOP
Top level directory of project (defaults to start
directory)
项目中的单元测试有setup.py文件。试一试:
python3 setup.py build
and
python3 setup.py develop --user
做配置路径之类的工作。试一试!
同样的问题我已经有很长时间了。我最近选择的目录结构是这样的:
project_path
├── Makefile
├── src
│ ├── script_1.py
│ ├── script_2.py
│ └── script_3.py
└── tests
├── __init__.py
├── test_script_1.py
├── test_script_2.py
└── test_script_3.py
在test文件夹的__init__.py脚本中，我写了以下内容:
import os
import sys
PROJECT_PATH = os.getcwd()
SOURCE_PATH = os.path.join(
PROJECT_PATH,"src"
)
sys.path.append(SOURCE_PATH)
对于共享项目来说，Makefile非常重要，因为它强制正确地运行脚本。下面是我放在Makefile中的命令:
run_tests:
python -m unittest discover .
The Makefile is important not just because of the command it runs but also because of where it runs it from. If you would cd in tests and do python -m unittest discover ., it wouldn't work because the init script in unit_tests calls os.getcwd(), which would then point to the incorrect absolute path (that would be appended to sys.path and you would be missing your source folder). The scripts would run since discover finds all the tests, but they wouldn't run properly. So the Makefile is there to avoid having to remember this issue.
我真的很喜欢这种方法，因为我不需要触及我的src文件夹，我的单元测试或我的环境变量，一切都运行顺利。
