对于一个简单的Python模块来说,非常常见的目录结构似乎是将单元测试分离到它们自己的测试目录中:

new_project/
    antigravity/
        antigravity.py
    test/
        test_antigravity.py
    setup.py
    etc.

我的问题很简单,实际运行测试的通常方式是什么?我怀疑这对每个人来说都是显而易见的,除了我,但你不能只是从测试目录运行python test_antigravity.py,因为它的导入antigravity将失败,因为模块不在路径上。

我知道我可以修改PYTHONPATH和其他与搜索路径相关的技巧,但我不能相信这是最简单的方法——如果您是开发人员,这很好,但如果用户只是想检查测试是否通过,那么期望他们使用这种方法是不现实的。

另一种替代方法是将测试文件复制到另一个目录中,但这似乎有点愚蠢,并且没有注意到将它们放在一个单独的目录中。

那么,如果您刚刚下载源代码到我的新项目,您将如何运行单元测试?我更喜欢这样的答案:“要运行单元测试,请执行x。”


当前回答

如果没有一些巫术,就不能从父目录导入。下面是另一种至少适用于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的内容漂亮多少,但也许会漂亮一点。欢迎提出建议。

其他回答

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,即使为空,否则将无法工作。

这个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文件来增加包/内存开销。

项目中的单元测试有setup.py文件。试一试:

python3 setup.py build

and

python3 setup.py develop --user

做配置路径之类的工作。试一试!

如果您正在寻找命令行解决方案:

基于以下目录结构(使用专用源目录进行概括):

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添加更多目录。

使用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的答案。