Django自定义命令详解与示例

class Command(BaseCommand):

    help = '''
        Usage: python manage.pyc easyimport --debug -Dabc=123 -Xms2g -Xmx4g mappers/*.yaml --siteid 999
    '''

    def add_arguments(self, parser):
        super(Command, self).add_arguments(parser)
        parser.add_argument('input', metavar='input', nargs="*")
        parser.add_argument('--debug', action='store_true', dest='debug', help='Only shows command, without execute.')
        parser.add_argument('-D', action='append', metavar='java property', dest='javaProperties', help='-Dabc=value')
        parser.add_argument('-X', action='append', metavar='java options', dest='javaOptions', help='-Xms2g -Xmx4g')
        parser.add_argument('otheroptions', nargs=argparse.REMAINDER)

这段代码是一个自定义的命令类，用于扩展Django框架中的命令行工具。Django框架允许开发者通过编写自定义命令来执行特定的任务。这个类继承自`BaseCommand`，这是Django框架中用于创建自定义命令的基类。

下面是代码的详细解释：

1. `class Command(BaseCommand):` 定义了一个名为`Command`的类，它继承自`BaseCommand`。

2. `help = ...` 定义了一个多行字符串，作为命令的帮助信息。这个字符串描述了命令的用法和参数。

3. `def add_arguments(self, parser):` 定义了一个方法，用于向命令行解析器添加参数。这个方法会在命令被执行时调用。

4. `super(Command, self).add_arguments(parser)` 调用父类`BaseCommand`的`add_arguments`方法，以确保任何默认的参数也被添加到解析器中。

5. `parser.add_argument('input', metavar='input', nargs="*")` 添加了一个位置参数`input`，它可以接受多个值（`nargs="*"`意味着参数可以有零个或多个值）。

6. `parser.add_argument('--debug', action='store_true', dest='debug', help='Only shows command, without execute.')` 添加了一个可选参数`--debug`，当指定这个参数时，会将`debug`的值设置为`True`。`action='store_true'`表示如果参数存在，则将对应的属性设置为`True`。

7. `parser.add_argument('-D', action='append', metavar='java property', dest='javaProperties', help='-Dabc=value')` 添加了一个可选参数`-D`，用于传递Java属性。`action='append'`表示将传递的值追加到一个列表中，而不是替换它。

8. `parser.add_argument('-X', action='append', metavar='java options', dest='javaOptions', help='-Xms2g -Xmx4g')` 类似于`-D`参数，`-X`用于传递Java虚拟机的启动选项，如堆内存大小。

9. `parser.add_argument('otheroptions', nargs=argparse.REMAINDER)` 添加了一个捕获所有剩余参数的参数，这些参数不会被前面的规则捕获。

举例说明：

假设我们有一个Django项目，并且我们想要执行一个名为`easyimport`的自定义命令，该命令用于导入一些配置文件，并可以接收一些Java属性和选项。

我们可以在命令行中这样调用这个命令：

python manage.py easyimport --debug -Dabc=123 -Xms2g -Xmx4g mappers/*.yaml --siteid 999

这里的参数解释如下：

- `easyimport` 是自定义命令的名称。
- `--debug` 表示我们只想显示将要执行的命令，而不是实际执行它。
- `-Dabc=123` 传递了一个Java属性`abc`，其值为`123`。
- `-Xms2g` 和 `-Xmx4g` 分别设置了Java虚拟机的最小堆内存和最大堆内存。
- `mappers/*.yaml` 是要导入的配置文件的路径，这里使用了通配符来匹配所有`.yaml`文件。
- `--siteid 999` 是一个额外的参数，它会被`otheroptions`捕获，因为`otheroptions`会捕获所有未被前面规则匹配的参数。

执行这个命令后，Django会创建一个`Command`实例，并调用它的`handle`方法（如果定义了的话），在这个方法中可以编写导入逻辑。如果指定了`--debug`参数，那么在`handle`方法中可以检查`self.debug`属性，如果它为`True`，则不执行实际的导入操作，而是打印出将要执行的命令。