Skip to content

chunklet.common.dotdict

DotDict/DotList with Box-compatible serialization.

This module embeds code originally from dotdict3 (MIT License). Co-authored by: - speedyk-005 - Patrick Elmer patrick@elmer.ws (https://github.com/dotdict/dotdict3)

Modifications: added to_dict(), to_json(), to_yaml(), to_msgpack(), to_toml(), to_csv() for backward compatibility with the python-box API.

Classes:

  • DotDict –

    A dict subclass with dot-notation access and automatic nested conversion.

  • DotList –

    A list subclass with automatic nested dict/list conversion.

DotDict 

DotDict(data=None)

Bases: dict

A dict subclass with dot-notation access and automatic nested conversion.

Basic usage::

>>> d = DotDict({"name": "John", "age": 30})
>>> d.name
'John'
>>> d.age
30

Nested dicts auto-convert::

>>> d = DotDict({"user": {"name": "Bob", "age": 25}})
>>> d.user.name
'Bob'
>>> d.user.age
25

Lists auto-convert to DotList::

>>> d = DotDict({"users": [{"name": "Alice"}, {"name": "Bob"}]})
>>> d.users[0].name
'Alice'
>>> isinstance(d.users, DotList)
True

Dot notation assignment::

>>> d = DotDict()
>>> d.name = "Alice"
>>> d.name
'Alice'

Methods:

  • to_dict –

    Recursively convert back to a plain dict.

  • to_json –

    Serialize to a JSON string, or write to a file if filename is given.

  • to_msgpack –

    Serialize to MessagePack bytes, or write to a file if filename is given.

Source code in src/chunklet/common/dotdict.py 
52
53
54
55
def __init__(self, data=None):
    if data is not None:
        for key, value in data.items():
            self[key] = value

to_dict 

to_dict()

Recursively convert back to a plain dict.

d = DotDict({"a": {"b": 1}, "c": [{"d": 2}]}) d.to_dict() {'a': {'b': 1}, 'c': [{'d': 2}]}

Source code in src/chunklet/common/dotdict.py 
65
66
67
68
69
70
71
72
def to_dict(self):
    """Recursively convert back to a plain dict.

    >>> d = DotDict({"a": {"b": 1}, "c": [{"d": 2}]})
    >>> d.to_dict()
    {'a': {'b': 1}, 'c': [{'d': 2}]}
    """
    return {k: _to_plain(v) for k, v in self.items()}

to_json 

to_json(filename=None, **kwargs)

Serialize to a JSON string, or write to a file if filename is given.

DotDict({"content": "Hello", "count": 3}).to_json() '{"content": "Hello", "count": 3}'

Source code in src/chunklet/common/dotdict.py 
74
75
76
77
78
79
80
81
82
83
84
def to_json(self, filename=None, **kwargs):
    """Serialize to a JSON string, or write to a file if *filename* is given.

    >>> DotDict({"content": "Hello", "count": 3}).to_json()
    '{"content": "Hello", "count": 3}'
    """
    if filename:
        with open(filename, "w", encoding="utf-8") as f:
            json.dump(self.to_dict(), f, ensure_ascii=False, **kwargs)
    else:
        return json.dumps(self.to_dict(), ensure_ascii=False, **kwargs)

to_msgpack 

to_msgpack(filename=None, **kwargs)

Serialize to MessagePack bytes, or write to a file if filename is given.

import msgpack d = DotDict({"a": 1, "b": [2, 3]}) msgpack.unpackb(d.to_msgpack())

Source code in src/chunklet/common/dotdict.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def to_msgpack(self, filename=None, **kwargs):
    """Serialize to MessagePack bytes, or write to a file if *filename* is given.

    >>> import msgpack
    >>> d = DotDict({"a": 1, "b": [2, 3]})
    >>> msgpack.unpackb(d.to_msgpack())
    {'a': 1, 'b': [2, 3]}
    """
    try:
        import msgpack
    except ImportError:
        raise ImportError("msgpack required: pip install msgpack") from None
    if filename:
        with open(filename, "wb") as f:
            msgpack.pack(self.to_dict(), f, **kwargs)
    else:
        return msgpack.packb(self.to_dict(), **kwargs)

DotList 

DotList(items=None)

Bases: list

A list subclass with automatic nested dict/list conversion.

l = DotList([{"a": 1}, {"b": 2}]) l[0].a 1 l[1].b 2

Methods:

  • to_dict –

    Recursively convert back to a plain list.

Source code in src/chunklet/common/dotdict.py 
141
142
143
144
def __init__(self, items=None):
    if items is not None:
        for item in items:
            self.append(item)

to_dict 

to_dict()

Recursively convert back to a plain list.

DotList([DotDict({"a": 1}), DotDict({"b": 2})]).to_dict() [{'a': 1}, {'b': 2}]

Source code in src/chunklet/common/dotdict.py 
152
153
154
155
156
157
158
def to_dict(self):
    """Recursively convert back to a plain list.

    >>> DotList([DotDict({"a": 1}), DotDict({"b": 2})]).to_dict()
    [{'a': 1}, {'b': 2}]
    """
    return [_to_plain(v) for v in self]