community.general.django_command 模块 – 运行 Django 管理命令

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.django_command。

community.general 9.0.0 中的新增功能

概要

  • 此模块允许执行任意的 Django 管理命令。

参数

参数

注释

command

字符串 / 必选

Django 管理命令。它必须是在目标系统中被 python -m django 接受的有效命令。

extra_args

列表 / 元素=字符串

传递给 Django 管理命令的额外参数列表。

pythonpath

路径

将给定的文件系统路径添加到 Python 导入搜索路径。

该值将按原样传递给 django-admin 中的 --pythonpath 参数。

settings

字符串 / 必选

指定要使用的设置模块。

该值将按原样传递给 django-admin 中的 --settings 参数。

skip_checks

布尔值

跳过在运行命令之前运行系统检查。

选择

  • false

  • true

traceback

布尔值

当引发 CommandError 时，在输出中提供完整的堆栈跟踪。

选择

  • false

  • true

venv

路径

使用此虚拟环境中的 Python 解释器。

传递虚拟环境根目录的路径，而不是 bin/ 目录或 python 可执行文件。

verbosity

整数

指定 django-admin 输出中的通知和调试信息量。

选择

  • 0

  • 1

  • 2

  • 3

属性

属性

支持

描述

check_mode

支持: 无

可以在 check_mode 中运行，并返回更改的状态预测，而无需修改目标。

diff_mode

支持: 无

当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息。

说明

注意

  • django-admin 命令始终使用 C 区域设置执行，并且始终传递 --no-color 选项。

另请参阅

另请参阅

官方 Django 文档中的 django-admin 和 manage.py

有关 django-admin 的内置命令和选项，请参阅此文档。请确保在该页面上的版本选择器中选择正确的 Django 版本。

示例

---
- name: Check the project
  community.general.django_command:
    command: check
    settings: myproject.settings

- name: Check the project in specified python path, using virtual environment
  community.general.django_command:
    command: check
    settings: fancysite.settings
    pythonpath: /home/joedoe/project/fancysite
    venv: /home/joedoe/project/fancysite/venv

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

run_info

字典

命令行执行信息。

返回: 成功并且 verbosity >= 3

version

字符串

在 community.general 10.0.0 中添加

Django 的版本。

返回: 总是

示例: "5.1.2"

作者

  • Alexei Znamensky (@russoz)