관리-도구
편집 파일: first_found.cpython-39.pyc
a �)g" � @ s� d dl mZmZmZ eZdZdZdZd dl Z d dl m Z m Z d dl mZ d dlmZmZ d d lmZ d d lmZ d d � Zddd�ZG dd� de�ZdS )� )�absolute_import�division�print_functiona� name: first_found author: Seth Vidal (!UNKNOWN) <skvidal@fedoraproject.org> version_added: historical short_description: return first file found from list description: - This lookup checks a list of files and paths and returns the full path to the first combination found. - As all lookups, when fed relative paths it will try use the current task's location first and go up the chain to the containing locations of role / play / include and so on. - The list of files has precedence over the paths searched. For example, A task in a role has a 'file1' in the play's relative path, this will be used, 'file2' in role's relative path will not. - Either a list of files C(_terms) or a key C(files) with a list of files is required for this plugin to operate. notes: - This lookup can be used in 'dual mode', either passing a list of file names or a dictionary that has C(files) and C(paths). options: _terms: description: A list of file names. files: description: A list of file names. type: list elements: string default: [] paths: description: A list of paths in which to look for the files. type: list elements: string default: [] skip: type: boolean default: False description: - When C(True), return an empty list when no files are matched. - This is useful when used with C(with_first_found), as an empty list return to C(with_) calls causes the calling task to be skipped. - When used as a template via C(lookup) or C(query), setting I(skip=True) will *not* cause the task to skip. Tasks must handle the empty list return from the template. - When C(False) and C(lookup) or C(query) specifies I(errors='ignore') all errors (including no file found, but potentially others) return an empty string or an empty list respectively. - When C(True) and C(lookup) or C(query) specifies I(errors='ignore'), no file found will return an empty list and other potential errors return an empty string or empty list depending on the template call (in other words return values of C(lookup) v C(query)). a� - name: Set _found_file to the first existing file, raising an error if a file is not found ansible.builtin.set_fact: _found_file: "{{ lookup('ansible.builtin.first_found', findme) }}" vars: findme: - /path/to/foo.txt - bar.txt # will be looked in files/ dir relative to role and/or play - /path/to/biz.txt - name: Set _found_file to the first existing file, or an empty list if no files found ansible.builtin.set_fact: _found_file: "{{ lookup('ansible.builtin.first_found', files, paths=['/extra/path'], skip=True) }}" vars: files: - /path/to/foo.txt - /path/to/bar.txt - name: Include tasks only if one of the files exist, otherwise skip the task ansible.builtin.include_tasks: file: "{{ item }}" with_first_found: - files: - path/tasks.yaml - path/other_tasks.yaml skip: True - name: Include tasks only if one of the files exists, otherwise skip ansible.builtin.include_tasks: '{{ tasks_file }}' when: tasks_file != "" vars: tasks_file: "{{ lookup('ansible.builtin.first_found', files=['tasks.yaml', 'other_tasks.yaml'], errors='ignore') }}" - name: | copy first existing file found to /some/file, looking in relative directories from where the task is defined and including any play objects that contain it ansible.builtin.copy: src: "{{ lookup('ansible.builtin.first_found', findme) }}" dest: /some/file vars: findme: - foo - "{{ inventory_hostname }}" - bar - name: same copy but specific paths ansible.builtin.copy: src: "{{ lookup('ansible.builtin.first_found', params) }}" dest: /some/file vars: params: files: - foo - "{{ inventory_hostname }}" - bar paths: - /tmp/production - /tmp/staging - name: INTERFACES | Create Ansible header for /etc/network/interfaces ansible.builtin.template: src: "{{ lookup('ansible.builtin.first_found', findme)}}" dest: "/etc/foo.conf" vars: findme: - "{{ ansible_virtualization_type }}_foo.conf" - "default_foo.conf" - name: read vars from first file found, use 'vars/' relative subdir ansible.builtin.include_vars: "{{lookup('ansible.builtin.first_found', params)}}" vars: params: files: - '{{ ansible_distribution }}.yml' - '{{ ansible_os_family }}.yml' - default.yml paths: - 'vars' zW _raw: description: - path to file found type: list elements: path N)�Mapping�Sequence)�UndefinedError)�AnsibleLookupError�AnsibleUndefinedVariable)� string_types)� LookupBasec c s< t |�}d}| D ] }||v r(|V d}q||7 }q|V d S )N� )�set)�value�chars�v�c� r �F/usr/lib/python3.9/site-packages/ansible/plugins/lookup/first_found.py� _splitter� s r �,c C s< g }t | t�r tt| |��}n| D ]}|�t||�� q"|S )N)� isinstancer �listr �extend� _split_on)�termsZsplitersZtermlist�tr r r r � s r c @ s e Zd Zdd� Zdd� ZdS )� LookupModulec C s g }d}|D ]�}t |t�r*| j||d� nXt |t�rD| j||d� n>t |t�rn| �|||�\}}|�|� q ntdt|�|f ��| � d�}| � d�} | � d�}t |d�} t | d�} | r�| D ]&} | D ] } t j � | | �}|�|� q�q�q | r�| }q |�|� q ||fS ) NF)Z var_optionsZdirectzWInvalid term supplied, can handle string, mapping or list of strings but got: %s for %s�files�paths�skipz,;z,:;)r r Z set_optionsr r �_process_termsr r �typeZ get_optionr �os�path�join�append)�selfr � variables�kwargs� total_searchr Zterm�partialr r ZfilelistZpathlistr# �fn�fr r r r � s4 zLookupModule._process_termsc K s� | � |||�\}}t| dd�}d }|D ]T}z| j�|�}W n ttfyT Y q&Y n0 | j|||dd�}|d ur&|g S q&|r�g S td��d S )NZ_subdirr T)Zignore_missingz)No file was found when using first_found.)r �getattrZ_templar�templater r Zfind_file_in_search_pathr ) r& r r' r( r) r Zsubdirr# r+ r r r �run� s zLookupModule.runN)�__name__� __module__� __qualname__r r/ r r r r r � s *r )r )Z __future__r r r r! Z __metaclass__Z DOCUMENTATIONZEXAMPLESZRETURNr" �collections.abcr r Zjinja2.exceptionsr Zansible.errorsr r Zansible.module_utils.sixr Zansible.plugins.lookupr r r r r r r r �<module> s +Q