convert_to() - Code Metrics - Inspection of "doc: fix short title line" - ssato/python-anyconfig - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 98e1d4...d1821a )

by Satoru

created 2017-03-08 12:06 UTC

convert_to() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	2	Features	1

Metric	Value
cc	3
c	4
b	2
f	1
dl	0
loc	26
rs	8.8571

#
# Forked from m9dicts.{api,dicts}.
#
# Copyright (C) 2011 - 2015 Red Hat, Inc.
# Copyright (C) 2011 - 2017 Satoru SATOH <ssato redhat.com>
# License: MIT
#
r"""Utility functions to operate on mapping objects such as get, set and merge.

.. versionadded: 0.8.3
   define _update_* and merge functions based on classes in
   :mod:`m9dicts.dicts`

"""
from __future__ import absolute_import
import functools
import operator
import re
import anyconfig.utils


# Merge strategies:
MS_REPLACE = "replace"
MS_NO_REPLACE = "noreplace"
MS_DICTS = "merge_dicts"
MS_DICTS_AND_LISTS = "merge_dicts_and_lists"
MERGE_STRATEGIES = (MS_REPLACE, MS_NO_REPLACE, MS_DICTS, MS_DICTS_AND_LISTS)

PATH_SEPS = ('/', '.')

_JSNP_GET_ARRAY_IDX_REG = re.compile(r"(?:0|[1-9][0-9]*)")
_JSNP_SET_ARRAY_IDX = re.compile(r"(?:0|[1-9][0-9]*|-)")


def _jsnp_unescape(jsn_s):
    """
    Parse and decode given encoded JSON Pointer expression, convert ~1 to
    / and ~0 to ~.

    .. note:: JSON Pointer: http://tools.ietf.org/html/rfc6901

    >>> _jsnp_unescape("/a~1b")
    '/a/b'
    >>> _jsnp_unescape("~1aaa~1~0bbb")
    '/aaa/~bbb'
    """
    return jsn_s.replace('~1', '/').replace('~0', '~')


def _split_path(path, seps=PATH_SEPS):
    """
    Parse path expression and return list of path items.

    :param path: Path expression may contain separator chars.
    :param seps: Separator char candidates.
    :return: A list of keys to fetch object[s] later.

    >>> assert _split_path('') == []
    >>> assert _split_path('/') == ['']  # JSON Pointer spec expects this.
    >>> for p in ('/a', '.a', 'a', 'a.'):
    ...     assert _split_path(p) == ['a'], p
    >>> assert _split_path('/a/b/c') == _split_path('a.b.c') == ['a', 'b', 'c']
    >>> assert _split_path('abc') == ['abc']
    """
    if not path:
        return []

    for sep in seps:
        if sep in path:
            if path == sep:  # Special case, '/' or '.' only.
                return ['']
            return [x for x in path.split(sep) if x]

    return [path]


def mk_nested_dic(path, val, seps=PATH_SEPS):
    """
    Make a nested dict iteratively.

    :param path: Path expression to make a nested dict
    :param val: Value to set
    :param seps: Separator char candidates

    >>> mk_nested_dic("a.b.c", 1)
    {'a': {'b': {'c': 1}}}
    >>> mk_nested_dic("/a/b/c", 1)
    {'a': {'b': {'c': 1}}}
    """
    ret = None
    for key in reversed(_split_path(path, seps)):
        ret = {key: val if ret is None else ret.copy()}

    return ret


