1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Test files gathered from json.org and yaml.org
import json
import os
import shutil
import sys
import platform
from pathlib import Path
from io import StringIO
from test.common import test_root, tmp_dir
import pytest
from ruamel.yaml import YAML
from box import Box, BoxError, BoxList
from box.converters import toml_read_library, toml_write_library
class TestBoxList:
@pytest.fixture(autouse=True)
def temp_dir_cleanup(self):
shutil.rmtree(str(tmp_dir), ignore_errors=True)
try:
os.mkdir(str(tmp_dir))
except OSError:
pass
yield
shutil.rmtree(str(tmp_dir), ignore_errors=True)
def test_box_list(self):
new_list = BoxList({"item": x} for x in range(0, 10))
new_list.extend([{"item": 22}])
assert new_list[-1].item == 22
new_list.append([{"bad_item": 33}])
assert new_list[-1][0].bad_item == 33
new_list[-1].append([{"bad_item": 33}])
assert new_list[-1, -1, 0].bad_item == 33
bx = Box({0: {1: {2: {3: 3}}}, (0, 1, 2, 3): 4})
assert bx[0, 1, 2, 3] == 4
assert repr(new_list).startswith("BoxList(")
for x in new_list.to_list():
assert not isinstance(x, (BoxList, Box))
new_list.insert(0, {"test": 5})
new_list.insert(1, ["a", "b"])
new_list.append("x")
assert new_list[0].test == 5
assert isinstance(str(new_list), str)
assert isinstance(new_list[1], BoxList)
assert not isinstance(new_list.to_list(), BoxList)
def test_frozen_list(self):
bl = BoxList([5, 4, 3], frozen_box=True)
with pytest.raises(BoxError):
bl.pop(1)
with pytest.raises(BoxError):
bl.remove(4)
with pytest.raises(BoxError):
bl.sort()
with pytest.raises(BoxError):
bl.reverse()
with pytest.raises(BoxError):
bl.append("test")
with pytest.raises(BoxError):
bl.extend([4])
with pytest.raises(BoxError):
del bl[0]
with pytest.raises(BoxError):
bl[0] = 5
bl2 = BoxList([5, 4, 3])
del bl2[0]
assert bl2[0] == 4
bl2[1] = 4
assert bl2[1] == 4
def test_box_list_to_json(self):
bl = BoxList([{"item": 1, "CamelBad": 2}])
assert json.loads(bl.to_json())[0]["item"] == 1
def test_box_list_from_json(self):
alist = [{"item": 1}, {"CamelBad": 2}]
json_list = json.dumps(alist)
bl = BoxList.from_json(json_list, camel_killer_box=True)
assert bl[0].item == 1
assert bl[1].camel_bad == 2
with pytest.raises(BoxError):
BoxList.from_json(json.dumps({"a": 2}))
def test_box_list_to_yaml(self):
bl = BoxList([{"item": 1, "CamelBad": 2}])
yaml = YAML()
assert yaml.load(bl.to_yaml())[0]["item"] == 1
def test_box_list_from_yaml(self):
alist = [{"item": 1}, {"CamelBad": 2}]
yaml = YAML()
with StringIO() as sio:
yaml.dump(alist, stream=sio)
bl = BoxList.from_yaml(sio.getvalue(), camel_killer_box=True)
assert bl[0].item == 1
assert bl[1].camel_bad == 2
with pytest.raises(BoxError):
BoxList.from_yaml("a: 2")
def test_box_list_to_toml(self):
bl = BoxList([{"item": 1, "CamelBad": 2}])
assert toml_read_library.loads(bl.to_toml(key_name="test"))["test"][0]["item"] == 1
with pytest.raises(BoxError):
BoxList.from_toml("[[test]]\nitem = 1\nCamelBad = 2\n\n", key_name="does not exist")
def test_box_list_from_tml(self):
alist = [{"item": 1}, {"CamelBad": 2}]
toml_list = toml_write_library.dumps({"key": alist})
bl = BoxList.from_toml(toml_string=toml_list, key_name="key", camel_killer_box=True)
assert bl[0].item == 1
assert bl[1].camel_bad == 2
with pytest.raises(BoxError):
BoxList.from_toml(toml_write_library.dumps({"a": 2}), "a")
with pytest.raises(BoxError):
BoxList.from_toml(toml_list, "bad_key")
def test_intact_types_list(self):
class MyList(list):
pass
bl = BoxList([[1, 2], MyList([3, 4])], box_intact_types=(MyList,))
assert isinstance(bl[0], BoxList)
def test_to_csv(self):
data = BoxList(
[
{"Number": 1, "Name": "Chris", "Country": "US"},
{"Number": 2, "Name": "Sam", "Country": "US"},
{"Number": 3, "Name": "Jess", "Country": "US"},
{"Number": 4, "Name": "Frank", "Country": "UK"},
{"Number": 5, "Name": "Demo", "Country": "CA"},
]
)
file = Path(tmp_dir, "csv_file.csv")
data.to_csv(filename=file)
assert file.read_text().startswith("Number,Name,Country\n1,Chris,US")
assert data.to_csv().endswith("2,Sam,US\r\n3,Jess,US\r\n4,Frank,UK\r\n5,Demo,CA\r\n")
def test_from_csv(self):
bl = BoxList.from_csv(filename=Path(test_root, "data", "csv_file.csv"))
assert bl[1].Name == "Sam"
b2 = BoxList.from_csv(
"Number,Name,Country\r\n1,Chris,US\r\n2,Sam" ",US\r\n3,Jess,US\r\n4,Frank,UK\r\n5,Demo,CA\r\n"
)
assert b2[2].Name == "Jess"
def test_bad_csv(self):
data = BoxList([{"test": 1}, {"bad": 2, "data": 3}])
file = Path(tmp_dir, "csv_file.csv")
with pytest.raises(BoxError):
data.to_csv(file)
def test_box_list_dots(self):
data = BoxList(
[
{"test": 1},
{"bad": 2, "data": 3},
[[[0, -1], [77, 88]], {"inner": "one", "lister": [[{"down": "rabbit"}]]}],
4,
],
box_dots=True,
)
assert data["[0].test"] == 1
assert data["[1].data"] == 3
assert data[1].data == 3
data["[1].data"] = "new_data"
assert data["[1].data"] == "new_data"
assert data["[2][0][0][1]"] == -1
assert data[2][0][0][1] == -1
data["[2][0][0][1]"] = 1_000_000
assert data["[2][0][0][1]"] == 1_000_000
assert data[2][0][0][1] == 1_000_000
assert data["[2][1].lister[0][0].down"] == "rabbit"
data["[2][1].lister[0][0].down"] = "hole"
assert data["[2][1].lister[0][0].down"] == "hole"
assert data[2][1].lister[0][0].down == "hole"
db = Box(a=data, box_dots=True)
keys = db.keys(dotted=True)
assert keys == [
"a[0].test",
"a[1].bad",
"a[1].data",
"a[2][0][0][0]",
"a[2][0][0][1]",
"a[2][0][1][0]",
"a[2][0][1][1]",
"a[2][1].inner",
"a[2][1].lister[0][0].down",
"a[3]",
]
for key in keys:
db[key]
def test_box_list_default_dots(self):
box_1 = Box(default_box=True, box_dots=True)
box_1["a[0]"] = 42
assert box_1.a[0] == 42
box_1["b[0].c[0].d"] = 42
assert box_1.b[0].c[0].d == 42
box_1["c[0][0][0]"] = 42
assert box_1.c[0][0][0] == 42
box_2 = Box(default_box=True, box_dots=True)
box_2["a[4]"] = 42
assert box_2.a.to_list() == [None, None, None, None, 42]
box_3 = Box(default_box=True, box_dots=True)
box_3["a.b[0]"] = 42
assert box_3.a.b[0] == 42
def test_box_config_propagate(self):
structure = Box(a=[Box(default_box=False)], default_box=True, box_inherent_settings=True)
assert structure._box_config["default_box"] is True
assert structure.a[0]._box_config["default_box"] is True
base = BoxList([BoxList([Box(default_box=False)])], default_box=True)
assert base[0].box_options["default_box"] is True
base2 = BoxList((BoxList([Box()], default_box=False),), default_box=True)
assert base2[0][0]._box_config["default_box"] is True
base3 = Box(
a=[Box(default_box=False)], default_box=True, box_inherent_settings=True, box_intact_types=[Box, BoxList]
)
base3.a.append(Box(default_box=False))
base3.a.append(BoxList(default_box=False))
for item in base3.a:
if isinstance(item, Box):
assert item._box_config["default_box"] is True
elif isinstance(item, BoxList):
assert item.box_options["default_box"] is True
def test_no_recursion_errors(self):
a = Box({"list_of_dicts": [[{"example1": 1}]]})
a.list_of_dicts.append([{"example2": 2}])
assert a["list_of_dicts"][1] == [{"example2": 2}]
def test_circular_references(self):
circular_list = []
circular_list.append(circular_list)
circular_box = BoxList(circular_list)
assert circular_box[0] == circular_box
|
