Модуль community.general.django_manage – Управляет приложением Django

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: community.general.django_manage.

Описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры

Описание

Управляет приложением Django с помощью переднего плана приложения manage.py для django-admin. С параметром virtualenv, все команды управления будут выполняться установкой virtualenv.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

django >= 4.1

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
ack_venv_creation_deprecation boolean добавлено в community.general 5.8.0	Этот параметр больше не имеет никакого эффекта начиная с версии community.general 9.0.0. Он будет удален из community.general 11.0.0. Варианты: `false` `true`
apps string	Список приложений, разделенных пробелом, для обработки. Используется командой `test`.
cache_table string	Название таблицы, используемой для кэширования с поддержкой базы данных. Используется командой `createcachetable`.
clear boolean	Очистить существующие файлы перед копированием или созданием символической ссылки на исходный файл. Используется только с командой `collectstatic`. Аргумент `--noinput` будет добавлен автоматически. Варианты: `false` ← (по умолчанию) `true`
command string / обязательно	Название команды управления Django, которую нужно запустить. Команды, перечисленные ниже, встроены в этот модуль и имеют основную валидацию параметров. `collectstatic` - Сбор статических файлов в `STATIC_ROOT`. `createcachetable` - Создание таблиц кеша для использования с кешем базы данных. `flush` - Удаление всех данных из базы данных. `loaddata` - Поиск и загрузка содержимого указанного `fixtures` в базу данных. `migrate` - Синхронизация состояния базы данных с моделями и миграциями. `test` - Запуск тестов для всех установленных приложений. Другие команды могут быть введены, но они будут завершиться ошибкой, если они неизвестны Django. Другие команды, которые могут запросить ввод пользователя, следует запускать со флагом `--noinput`. Поддержка значений `cleanup`, `syncdb`, `validate` была удалена в community.general 9.0.0. См. примечание о поддерживаемых версиях Django.
database string	База данных для обработки. Используется командами `createcachetable`, `flush`, `loaddata`, `syncdb`, и `migrate`.
failfast псевдонимы: fail_fast boolean	Немедленно завершить команду, если тест завершится неудачей. Используется командой `test`. Варианты: `false` ← (по умолчанию) `true`
fixtures string	Список файлов фикстур, разделенных пробелами, которые нужно загрузить в базу данных. Обязательно для команды `loaddata`.
link boolean	Создаст символические ссылки на файлы вместо копирования. Этот параметр можно использовать только с командой `collectstatic`. Варианты: `false` `true`
merge boolean	Запустит миграции, которые находятся вне порядка или отсутствуют, так как они не являются миграциями отката. Этот параметр можно использовать только с командой `migrate`. Варианты: `false` `true`
project_path псевдонимы: app_path, chdir путь / обязательно	Путь к корню приложения Django, где находится `manage.py`.
pythonpath псевдонимы: python_path путь	Директория для добавления в путь Python. Обычно используется для включения модуля настроек, если он находится вне каталога приложения. Это эквивалентно добавлению значения `pythonpath` к переменной среды `PYTHONPATH`.
settings путь	Путь Python к модулю настроек приложения, например, `myapp.settings`.
skip boolean	Пропустить миграции, которые находятся вне порядка или отсутствуют. Этот параметр можно использовать только с командой `migrate`. Варианты: `false` `true`
testrunner псевдонимы: test_runner string	Управляет классом тест-раннера, который используется для выполнения тестов. Этот параметр передаётся как есть в `manage.py`.
virtualenv псевдонимы: virtual_env путь	Необязательный путь к установке `virtualenv` для использования при запуске приложения manage. Виртуальная среда должна существовать, в противном случае модуль завершится ошибкой.

END_OF_DOCUMENT_MARKER

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может выполняться в `check_mode` и возвращать прогноз о внесённых изменениях без модификации целевого объекта.
diff_mode	Поддержка: нет	При включенном режиме diff, модуль вернёт подробности о внесённых (или, возможно, требующихся) изменениях в `check_mode`.

Примечания

Примечание

ВНИМАНИЕ: Поддержка версий Django, предшествующих 4.1, была удалена в версии community.general 9.0.0. Хотя модуль позволяет использовать произвольные команды, он не проверяет версию используемого Django, поэтому настоятельно рекомендуется использовать более новую версию Django.
Обратите внимание, что Django 4.1 требует Python 3.8 или выше.
Этот модуль не создаст виртуальную среду, если параметр virtualenv указан, а виртуальная среда в указанном месте не существует. Это поведение изменилось в версии community.general 9.0.0.
Рекомендуемый способ создания виртуальной среды в Ansible - использование ansible.builtin.pip.
Этот модуль предполагает использование английских сообщений об ошибках для команды createcachetable, чтобы определить существование таблицы.
Для использования команды collectstatic, необходимо включить staticfiles в ваших настройках.
Ваше приложение manage.py должно быть исполняемым (rwxr-xr-x) и иметь корректный shebang, например #!/usr/bin/env python, для вызова соответствующего интерпретатора Python.

См. также

django-admin и manage.py Справочник: Справочник по командам django-admin или manage.py.
Страница загрузки Django: Страница, показывающая, как получить Django и график поддерживаемых релизов.
Какую версию Python можно использовать с Django?: Из раздела FAQ Django, ответ на требования Python для фреймворка.

Примеры

- name: Run cleanup on the application installed in django_dir
  community.general.django_manage:
    command: clearsessions
    project_path: "{{ django_dir }}"

- name: Load the initial_data fixture into the application
  community.general.django_manage:
    command: loaddata
    project_path: "{{ django_dir }}"
    fixtures: "{{ initial_data }}"

- name: Run syncdb on the application
  community.general.django_manage:
    command: migrate
    project_path: "{{ django_dir }}"
    settings: "{{ settings_app_name }}"
    pythonpath: "{{ settings_dir }}"
    virtualenv: "{{ virtualenv_dir }}"

- name: Run the SmokeTest test case from the main app. Useful for testing deploys
  community.general.django_manage:
    command: test
    project_path: "{{ django_dir }}"
    apps: main.SmokeTest

- name: Create an initial superuser
  community.general.django_manage:
    command: "createsuperuser --noinput --username=admin --email=admin@example.com"
    project_path: "{{ django_dir }}"

Авторы

Алексей Знаменский (@russoz)
Скотт Андерсон (@tastychutney)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/django_manage_module.html