def get(dic, path, seps=PATH_SEPS, idx_reg=_JSNP_GET_ARRAY_IDX_REG):
    """getter for nested dicts.

    :param dic: a dict[-like] object
    :param path: Path expression to point object wanted
    :param seps: Separator char candidates
    :return: A tuple of (result_object, error_message)

    >>> d = {'a': {'b': {'c': 0, 'd': [1, 2]}}, '': 3}
    >>> assert get(d, '/') == (3, '')  # key becomes '' (empty string).
    >>> assert get(d, "/a/b/c") == (0, '')
    >>> sorted(get(d, "a.b")[0].items())
    [('c', 0), ('d', [1, 2])]
    >>> (get(d, "a.b.d"), get(d, "/a/b/d/1"))
    (([1, 2], ''), (2, ''))
    >>> get(d, "a.b.key_not_exist")  # doctest: +ELLIPSIS
    (None, "'...'")
    >>> get(d, "/a/b/d/2")
    (None, 'list index out of range')
    >>> get(d, "/a/b/d/-")  # doctest: +ELLIPSIS
    (None, 'list indices must be integers...')
    """
    items = [_jsnp_unescape(p) for p in _split_path(path, seps)]
    if not items:
        return (dic, '')
    try:
        if len(items) == 1:
            return (dic[items[0]], '')

        prnt = functools.reduce(operator.getitem, items[:-1], dic)
        arr = anyconfig.utils.is_list_like(prnt) and idx_reg.match(items[-1])
        return (prnt[int(items[-1])], '') if arr else (prnt[items[-1]], '')

    except (TypeError, KeyError, IndexError) as exc:
        return (None, str(exc))


def set_(dic, path, val, seps=PATH_SEPS):
    """setter for nested dicts.

    :param dic: a dict[-like] object support recursive merge operations
    :param path: Path expression to point object wanted
    :param seps: Separator char candidates

    >>> d = dict(a=1, b=dict(c=2, ))
    >>> set_(d, 'a.b.d', 3)
    >>> d['a']['b']['d']
    3
    """
    merge(dic, mk_nested_dic(path, val, seps), ac_merge=MS_DICTS)


def _are_list_like(*objs):
    """
    >>> _are_list_like([], (), [x for x in range(10)], (x for x in range(4)))
    True
    >>> _are_list_like([], {})
    False
    >>> _are_list_like([], "aaa")
    False
    """
    return all(anyconfig.utils.is_list_like(obj) for obj in objs)


def _update_with_replace(self, other, key, val=None, **options):
    """
    Replace value of a mapping object `self` with `other` has if both have same
    keys on update. Otherwise, just keep the value of `self`.

    :param self: mapping object to update with `other`
    :param other: mapping object to update `self`
    :param key: key of mapping object to update
    :param val: value to update self alternatively

    :return: None but `self` will be updated
    """
    self[key] = other[key] if val is None else val


def _update_wo_replace(self, other, key, val=None, **options):
    """
    Never update (replace) the value of `self` with `other`'s, that is, only
    the values `self` does not have its key will be added on update.

    :param self: mapping object to update with `other`
    :param other: mapping object to update `self`
    :param key: key of mapping object to update
    :param val: value to update self alternatively

    :return: None but `self` will be updated
    """
    if key not in self:
        _update_with_replace(self, other, key, val=val)


def _merge_list(self, key, lst):
    """
    :param key: self[key] will be updated
    :param lst: Other list to merge
    """
    self[key] += [x for x in lst if x not in self[key]]


def _merge_other(self, key, val):
    """
    :param key: self[key] will be updated
    :param val: Other val to merge (update/replace)
    """
    self[key] = val  # Just overwrite it by default implementation.


def _update_with_merge(self, other, key, val=None, merge_lists=False,
                       **options):
    """
    Merge the value of self with other's recursively. Behavior of merge will be
    vary depends on types of original and new values.

    - mapping vs. mapping -> merge recursively
    - list vs. list -> vary depends on `merge_lists`. see its description.

    :param other: a dict[-like] object or a list of (key, value) tuples
    :param key: key of mapping object to update
    :param val: value to update self[key]
    :param merge_lists:
        Merge not only dicts but also lists. For example,

        [1, 2, 3], [3, 4] ==> [1, 2, 3, 4]
        [1, 2, 2], [2, 4] ==> [1, 2, 2, 4]

    :return: None but `self` will be updated
    """
    if val is None:
        val = other[key]

    if key in self:
        val0 = self[key]  # Original value
        if anyconfig.utils.is_dict_like(val0):  # It needs recursive updates.
            merge(self[key], val, merge_lists=merge_lists, **options)
        elif merge_lists and _are_list_like(val, val0):
            _merge_list(self, key, val)
        else:
            _merge_other(self, key, val)
    else:
        self[key] = val


def _update_with_merge_lists(self, other, key, val=None, **options):
    """
    Similar to _update_with_merge but merge lists always.

    :param self: mapping object to update with `other`
    :param other: mapping object to update `self`
    :param key: key of mapping object to update
    :param val: value to update self alternatively

    :return: None but `self` will be updated
    """
    _update_with_merge(self, other, key, val=val, merge_lists=True, **options)


