mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-11 08:34:21 -07:00
a7ec516be3fix style in plugins (#10303)
(cherry picked from commit 329c2222fc)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
81 lines
2.3 KiB
Python
81 lines
2.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2013, Bradley Young <young.bradley@gmail.com>
|
|
# Copyright (c) 2017 Ansible Project
|
|
# 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 (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = r"""
|
|
author: Unknown (!UNKNOWN)
|
|
name: cartesian
|
|
short_description: Returns the cartesian product of lists
|
|
description:
|
|
- Takes the input lists and returns a list that represents the product of the input lists.
|
|
- It is clearer with an example, it turns [1, 2, 3], [a, b] into [1, a], [1, b], [2, a], [2, b], [3, a], [3, b].
|
|
- You can see the exact syntax in the examples section.
|
|
options:
|
|
_terms:
|
|
description:
|
|
- A set of lists.
|
|
type: list
|
|
elements: list
|
|
required: true
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Example of the change in the description
|
|
ansible.builtin.debug:
|
|
msg: "{{ lookup('community.general.cartesian', [1,2,3], [a, b])}}"
|
|
|
|
- name: loops over the cartesian product of the supplied lists
|
|
ansible.builtin.debug:
|
|
msg: "{{item}}"
|
|
with_community.general.cartesian:
|
|
- "{{list1}}"
|
|
- "{{list2}}"
|
|
- [1, 2, 3, 4, 5, 6]
|
|
"""
|
|
|
|
RETURN = r"""
|
|
_list:
|
|
description:
|
|
- List of lists composed of elements of the input lists.
|
|
type: list
|
|
elements: list
|
|
"""
|
|
|
|
from itertools import product
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.lookup import LookupBase
|
|
from ansible.utils.listify import listify_lookup_plugin_terms
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
"""
|
|
Create the cartesian product of lists
|
|
"""
|
|
|
|
def _lookup_variables(self, terms):
|
|
"""
|
|
Turn this:
|
|
terms == ["1,2,3", "a,b"]
|
|
into this:
|
|
terms == [[1,2,3], [a, b]]
|
|
"""
|
|
results = []
|
|
for x in terms:
|
|
results.append(listify_lookup_plugin_terms(x, templar=self._templar))
|
|
return results
|
|
|
|
def run(self, terms, variables=None, **kwargs):
|
|
self.set_options(var_options=variables, direct=kwargs)
|
|
|
|
terms = self._lookup_variables(terms)
|
|
|
|
my_list = terms[:]
|
|
if len(my_list) == 0:
|
|
raise AnsibleError("with_cartesian requires at least one element in each list")
|
|
|
|
return [self._flatten(x) for x in product(*my_list)]
|