Django manage.py:是否可以传递命令行参数(用于单元测试)

Question

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

manage.py test myapp -a do_this

我可以接收值do_this的setUp单元测试的功能？

PS @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文档中有一个很好的教程.

Answer 2

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

berry$ myvar=myval ./manage.py test 

在您的模块中使用读取此值

os.environ.get('myvar')

Answer 3

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 4

作为替代方法，manage.py test -a do_this您可以使用特定的设置文件

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.argvin test_settings.py，但这是一个非常肮脏的黑客。