mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
0ba06f8d82
* Fix/improve docs.
* Document the a_module test.
* Document the dict filter.
* Linting.
* Add more filter docs.
* More filters.
* Update BOTMETA.
* Add another plugin.
* Fix typos.
* Add explicit entries.
* Fix lookup documentation.
(cherry picked from commit f055f47161)
88 lines
2.7 KiB
Python
88 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2021, Felix Fontein <felix@fontein.de>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
name: groupby_as_dict
|
|
short_description: Transform a sequence of dictionaries to a dictionary where the dictionaries are indexed by an attribute
|
|
version_added: 3.1.0
|
|
author: Felix Fontein (@felixfontein)
|
|
description:
|
|
- Transform a sequence of dictionaries to a dictionary where the dictionaries are indexed by an attribute.
|
|
positional: attribute
|
|
options:
|
|
_input:
|
|
description: A list of dictionaries
|
|
type: list
|
|
elements: dictionary
|
|
required: true
|
|
attribute:
|
|
description: The attribute to use as the key.
|
|
type: str
|
|
required: true
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Arrange a list of dictionaries as a dictionary of dictionaries
|
|
ansible.builtin.debug:
|
|
msg: "{{ sequence | community.general.groupby_as_dict('key') }}"
|
|
vars:
|
|
sequence:
|
|
- key: value
|
|
foo: bar
|
|
- key: other_value
|
|
baz: bar
|
|
# Produces the following nested structure:
|
|
#
|
|
# value:
|
|
# key: value
|
|
# foo: bar
|
|
# other_value:
|
|
# key: other_value
|
|
# baz: bar
|
|
'''
|
|
|
|
RETURN = '''
|
|
_value:
|
|
description: A dictionary containing the dictionaries from the list as values.
|
|
type: dictionary
|
|
'''
|
|
|
|
from ansible.errors import AnsibleFilterError
|
|
from ansible.module_utils.common._collections_compat import Mapping, Sequence
|
|
|
|
|
|
def groupby_as_dict(sequence, attribute):
|
|
'''
|
|
Given a sequence of dictionaries and an attribute name, returns a dictionary mapping
|
|
the value of this attribute to the dictionary.
|
|
|
|
If multiple dictionaries in the sequence have the same value for this attribute,
|
|
the filter will fail.
|
|
'''
|
|
if not isinstance(sequence, Sequence):
|
|
raise AnsibleFilterError('Input is not a sequence')
|
|
|
|
result = dict()
|
|
for list_index, element in enumerate(sequence):
|
|
if not isinstance(element, Mapping):
|
|
raise AnsibleFilterError('Sequence element #{0} is not a mapping'.format(list_index))
|
|
if attribute not in element:
|
|
raise AnsibleFilterError('Attribute not contained in element #{0} of sequence'.format(list_index))
|
|
result_index = element[attribute]
|
|
if result_index in result:
|
|
raise AnsibleFilterError('Multiple sequence entries have attribute value {0!r}'.format(result_index))
|
|
result[result_index] = element
|
|
return result
|
|
|
|
|
|
class FilterModule(object):
|
|
''' Ansible list filters '''
|
|
|
|
def filters(self):
|
|
return {
|
|
'groupby_as_dict': groupby_as_dict,
|
|
}
|