Source code for pyams_utils.dict

#
# Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#

"""PyAMS_utils.dict module

This helper module only contains a single function which can be used to update an input
dictionary; if given value argument is a boolean 'true' value, given dictionary's key is created
or updated, otherwise dictionary is left unchanged.
"""

__docformat__ = 'restructuredtext'


[docs]def update_dict(input_dict, key, value): """Update given mapping if input value is a boolean 'True' value :param dict input_dict: input dictionary :param key: mapping key :param value: new value 'False' values leave mapping unchanged:: >>> from pyams_utils.dict import update_dict >>> mydict = {} >>> update_dict(mydict, 'key1', None) >>> mydict {} >>> update_dict(mydict, 'key1', '') >>> mydict {} >>> update_dict(mydict, 'key1', 0) >>> mydict {} 'True' values modify the mapping:: >>> update_dict(mydict, 'key1', 'value') >>> mydict {'key1': 'value'} >>> update_dict(mydict, 'key1', 'value2') >>> mydict {'key1': 'value2'} """ if value: input_dict[key] = value