Question

是否可以将命令行参数传递给Django的manage.py脚本，特别是单元测试？即如果我做了像

这样的事情

manage.py test myapp -a do_this

我可以在单元测试的do_this函数中收到值setUp吗？

P.S。 @Martin询问在测试中使用命令行参数的理由：

一些广泛的测试需要花费大量时间，并且不需要在每次提交之前运行。我想让它们成为可选项。
我的测试用例打印的偶尔调试消息应该是可选的
有时我只是希望测试变得疯狂并尝试更多的数据排列。

使用命令行选项，以上所有内容都非常方便。偶尔测试可能会更广泛或更冗长，否则它会很快。

Answer 1

我自己遇到了这个问题，我想避免在命令行上设置环境变量。环境变量肯定有效，但很难跟踪哪些变量产生影响，并且如果您错误输入其中一个变量，则无法通知错误消息。

为了解决这个问题，我使用了argparse来为命令行参数提取额外的参数。例如，我的manage.py文件现在看起来像这样：

#!/usr/bin/env python
import os
import sys
import argparse


if __name__ == "__main__":
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")

    argv = sys.argv
    cmd = argv[1] if len(argv) > 1 else None
    if cmd in ['test']:  # limit the extra arguments to certain commands
        parser = argparse.ArgumentParser(add_help=False)
        parser.add_argument('--foo', default='bar')
        args, argv = parser.parse_known_args(argv)
        # We can save the argument as an environmental variable, in
        # which case it's to retrieve from within `project.settings`,
        os.environ['FOO'] = args.foo
        # or we can save the variable to settings directly if it
        # won't otherwise be overridden.
        from django.conf import settings
        settings.foo = args.foo

    from django.core.management import execute_from_command_line

    # parse_known_args strips the extra arguments from argv,
    # so we can safely pass it to Django.
    execute_from_command_line(argv)

argparse是一个非常好的库，有很多功能。在Python文档中有一个很好的tutorial。

Answer 2

我在我的项目中使用环境变量解决方法（仅适用于类似unix的shell）

berry$ myvar=myval ./manage.py test

模块中的

使用

读取此值

os.environ.get('myvar')

Answer 3

作为manage.py test -a do_this的替代方式，您可以使用特定的settings file

manage.py --settings=project.test_settings test

并在此文件中定义您想要的任何内容。

# test_setting.py
SPECIFIC_OPTION = "test"

# tests.py
from django.conf import settings
...
def setUp(self):
    if settings.SPECIFIC_OPTION:
        ....

如果你需要真正的动态选项，也许你可以在sys.argv中使用test_settings.py，但这是一个非常糟糕的黑客。

Answer 4

Django允许从testrunner类添加自定义命令行选项。您可以创建默认testrunner类的子类并添加自己的选项，然后让django如下使用您的自定义testrunner。

例如，在Django项目目录中创建一个testrunner.py，其中包含：

from django.test.runner import DiscoverRunner

class TestRunner(DiscoverRunner):
    def __init__(self, option=None, **kwargs):
        super().__init__(**kwargs)

        print("Passed option: {}".format(option))

    @classmethod
    def add_arguments(cls, parser):
        DiscoverRunner.add_arguments(parser)

        parser.add_argument('-o', '--option', help='Example option')

这是一个从默认运行程序派生的测试运行程序（因此它与默认运行程序一样工作），不同之处在于它告诉django添加一个额外的命令行选项（在add_arguments()类方法中）并处理构造函数中的这个额外选项。要与此新跑步者一起跑步，请传递其名称，如下所示：

./manage.py test --testrunner=testrunner.TestRunner -o foo

当然，只要在命令行中将完整的导入名称传递给它，您就可以将此类放置在其他任何地方。

请注意，必须使用--testrunner=foo，不能使用两个单独的参数（--testrunner foo），因为这样多余的参数将不起作用。修补程序正在处理中：https://github.com/django/django/pull/10307

此示例仅显示选项值，但您希望以某种方式将其传递给测试用例。我找不到有关如何将选项传递给单元测试用例的任何快速信息，但是您可能为此仅使用全局（模块级）变量或类变量（虽然不太可重用和优雅，但简单易行有效）。

Answer 5

在@Matthijs答案之后，您可以扩展setup_test_environment方法，类似于DiscoveryRunner处理 debug-mode 的方法。它通过导入settings.DEBUG来更改可以在测试中使用的django.conf.settings的值。但是您也可以添加自己的设置：

from django.test.runner import DiscoverRunner

class TestRunner(DiscoverRunner):
    def __init__(self, option=None, **kwargs):
        super().__init__(**kwargs)

        print("Passed option: {}".format(option))
        self.option = option

    @classmethod
    def add_arguments(cls, parser):
        DiscoverRunner.add_arguments(parser)

        parser.add_argument('-o', '--option', help='Example option')

    def setup_test_environment(self, **kwargs):
        super(TestRunner, self).setup_test_environment(**kwargs)
        settings.TEST_SETTINGS = {
            'option': self.option,
        }

在测试中，您只需通过设置即可访问该选项

from django.test import TestCase
from django.conf import settings


class MyTestCase(TestCase):

    def test_something(self):
        if settings.TEST_SETTINGS['option']:
            print("Do stuff")

Django manage.py：是否可以传递命令行参数（用于单元测试）

5 个答案: