src/pyams_utils/dict.py
changeset 289 c8e21d7dd685
child 292 b338586588ad
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pyams_utils/dict.py	Wed Dec 05 12:45:56 2018 +0100
@@ -0,0 +1,54 @@
+#
+# 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.
+#
+
+__docformat__ = 'restructuredtext'
+
+
+# import standard library
+
+# import interfaces
+
+# import packages
+
+
+def update_dict(input, key, value):
+    """Update given mapping if input value is a boolean 'true' value
+
+    :param dict input: 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[key] = value