对于一个简单的Python模块来说，非常常见的目录结构似乎是将单元测试分离到它们自己的测试目录中:
new_project/
antigravity/
antigravity.py
test/
test_antigravity.py
setup.py
etc.
我的问题很简单，实际运行测试的通常方式是什么?我怀疑这对每个人来说都是显而易见的，除了我，但你不能只是从测试目录运行python test_antigravity.py，因为它的导入antigravity将失败，因为模块不在路径上。
我知道我可以修改PYTHONPATH和其他与搜索路径相关的技巧，但我不能相信这是最简单的方法——如果您是开发人员，这很好，但如果用户只是想检查测试是否通过，那么期望他们使用这种方法是不现实的。
另一种替代方法是将测试文件复制到另一个目录中，但这似乎有点愚蠢，并且没有注意到将它们放在一个单独的目录中。
那么，如果您刚刚下载源代码到我的新项目，您将如何运行单元测试?我更喜欢这样的答案:“要运行单元测试，请执行x。”
从你链接的文章中:
Create a test_modulename.py file and put your unittest tests in it. Since the test modules are in a separate directory from your code, you may need to add your module’s parent directory to your PYTHONPATH in order to run them: $ cd /path/to/googlemaps $ export PYTHONPATH=$PYTHONPATH:/path/to/googlemaps/googlemaps $ python test/test_googlemaps.py Finally, there is one more popular unit testing framework for Python (it’s that important!), nose. nose helps simplify and extend the builtin unittest framework (it can, for example, automagically find your test code and setup your PYTHONPATH for you), but it is not included with the standard Python distribution.
也许你应该像它所暗示的那样看看鼻子?
如果你运行“python setup.py develop”，那么包就会在路径中。但你可能不想这样做，因为你可能会感染你的系统python安装，这就是virtualenv和buildout等工具存在的原因。
对于用户来说，最简单的解决方案是提供一个可执行脚本(runtests.py或类似的脚本)，该脚本引导必要的测试环境，包括(如果需要的话)将根项目目录添加到sys. py。临时道路。这并不需要用户设置环境变量，类似这样的东西在引导脚本中工作得很好:
import sys, os
sys.path.insert(0, os.path.dirname(__file__))
然后你给用户的指令可以像“python runtests.py”一样简单。
当然，如果你需要的路径确实是os.path.dirname(__file__)，那么你不需要将它添加到sys. path.dirname(__file__)。道路;Python总是将当前运行脚本的目录放在sys. exe的开头。路径，因此根据您的目录结构，将runtests.py定位到正确的位置可能就足够了。
此外，Python 2.7+中的unittest模块(在Python 2.6及更早的版本中被反向移植为unittest2)现在内置了测试发现，所以如果你想自动化测试发现，nose不再是必要的:你的用户指令可以像Python -m unittest discover一样简单。
我通常在项目目录中创建一个“运行测试”脚本(对于源目录和测试都是通用的)，用于加载我的“所有测试”套件。这通常是样板代码，所以我可以在项目之间重用它。
run_tests.py:
import unittest
import test.all_tests
testSuite = test.all_tests.create_test_suite()
text_runner = unittest.TextTestRunner().run(testSuite)
test/all_tests.py(来自如何在一个目录中运行所有Python单元测试?)
import glob
import unittest
def create_test_suite():
test_file_strings = glob.glob('test/test_*.py')
module_strings = ['test.'+str[5:len(str)-3] for str in test_file_strings]
suites = [unittest.defaultTestLoader.loadTestsFromName(name) \
for name in module_strings]
testSuite = unittest.TestSuite(suites)
return testSuite
有了这个设置，你确实可以在你的测试模块中包含反重力。缺点是你需要更多的支持代码来执行一个特定的测试…我每次都把它们都运行一遍。
我也遇到了同样的问题，使用了一个单独的单元测试文件夹。根据上述建议，我将绝对源路径添加到sys.path中。
以下解决方案的好处是，你可以运行test/test_yourmodule.py文件，而不需要一开始就切换到test目录:
import sys, os
testdir = os.path.dirname(__file__)
srcdir = '../antigravity'
sys.path.insert(0, os.path.abspath(os.path.join(testdir, srcdir)))
import antigravity
import unittest
你真的应该使用pip工具。
使用pip install -e。以开发模式安装包。这是pytest推荐的一种非常好的实践(请参阅他们的良好实践文档，其中还可以找到两种可以遵循的项目布局)。
在我看来，最好的解决方案是使用unittest命令行界面，它会将目录添加到sys. exe目录。路径，因此您不必(在TestLoader类中完成)。
例如，对于这样的目录结构:
new_project
├── antigravity.py
└── test_antigravity.py
你可以直接运行:
$ cd new_project
$ python -m unittest test_antigravity
对于像你这样的目录结构:
new_project
├── antigravity
│ ├── __init__.py # make it a package
│ └── antigravity.py
└── test
├── __init__.py # also make test a package
└── test_antigravity.py
在测试包中的测试模块中，可以像往常一样导入反重力包及其模块:
# import the package
import antigravity
# import the antigravity module
from antigravity import antigravity
# or an object inside the antigravity module
from antigravity.antigravity import my_object
运行单个测试模块:
要运行单个测试模块，在本例中为test_antigravity.py:
$ cd new_project
$ python -m unittest test.test_antigravity
引用测试模块的方法与导入测试模块的方法相同。
运行单个测试用例或测试方法:
你也可以运行一个TestCase或者一个测试方法:
$ python -m unittest test.test_antigravity.GravityTestCase
$ python -m unittest test.test_antigravity.GravityTestCase.test_method
运行所有测试:
你也可以使用测试发现，它会发现并运行所有的测试，它们必须是命名为test*.py的模块或包(可以使用-p，——pattern标志进行更改):
$ cd new_project
$ python -m unittest discover
$ # Also works without discover for Python 3
$ # as suggested by @Burrito in the comments
$ python -m unittest
这将运行测试包中的所有test*.py模块。
可以使用包装器来运行选定的或所有测试。
例如:
./run_tests antigravity/*.py
或者递归地运行所有测试使用globbing (tests/**/*.py)(通过shop -s globstar启用)。
包装器基本上可以使用argparse来解析参数，比如:
parser = argparse.ArgumentParser()
parser.add_argument('files', nargs='*')
然后加载所有测试:
for filename in args.files:
exec(open(filename).read())
然后将它们添加到你的测试套件中(使用inspect):
alltests = unittest.TestSuite()
for name, obj in inspect.getmembers(sys.modules[__name__]):
if inspect.isclass(obj) and name.startswith("FooTest"):
alltests.addTest(unittest.makeSuite(obj))
并运行它们:
result = unittest.TextTestRunner(verbosity=2).run(alltests)
查看这个示例了解更多细节。
请参见:如何在一个目录中运行所有Python单元测试?
如果你使用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
Python unittest模块的解决方案/示例
鉴于以下项目结构:
ProjectName
├── project_name
| ├── models
| | └── thing_1.py
| └── __main__.py
└── test
├── models
| └── test_thing_1.py
└── __main__.py
你可以使用python project_name从根目录运行你的项目，它调用ProjectName/project_name/__main__.py。
要使用python test运行测试，有效地运行ProjectName/test/__main__.py，您需要执行以下操作:
1)通过添加__init__.py文件将您的test/models目录转换为一个包。这使得子目录中的测试用例可以从父测试目录中访问。
# ProjectName/test/models/__init__.py
from .test_thing_1 import Thing1TestCase
2)在test/__main__.py中修改系统路径以包含project_name目录。
# ProjectName/test/__main__.py
import sys
import unittest
sys.path.append('../project_name')
loader = unittest.TestLoader()
testSuite = loader.discover('test')
testRunner = unittest.TextTestRunner(verbosity=2)
testRunner.run(testSuite)
现在您可以在测试中成功地从project_name导入内容。
# ProjectName/test/models/test_thing_1.py
import unittest
from project_name.models import Thing1 # this doesn't work without 'sys.path.append' per step 2 above
class Thing1TestCase(unittest.TestCase):
def test_thing_1_init(self):
thing_id = 'ABC'
thing1 = Thing1(thing_id)
self.assertEqual(thing_id, thing.id)
以下是我的项目结构:
ProjectFolder:
- project:
- __init__.py
- item.py
- tests:
- test_item.py
我发现最好在setUp()方法中导入:
import unittest
import sys
class ItemTest(unittest.TestCase):
def setUp(self):
sys.path.insert(0, "../project")
from project import item
# further setup using this import
def test_item_props(self):
# do my assertions
if __name__ == "__main__":
unittest.main()
实际运行测试的通常方式是什么
我使用的是Python 3.6.2
cd new_project
pytest test/test_antigravity.py
安装pytest: sudo pip install pytest
我没有设置任何路径变量，我的导入不会失败与相同的“测试”项目结构。
我注释掉了这些东西:如果__name__ == '__main__'像这样:
test_antigravity.py
import antigravity
class TestAntigravity(unittest.TestCase):
def test_something(self):
# ... test stuff here
# if __name__ == '__main__':
#
# if __package__ is None:
#
# import something
# sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))
# from .. import antigravity
#
# else:
#
# from .. import antigravity
#
# unittest.main()
我注意到，如果您从“src”目录运行unittest命令行接口，那么导入可以正常工作，无需修改。
python -m unittest discover -s ../test
如果你想把它放在项目目录下的批处理文件中，你可以这样做:
setlocal & cd src & python -m unittest discover -s ../test
这个BASH脚本将从文件系统中的任何位置执行python unittest test目录，无论您在哪个工作目录中。
当你在。/src或。/example工作目录下，并且你需要一个快速的单元测试时，这是很有用的:
#!/bin/bash
this_program="$0"
dirname="`dirname $this_program`"
readlink="`readlink -e $dirname`"
python -m unittest discover -s "$readlink"/test -v
在生产过程中，不需要test/__init__.py文件来增加包/内存开销。
Python 3 +
添加到@Pierre
使用这样的unittest目录结构:
new_project
├── antigravity
│ ├── __init__.py # make it a package
│ └── antigravity.py
└── test
├── __init__.py # also make test a package
└── test_antigravity.py
运行测试模块test_antigravity.py:
$ cd new_project
$ python -m unittest test.test_antigravity
或者一个单独的TestCase
$ python -m unittest test.test_antigravity.GravityTestCase
强制性的不要忘记__init__.py，即使为空，否则将无法工作。
如果没有一些巫术，就不能从父目录导入。下面是另一种至少适用于Python 3.6的方法。
首先，创建一个包含以下内容的test/context.py文件:
import sys
import os
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
然后在test/test_antigravity.py文件中导入如下内容:
import unittest
try:
import context
except ModuleNotFoundError:
import test.context
import antigravity
请注意，这个try-except子句的原因是
导入测试。当使用“python test_antigravity.py”运行时，上下文将失败 在new_project目录下使用"python -m unittest"运行时导入context失败。
通过这种诡计，他们都成功了。
现在你可以运行test目录下的所有测试文件:
$ pwd
/projects/new_project
$ python -m unittest
或者运行一个单独的测试文件:
$ cd test
$ python test_antigravity
好吧，这并不比在test_antigravity。py中包含context。py的内容漂亮多少，但也许会漂亮一点。欢迎提出建议。
如果在测试目录中有多个目录，则必须向每个目录添加__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)
如果您正在寻找命令行解决方案:
基于以下目录结构(使用专用源目录进行概括):
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文件以匹配您的主项目文件夹位置。
同样的问题我已经有很长时间了。我最近选择的目录结构是这样的:
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文件夹，我的单元测试或我的环境变量，一切都运行顺利。
*nix系统(macOS, Linux)的简单解决方案;也可能是Git bash在Windows上。
PYTHONPATH=$PWD python test/test_antigravity.py
Print语句很容易工作，不像pytest test/test_antigravity.py。对于“脚本”来说，这是一种完美的方法，但对于单元测试来说却不是。
当然，我想做一个适当的自动化测试，我会考虑使用适当设置的pytest。
项目中的单元测试有setup.py文件。试一试:
python3 setup.py build
and
python3 setup.py develop --user
做配置路径之类的工作。试一试!
使用cwd作为根项目的目录(在你的例子中是new_project)，你可以在任何目录中不使用__init__.py运行以下命令:
python -m unittest discover -s test
但是你需要在test_antigravity.py中导入如下:
from antigravity import antigravity.your_object
而不是:
import antigravity.your_object
如果你不喜欢反重力条款，你可能会喜欢艾伦L的答案。
