Модуль community.general.read_csv – Чтение CSV-файла

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в книге задач, укажите: community.general.read_csv.

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

Описание

Чтение CSV-файла и возвращение списка или словаря, содержащего по одному словарю на строку.

Параметры

Параметр	Комментарии
разделитель строка	Строка длиной в один символ, используемая для разделения полей. При использовании этого параметра вы изменяете значение по умолчанию, используемое `dialect`. Значение по умолчанию зависит от используемого диалекта.
диалект строка	Диалект CSV, используемый при разборе CSV-файла. Возможные значения включают `excel`, `excel-tab` или `unix`. По умолчанию: `"excel"`
имена_полей список / элементы=строка	Список имён полей для каждого столбца. Это необходимо, если CSV не имеет заголовков.
ключ строка	Имя столбца, используемого в качестве ключа для результирующего словаря. Если `key` не задано, модуль возвращает список словарей, где каждый словарь представляет собой строку в CSV-файле.
путь псевдонимы: имя_файла путь / обязательно	Имя CSV-файла для чтения данных.
пропускать_пробелы_в_начале булево	Нужно ли игнорировать пробелы сразу после разделителя? При использовании этого параметра вы изменяете значение по умолчанию, используемое `dialect`. Значение по умолчанию зависит от используемого диалекта. Варианты: `false` `true`
строго булево	Вызывать исключение при плохих данных CSV. При использовании этого параметра вы изменяете значение по умолчанию, используемое `dialect`. Значение по умолчанию зависит от используемого диалекта. Варианты: `false` `true`
уникальный булево	Является ли ожидаемым использование `key` в качестве уникального. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

См. также

ansible.builtin.csvfile плагин поиска: Может использоваться для выборочного поиска в CSV-файлах из Jinja.

Примеры

# Example CSV file with header
#
#   name,uid,gid
#   dag,500,500
#   jeroen,501,500

# Read a CSV file and access user 'dag'
- name: Read users from CSV file and return a dictionary
  community.general.read_csv:
    path: users.csv
    key: name
  register: users
  delegate_to: localhost

- ansible.builtin.debug:
    msg: 'User {{ users.dict.dag.name }} has UID {{ users.dict.dag.uid }} and GID {{ users.dict.dag.gid }}'

# Read a CSV file and access the first item
- name: Read users from CSV file and return a list
  community.general.read_csv:
    path: users.csv
  register: users
  delegate_to: localhost

- ansible.builtin.debug:
    msg: 'User {{ users.list.1.name }} has UID {{ users.list.1.uid }} and GID {{ users.list.1.gid }}'

# Example CSV file without header and semi-colon delimiter
#
#   dag;500;500
#   jeroen;501;500

# Read a CSV file without headers
- name: Read users from CSV file and return a list
  community.general.read_csv:
    path: users.csv
    fieldnames: name,uid,gid
    delimiter: ';'
  register: users
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
словарь словарь	Содержание CSV в виде словаря. Возвращается: успех Пример: `{"dag": {"gid": 500, "name": "dag", "uid": 500}, "jeroen": {"gid": 500, "name": "jeroen", "uid": 501}}`
список список / элементы=строка	Содержание CSV в виде списка. Возвращается: успех Пример: `[{"gid": 500, "name": "dag", "uid": 500}, {"gid": 500, "name": "jeroen", "uid": 501}]`

Авторы

Dag Wieers (@dagwieers)

Ссылки на коллекцию

© 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/read_csv_module.html