mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-23 20:44:00 -07:00
8f8a0e1d7c
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Adjust all __future__ imports: for i in $(grep -REl "__future__.*absolute_import" plugins/ tests/); do sed -e 's/from __future__ import .*/from __future__ import annotations/g' -i $i; done * Remove all UTF-8 encoding specifications for Python source files: for i in $(grep -REl '[-][*]- coding: utf-8 -[*]-' plugins/ tests/); do sed -e '/^# -\*- coding: utf-8 -\*-/d' -i $i; done * Remove __metaclass__ = type: for i in $(grep -REl '__metaclass__ = type' plugins/ tests/); do sed -e '/^__metaclass__ = type/d' -i $i; done
80 lines
2.7 KiB
Python
80 lines
2.7 KiB
Python
# Copyright (c) 2024, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
venv:
|
|
description:
|
|
- Use the Python interpreter from this virtual environment.
|
|
- Pass the path to the root of the virtualenv, not the C(bin/) directory nor the C(python) executable.
|
|
type: path
|
|
settings:
|
|
description:
|
|
- Specifies the settings module to use.
|
|
- The value is passed as is to the C(--settings) argument in C(django-admin).
|
|
type: str
|
|
required: true
|
|
pythonpath:
|
|
description:
|
|
- Adds the given filesystem path to the Python import search path.
|
|
- The value is passed as is to the C(--pythonpath) argument in C(django-admin).
|
|
type: path
|
|
traceback:
|
|
description:
|
|
- Provides a full stack trace in the output when a C(CommandError) is raised.
|
|
type: bool
|
|
verbosity:
|
|
description:
|
|
- Specifies the amount of notification and debug information in the output of C(django-admin).
|
|
type: int
|
|
choices: [0, 1, 2, 3]
|
|
skip_checks:
|
|
description:
|
|
- Skips running system checks prior to running the command.
|
|
type: bool
|
|
|
|
|
|
notes:
|
|
- The C(django-admin) command is always executed using the C(C) locale, and the option C(--no-color) is always passed.
|
|
seealso:
|
|
- name: django-admin and manage.py in official Django documentation
|
|
description: >-
|
|
Refer to this documentation for the builtin commands and options of C(django-admin). Please make sure that you select
|
|
the right version of Django in the version selector on that page.
|
|
link: https://docs.djangoproject.com/en/5.0/ref/django-admin/
|
|
"""
|
|
|
|
DATABASE = r"""
|
|
options:
|
|
database:
|
|
description:
|
|
- Specify the database to be used.
|
|
type: str
|
|
default: default
|
|
"""
|
|
|
|
DATA = r"""
|
|
options:
|
|
excludes:
|
|
description:
|
|
- Applications or models to be excluded.
|
|
- Format must be either V(app_label) or V(app_label.ModelName).
|
|
type: list
|
|
elements: str
|
|
format:
|
|
description:
|
|
- Serialization format of the output data.
|
|
type: str
|
|
default: json
|
|
choices: [xml, json, jsonl, yaml]
|
|
notes:
|
|
- As it is now, the module is B(not idempotent). Ensuring idempotency for this case can be a bit tricky, because it would
|
|
amount to ensuring beforehand that all the data in the fixture file is already in the database, which is not a trivial feat.
|
|
Unfortunately, neither C(django loaddata) nor C(django dumpdata) have a C(--dry-run) option, so the only way to know whether
|
|
there is a change or not is to actually load or dump the data.
|
|
"""
|