_MERGE_FNS = {MS_REPLACE: _update_with_replace,
              MS_NO_REPLACE: _update_wo_replace,
              MS_DICTS: _update_with_merge,
              MS_DICTS_AND_LISTS: _update_with_merge_lists}


def _get_update_fn(strategy):
    """
    Select dict-like class based on merge strategy and orderness of keys.

    :param merge: Specify strategy from MERGE_STRATEGIES of how to merge dicts.
    :return: Callable to update objects
    """
    if strategy is None:
        strategy = MS_DICTS
    try:
        return _MERGE_FNS[strategy]
    except KeyError:
        raise ValueError("Wrong merge strategy: %r" % strategy)


def merge(self, other, ac_merge=MS_DICTS, **options):
    """
    Update (merge) a mapping object `self` with other mapping object or an
    iterable yields (key, value) tuples based on merge strategy `ac_merge`.

    :param others: a list of dict[-like] objects or (key, value) tuples
    :param another: optional keyword arguments to update self more
    :param ac_merge: Merge strategy to choose
    """
    _update_fn = _get_update_fn(ac_merge)

    if hasattr(other, "keys"):
        for key in other:
            _update_fn(self, other, key, **options)
    else:
        try:
            for key, val in other:
                _update_fn(self, other, key, val=val, **options)
        except (ValueError, TypeError) as exc:  # Re-raise w/ info.
            raise type(exc)("%s other=%r" % (str(exc), other))


def _make_recur(obj, make_fn, ac_ordered=False, ac_dict=None, **options):
    """
    :param obj: A mapping objects or other primitive object
    :param make_fn: Function to make/convert to
    :param ac_ordered: Use OrderedDict instead of dict to keep order of items
    :param ac_dict: Callable to convert `obj` to mapping object
    :param options: Optional keyword arguments.

    :return: Mapping object
    """
    if ac_dict is None:
        ac_dict = anyconfig.compat.OrderedDict if ac_ordered else dict

    return ac_dict((k, None if v is None else make_fn(v, **options))
                   for k, v in obj.items())


def _make_iter(obj, make_fn, **options):
    """
    :param obj: A mapping objects or other primitive object
    :param make_fn: Function to make/convert to
    :param options: Optional keyword arguments.

    :return: Mapping object
    """
    return type(obj)(make_fn(v, **options) for v in obj)


def convert_to(obj, ac_ordered=False, ac_dict=None, **options):
    """
    Convert a mapping objects to a dict or object of `to_type` recursively.
    Borrowed basic idea and implementation from bunch.unbunchify. (bunch is
    distributed under MIT license same as this.)

    :param obj: A mapping objects or other primitive object
    :param ac_ordered: Use OrderedDict instead of dict to keep order of items
    :param ac_dict: Callable to convert `obj` to mapping object
    :param options: Optional keyword arguments.

    :return: A dict or OrderedDict or object of `cls`

    >>> OD = anyconfig.compat.OrderedDict
    >>> convert_to(OD((('a', 1) ,)), cls=dict)
    {'a': 1}
    >>> convert_to(OD((('a', OD((('b', OD((('c', 1), ))), ))), )), cls=dict)
    {'a': {'b': {'c': 1}}}
    """
    options.update(ac_ordered=ac_ordered, ac_dict=ac_dict)
    if anyconfig.utils.is_dict_like(obj):
        return _make_recur(obj, convert_to, **options)
    elif anyconfig.utils.is_list_like(obj):
        return _make_iter(obj, convert_to, **options)
    else:
        return obj

# vim:sw=4:ts=4:et:


