File: //lib/python3.9/site-packages/ansible/plugins/lookup/__pycache__/csvfile.cpython-39.pyc
a
�)g� � @ s� d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
d dl m Z d dl
mZmZ d dlmZ d d lmZ d d
lmZ d d lmZmZmZ G d d
� d
�ZG dd� d�ZG dd� de�Z dS )� )�absolute_import�division�print_functiona
name: csvfile
author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
version_added: "1.5"
short_description: read data from a TSV or CSV file
description:
- The csvfile lookup reads the contents of a file in CSV (comma-separated value) format.
The lookup looks for the row where the first column matches keyname (which can be multiple words)
and returns the value in the C(col) column (default 1, which indexed from 0 means the second column in the file).
options:
col:
description: column to return (0 indexed).
default: "1"
default:
description: what to return if the value is not found in the file.
delimiter:
description: field separator in the file, for a tab you can specify C(TAB) or C(\t).
default: TAB
file:
description: name of the CSV/TSV file to open.
default: ansible.csv
encoding:
description: Encoding (character set) of the used CSV file.
default: utf-8
version_added: "2.1"
notes:
- The default is for TSV files (tab delimited) not CSV (comma delimited) ... yes the name is misleading.
- As of version 2.11, the search parameter (text that must match the first column of the file) and filename parameter can be multi-word.
- For historical reasons, in the search keyname, quotes are treated
literally and cannot be used around the string unless they appear
(escaped as required) in the first column of the file you are parsing.
a�
- name: Match 'Li' on the first column, return the second column (0 based index)
ansible.builtin.debug: msg="The atomic number of Lithium is {{ lookup('ansible.builtin.csvfile', 'Li file=elements.csv delimiter=,') }}"
- name: msg="Match 'Li' on the first column, but return the 3rd column (columns start counting after the match)"
ansible.builtin.debug: msg="The atomic mass of Lithium is {{ lookup('ansible.builtin.csvfile', 'Li file=elements.csv delimiter=, col=2') }}"
- name: Define Values From CSV File, this reads file in one go, but you could also use col= to read each in it's own lookup.
ansible.builtin.set_fact:
loop_ip: "{{ csvline[0] }}"
int_ip: "{{ csvline[1] }}"
int_mask: "{{ csvline[2] }}"
int_name: "{{ csvline[3] }}"
local_as: "{{ csvline[4] }}"
neighbor_as: "{{ csvline[5] }}"
neigh_int_ip: "{{ csvline[6] }}"
vars:
csvline = "{{ lookup('ansible.builtin.csvfile', bgp_neighbor_ip, file='bgp_neighbors.csv', delimiter=',') }}"
delegate_to: localhost
zb
_raw:
description:
- value(s) stored in file column
type: list
elements: str
N)�MutableSequence)� AnsibleError�AnsibleAssertionError)�parse_kv)�
LookupBase)�PY2)�to_bytes� to_native�to_textc @ s. e Zd ZdZd
dd�Zdd� Zdd� ZeZd S ) �
CSVRecoderzP
Iterator that reads an encoded stream and reencodes the input to UTF-8
�utf-8c C s t �|�|�| _d S �N)�codecs� getreader�reader)�self�f�encoding� r �B/usr/lib/python3.9/site-packages/ansible/plugins/lookup/csvfile.py�__init__U s zCSVRecoder.__init__c C s | S r r �r r r r �__iter__X s zCSVRecoder.__iter__c C s t | j��d�S )Nr )�nextr �encoder r r r �__next__[ s zCSVRecoder.__next__N)r )�__name__�
__module__� __qualname__�__doc__r r r r r r r r r Q s
r c @ s4 e Zd ZdZejdfdd�Zdd� ZeZdd� Z d S )
� CSVReaderzu
A CSV reader which will iterate over lines in the CSV file "f",
which is encoded in the given encoding.
r c K s: t rt||�}nt�|�|�}tj|fd|i|��| _d S )N�dialect)r
r r r �csvr )r r r$ r �kwdsr r r r g s zCSVReader.__init__c C s t | j�}dd� |D �S )Nc S s g | ] }t |��qS r )r
)�.0�sr r r �
<listcomp>q � z&CSVReader.__next__.<locals>.<listcomp>)r r )r �rowr r r r o s
zCSVReader.__next__c C s | S r r r r r r r u s zCSVReader.__iter__N)
r r r! r" r% Zexcelr r r r r r r r r# a s
r# c @ s e Zd Zddd�Zd dd�ZdS )
� LookupModuler N� c
C s� zTt t|�d�}t|t|�|d�}|D ]*} t| �r&| d |kr&| t|� W S q&W n4 ty� }
z tdt|
� ��W Y d }
~
n
d }
~
0 0 |S )N�rb)� delimiterr r z csvfile: %s)�openr r# r �len�int� Exceptionr ) r �filename�keyr/ r Zdflt�colr Zcreaderr+ �er r r �read_csv{ s &zLookupModule.read_csvc K s@ g }| j ||d� | �� }|D �]}t|�}d|vr<td��|d }zD|�� D ]6\} }
| dkr`qN| |vrttd| ��| �� |
|| < qNW n0 ttfy� } zt| ��W Y d } ~ n
d } ~ 0 0 |d dkr�d|d< | � |d|d �} | �
| ||d |d
|d |d �}
|
d ur t |
t ��r0|
D ]}|�
|� �q q |�
|
� q |S )
N)Z var_optionsZdirectZ _raw_paramsz(Search key is required but was not foundz%s is not a valid optionr/ ZTAB� �files�filer �defaultr6 )Z set_optionsZ get_optionsr r �itemsr Z_deprecate_inline_kv�
ValueError�AssertionErrorZfind_file_in_search_pathr8 �
isinstancer �append)r ZtermsZ variables�kwargs�retZ paramvalsZtermZkvr5 �name�valuer7 Z
lookupfile�var�vr r r �run� s8
$ zLookupModule.run)r Nr- )N)r r r! r8 rH r r r r r, y s
r, ) Z
__future__r r r �typeZ
__metaclass__Z
DOCUMENTATIONZEXAMPLESZRETURNr r% �collections.abcr Zansible.errorsr r Zansible.parsing.splitterr Zansible.plugins.lookupr Zansible.module_utils.sixr
Zansible.module_utils._textr r r
r r# r, r r r r �<module> s !