openstack-ansible/lib/dictutils.py
Steve Lewis 249db3ae5c Refactoring inventory generation data manipulation
Segmenting out changes to the inventory generation script which are
related to datastructure manipulations in preparation for segmenting
out storage-related operations.

Change-Id: I3160862b4fea92bce4c951107e154fd3ddc21234
2016-11-15 14:50:43 -08:00

83 lines
2.7 KiB
Python

# Copyright 2014, Rackspace US, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# (c) 2014, Kevin Carter <kevin.carter@rackspace.com>
# (c) 2015, Major Hayden <major@mhtx.net>
#
def merge_dict(base_items, new_items):
"""Recursively merge new_items into some base_items.
If an empty dictionary is provided as a new value, it will
completely replace the existing dictionary.
:param base_items: ``dict``
:param new_items: ``dict``
:return dictionary:
"""
for key, value in new_items.iteritems():
if isinstance(value, dict) and value:
base_merge = merge_dict(base_items.get(key, {}), value)
base_items[key] = base_merge
else:
base_items[key] = new_items[key]
return base_items
def append_if(array, item):
"""Append an ``item`` to an ``array`` if its not already in it.
:param array: ``list`` List object to append to
:param item: ``object`` Object to append to the list
:returns bool: Flag indicating whether the append happend (True)
or not (False)
"""
if item not in array:
array.append(item)
return True
return False
def recursive_list_removal(inventory, purge_list):
"""Remove items from a list.
:param inventory: ``dict`` Dictionary representing the inventory
:param purge_list: ``list`` List of items to remove
"""
for item in purge_list:
for _item in inventory:
if item == _item:
inventory.pop(inventory.index(item))
def recursive_dict_removal(inventory, purge_list):
"""Remove items from a dictionary.
Keyword arguments:
:param inventory: ``dict`` Dictionary representing the inventory
:param purge_list: ``list`` List of items to remove
"""
for key, value in inventory.iteritems():
if isinstance(value, dict):
for _key, _value in value.iteritems():
if isinstance(_value, dict):
for item in purge_list:
if item in _value:
del(_value[item])
elif isinstance(_value, list):
recursive_list_removal(_value, purge_list)
elif isinstance(value, list):
recursive_list_removal(value, purge_list)