summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/general/plugins/lookup/cartesian.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/general/plugins/lookup/cartesian.py')
-rw-r--r--ansible_collections/community/general/plugins/lookup/cartesian.py87
1 files changed, 87 insertions, 0 deletions
diff --git a/ansible_collections/community/general/plugins/lookup/cartesian.py b/ansible_collections/community/general/plugins/lookup/cartesian.py
new file mode 100644
index 000000000..d63f3943b
--- /dev/null
+++ b/ansible_collections/community/general/plugins/lookup/cartesian.py
@@ -0,0 +1,87 @@
+# -*- 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 = '''
+ 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 = """
+- 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 = """
+ _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:
+ try:
+ intermediate = listify_lookup_plugin_terms(x, templar=self._templar)
+ except TypeError:
+ # The loader argument is deprecated in ansible-core 2.14+. Fall back to
+ # pre-2.14 behavior for older ansible-core versions.
+ intermediate = listify_lookup_plugin_terms(x, templar=self._templar, loader=self._loader)
+ results.append(intermediate)
+ 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)]