1			#
2			# Forked from m9dicts.{api,dicts}.
3			#
4			# Copyright (C) 2011 - 2015 Red Hat, Inc.
5			# Copyright (C) 2011 - 2017 Satoru SATOH <ssato redhat.com>
6			# License: MIT
7			#
8			r"""Utility functions to operate on mapping objects such as get, set and merge.
9
10			.. versionadded: 0.8.3
11			define _update_* and merge functions based on classes in
12			:mod:`m9dicts.dicts`
13
14			"""
15			from __future__ import absolute_import
16			import functools
17			import operator
18			import re
19			import anyconfig.utils
20
21
22			# Merge strategies:
23			MS_REPLACE = "replace"
24			MS_NO_REPLACE = "noreplace"
25			MS_DICTS = "merge_dicts"
26			MS_DICTS_AND_LISTS = "merge_dicts_and_lists"
27			MERGE_STRATEGIES = (MS_REPLACE, MS_NO_REPLACE, MS_DICTS, MS_DICTS_AND_LISTS)
28
29			PATH_SEPS = ('/', '.')
30
31			_JSNP_GET_ARRAY_IDX_REG = re.compile(r"(?:0\|[1-9][0-9]*)")
32			_JSNP_SET_ARRAY_IDX = re.compile(r"(?:0\|[1-9][0-9]*\|-)")
33
34
35			def _jsnp_unescape(jsn_s):
36			"""
37			Parse and decode given encoded JSON Pointer expression, convert ~1 to
38			/ and ~0 to ~.
39
40			.. note:: JSON Pointer: http://tools.ietf.org/html/rfc6901
41
42			>>> _jsnp_unescape("/a~1b")
43			'/a/b'
44			>>> _jsnp_unescape("~1aaa~1~0bbb")
45			'/aaa/~bbb'
46			"""
47			return jsn_s.replace('~1', '/').replace('~0', '~')
48
49
50			def _split_path(path, seps=PATH_SEPS):
51			"""
52			Parse path expression and return list of path items.
53
54			:param path: Path expression may contain separator chars.
55			:param seps: Separator char candidates.
56			:return: A list of keys to fetch object[s] later.
57
58			>>> assert _split_path('') == []
59			>>> assert _split_path('/') == [''] # JSON Pointer spec expects this.
60			>>> for p in ('/a', '.a', 'a', 'a.'):
61			... assert _split_path(p) == ['a'], p
62			>>> assert _split_path('/a/b/c') == _split_path('a.b.c') == ['a', 'b', 'c']
63			>>> assert _split_path('abc') == ['abc']
64			"""
65			if not path:
66			return []
67
68			for sep in seps:
69			if sep in path:
70			if path == sep: # Special case, '/' or '.' only.
71			return ['']
72			return [x for x in path.split(sep) if x]
73
74			return [path]
75
76
77			def mk_nested_dic(path, val, seps=PATH_SEPS):
78			"""
79			Make a nested dict iteratively.
80
81			:param path: Path expression to make a nested dict
82			:param val: Value to set
83			:param seps: Separator char candidates
84
85			>>> mk_nested_dic("a.b.c", 1)
86			{'a': {'b': {'c': 1}}}
87			>>> mk_nested_dic("/a/b/c", 1)
88			{'a': {'b': {'c': 1}}}
89			"""
90			ret = None
91			for key in reversed(_split_path(path, seps)):
92			ret = {key: val if ret is None else ret.copy()}
93
94			return ret
95
96
97			def get(dic, path, seps=PATH_SEPS, idx_reg=_JSNP_GET_ARRAY_IDX_REG):
98			"""getter for nested dicts.
99
100			:param dic: a dict[-like] object
101			:param path: Path expression to point object wanted
102			:param seps: Separator char candidates
103			:return: A tuple of (result_object, error_message)
104
105			>>> d = {'a': {'b': {'c': 0, 'd': [1, 2]}}, '': 3}
106			>>> assert get(d, '/') == (3, '') # key becomes '' (empty string).
107			>>> assert get(d, "/a/b/c") == (0, '')
108			>>> sorted(get(d, "a.b")[0].items())
109			[('c', 0), ('d', [1, 2])]
110			>>> (get(d, "a.b.d"), get(d, "/a/b/d/1"))
111			(([1, 2], ''), (2, ''))
112			>>> get(d, "a.b.key_not_exist") # doctest: +ELLIPSIS
113			(None, "'...'")
114			>>> get(d, "/a/b/d/2")
115			(None, 'list index out of range')
116			>>> get(d, "/a/b/d/-") # doctest: +ELLIPSIS
117			(None, 'list indices must be integers...')
118			"""
119			items = [_jsnp_unescape(p) for p in _split_path(path, seps)]
120			if not items:
121			return (dic, '')
122			try:
123			if len(items) == 1:
124			return (dic[items[0]], '')
125
126			prnt = functools.reduce(operator.getitem, items[:-1], dic)
127			arr = anyconfig.utils.is_list_like(prnt) and idx_reg.match(items[-1])
128			return (prnt[int(items[-1])], '') if arr else (prnt[items[-1]], '')
129
130			except (TypeError, KeyError, IndexError) as exc:
131			return (None, str(exc))
132
133
134			def set_(dic, path, val, seps=PATH_SEPS):
135			"""setter for nested dicts.
136
137			:param dic: a dict[-like] object support recursive merge operations
138			:param path: Path expression to point object wanted
139			:param seps: Separator char candidates
140
141			>>> d = dict(a=1, b=dict(c=2, ))
142			>>> set_(d, 'a.b.d', 3)
143			>>> d['a']['b']['d']
144			3
145			"""
146			merge(dic, mk_nested_dic(path, val, seps), ac_merge=MS_DICTS)
147
148
149			def _are_list_like(*objs):
150			"""
151			>>> _are_list_like([], (), [x for x in range(10)], (x for x in range(4)))
152			True
153			>>> _are_list_like([], {})
154			False
155			>>> _are_list_like([], "aaa")
156			False
157			"""
158			return all(anyconfig.utils.is_list_like(obj) for obj in objs)
159
160
161			def _update_with_replace(self, other, key, val=None, **options):
162			"""
163			Replace value of a mapping object `self` with `other` has if both have same
164			keys on update. Otherwise, just keep the value of `self`.
165
166			:param self: mapping object to update with `other`
167			:param other: mapping object to update `self`
168			:param key: key of mapping object to update
169			:param val: value to update self alternatively
170
171			:return: None but `self` will be updated
172			"""
173			self[key] = other[key] if val is None else val
174
175
176			def _update_wo_replace(self, other, key, val=None, **options):
177			"""
178			Never update (replace) the value of `self` with `other`'s, that is, only
179			the values `self` does not have its key will be added on update.
180
181			:param self: mapping object to update with `other`
182			:param other: mapping object to update `self`
183			:param key: key of mapping object to update
184			:param val: value to update self alternatively
185
186			:return: None but `self` will be updated
187			"""
188			if key not in self:
189			_update_with_replace(self, other, key, val=val)
190
191
192			def _merge_list(self, key, lst):
193			"""
194			:param key: self[key] will be updated
195			:param lst: Other list to merge
196			"""
197			self[key] += [x for x in lst if x not in self[key]]
198
199
200			def _merge_other(self, key, val):
201			"""
202			:param key: self[key] will be updated
203			:param val: Other val to merge (update/replace)
204			"""
205			self[key] = val # Just overwrite it by default implementation.
206
207
208			def _update_with_merge(self, other, key, val=None, merge_lists=False,
209			**options):
210			"""
211			Merge the value of self with other's recursively. Behavior of merge will be
212			vary depends on types of original and new values.
213
214			- mapping vs. mapping -> merge recursively
215			- list vs. list -> vary depends on `merge_lists`. see its description.
216
217			:param other: a dict[-like] object or a list of (key, value) tuples
218			:param key: key of mapping object to update
219			:param val: value to update self[key]
220			:param merge_lists:
221			Merge not only dicts but also lists. For example,
222
223			[1, 2, 3], [3, 4] ==> [1, 2, 3, 4]
224			[1, 2, 2], [2, 4] ==> [1, 2, 2, 4]
225
226			:return: None but `self` will be updated
227			"""
228			if val is None:
229			val = other[key]
230
231			if key in self:
232			val0 = self[key] # Original value
233			if anyconfig.utils.is_dict_like(val0): # It needs recursive updates.
234			merge(self[key], val, merge_lists=merge_lists, **options)
235			elif merge_lists and _are_list_like(val, val0):
236			_merge_list(self, key, val)
237			else:
238			_merge_other(self, key, val)
239			else:
240			self[key] = val
241
242
243			def _update_with_merge_lists(self, other, key, val=None, **options):
244			"""
245			Similar to _update_with_merge but merge lists always.
246
247			:param self: mapping object to update with `other`
248			:param other: mapping object to update `self`
249			:param key: key of mapping object to update
250			:param val: value to update self alternatively
251
252			:return: None but `self` will be updated
253			"""
254			_update_with_merge(self, other, key, val=val, merge_lists=True, **options)
255
256
257			_MERGE_FNS = {MS_REPLACE: _update_with_replace,
258			MS_NO_REPLACE: _update_wo_replace,
259			MS_DICTS: _update_with_merge,
260			MS_DICTS_AND_LISTS: _update_with_merge_lists}
261
262
263			def _get_update_fn(strategy):
264			"""
265			Select dict-like class based on merge strategy and orderness of keys.
266
267			:param merge: Specify strategy from MERGE_STRATEGIES of how to merge dicts.
268			:return: Callable to update objects
269			"""
270			if strategy is None:
271			strategy = MS_DICTS
272			try:
273			return _MERGE_FNS[strategy]
274			except KeyError:
275			raise ValueError("Wrong merge strategy: %r" % strategy)
276
277
278			def merge(self, other, ac_merge=MS_DICTS, **options):
279			"""
280			Update (merge) a mapping object `self` with other mapping object or an
281			iterable yields (key, value) tuples based on merge strategy `ac_merge`.
282
283			:param others: a list of dict[-like] objects or (key, value) tuples
284			:param another: optional keyword arguments to update self more
285			:param ac_merge: Merge strategy to choose
286			"""
287			_update_fn = _get_update_fn(ac_merge)
288
289			if hasattr(other, "keys"):
290			for key in other:
291			_update_fn(self, other, key, **options)
292			else:
293			try:
294			for key, val in other:
295			_update_fn(self, other, key, val=val, **options)
296			except (ValueError, TypeError) as exc: # Re-raise w/ info.
297			raise type(exc)("%s other=%r" % (str(exc), other))
298
299
300			def _make_recur(obj, make_fn, ac_ordered=False, ac_dict=None, **options):
301			"""
302			:param obj: A mapping objects or other primitive object
303			:param make_fn: Function to make/convert to
304			:param ac_ordered: Use OrderedDict instead of dict to keep order of items
305			:param ac_dict: Callable to convert `obj` to mapping object
306			:param options: Optional keyword arguments.
307
308			:return: Mapping object
309			"""
310			if ac_dict is None:
311			ac_dict = anyconfig.compat.OrderedDict if ac_ordered else dict
312
313			return ac_dict((k, None if v is None else make_fn(v, **options))
314			for k, v in obj.items())
315
316
317			def _make_iter(obj, make_fn, **options):
318			"""
319			:param obj: A mapping objects or other primitive object
320			:param make_fn: Function to make/convert to
321			:param options: Optional keyword arguments.
322
323			:return: Mapping object
324			"""
325			return type(obj)(make_fn(v, **options) for v in obj)
326
327
328			def convert_to(obj, ac_ordered=False, ac_dict=None, **options):
329			"""
330			Convert a mapping objects to a dict or object of `to_type` recursively.
331			Borrowed basic idea and implementation from bunch.unbunchify. (bunch is
332			distributed under MIT license same as this.)
333
334			:param obj: A mapping objects or other primitive object
335			:param ac_ordered: Use OrderedDict instead of dict to keep order of items
336			:param ac_dict: Callable to convert `obj` to mapping object
337			:param options: Optional keyword arguments.
338
339			:return: A dict or OrderedDict or object of `cls`
340
341			>>> OD = anyconfig.compat.OrderedDict
342			>>> convert_to(OD((('a', 1) ,)), cls=dict)
343			{'a': 1}
344			>>> convert_to(OD((('a', OD((('b', OD((('c', 1), ))), ))), )), cls=dict)
345			{'a': {'b': {'c': 1}}}
346			"""
347			options.update(ac_ordered=ac_ordered, ac_dict=ac_dict)
348			if anyconfig.utils.is_dict_like(obj):
349			return _make_recur(obj, convert_to, **options)
350			elif anyconfig.utils.is_list_like(obj):
351			return _make_iter(obj, convert_to, **options)
352			else:
353			return obj
354
355			# vim:sw=4:ts=4:et:
356

ssato / python-anyconfig

Push — master ( 98e1d4...d1821a )

convert_to() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like