community.general.read_csv – Чтение CSV-файла

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
delimiter строка		Односимвольная строка, используемая для разделения полей. При использовании этого параметра вы изменяете значение по умолчанию, используемое в `dialect`. Значение по умолчанию зависит от используемого диалекта.
dialect строка	По умолчанию: "excel"	Диалект CSV для парсинга CSV-файла. Возможные значения включают `excel`, `excel-tab` или `unix`.
fieldnames список / элементы=строка		Список имён полей для каждого столбца. Это необходимо, если в CSV нет заголовка.
key строка		Имя столбца, используемого в качестве ключа для результирующего словаря. Если `key` не задан, модуль возвращает список словарей, где каждый словарь представляет собой строку в CSV-файле.
path путь / обязательно		Имя CSV-файла для чтения данных. псевдонимы: filename
skipinitialspace булево	Варианты: нет да	Игнорировать ли пробелы сразу после разделителя. При использовании этого параметра вы изменяете значение по умолчанию, используемое в `dialect`. Значение по умолчанию зависит от используемого диалекта.
strict булево	Варианты: нет да	Вызывать ли исключение при плохих данных CSV. При использовании этого параметра вы изменяете значение по умолчанию, используемое в `dialect`. Значение по умолчанию зависит от используемого диалекта.
unique булево	Варианты: нет да ←	Требуется ли, чтобы значение `key` было уникальным.

Примечания

Примечание

Ansible также поставляется с плагином поиска 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

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

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

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

Авторы

Dag Wieers (@dagwieers)

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