File: test_builder.py

package info (click to toggle)
hdmf 3.14.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,372 kB
  • sloc: python: 34,738; makefile: 303; sh: 35
file content (403 lines) | stat: -rw-r--r-- 14,154 bytes parent folder | download | duplicates (4)
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
from hdmf.build import GroupBuilder, DatasetBuilder, LinkBuilder, ReferenceBuilder, RegionBuilder
from hdmf.testing import TestCase


class TestGroupBuilder(TestCase):

    def test_constructor(self):
        gb1 = GroupBuilder('gb1', source='source')
        gb2 = GroupBuilder('gb2', parent=gb1)
        self.assertIs(gb1.name, 'gb1')
        self.assertIsNone(gb1.parent)
        self.assertEqual(gb1.source, 'source')
        self.assertIs(gb2.parent, gb1)

    def test_repr(self):
        gb1 = GroupBuilder('gb1')
        expected = "gb1 GroupBuilder {'attributes': {}, 'groups': {}, 'datasets': {}, 'links': {}}"
        self.assertEqual(gb1.__repr__(), expected)

    def test_set_source(self):
        """Test that setting source sets the children builder source."""
        gb1 = GroupBuilder('gb1')
        db = DatasetBuilder('db', list(range(10)))
        lb = LinkBuilder(gb1, 'lb')
        gb2 = GroupBuilder('gb1', {'gb1': gb1}, {'db': db}, {}, {'lb': lb})
        gb2.source = 'source'
        self.assertEqual(gb2.source, 'source')
        self.assertEqual(gb1.source, 'source')
        self.assertEqual(db.source, 'source')
        self.assertEqual(lb.source, 'source')

    def test_set_source_no_reset(self):
        """Test that setting source does not set the children builder source if children already have a source."""
        gb1 = GroupBuilder('gb1', source='original')
        db = DatasetBuilder('db', list(range(10)), source='original')
        lb = LinkBuilder(gb1, 'lb', source='original')
        gb2 = GroupBuilder('gb1', {'gb1': gb1}, {'db': db}, {}, {'lb': lb})
        gb2.source = 'source'
        self.assertEqual(gb1.source, 'original')
        self.assertEqual(db.source, 'original')
        self.assertEqual(lb.source, 'original')

    def test_constructor_dset_none(self):
        gb1 = GroupBuilder('gb1', datasets={'empty': None})
        self.assertEqual(len(gb1.datasets), 0)

    def test_set_location(self):
        gb1 = GroupBuilder('gb1')
        gb1.location = 'location'
        self.assertEqual(gb1.location, 'location')

    def test_overwrite_location(self):
        gb1 = GroupBuilder('gb1')
        gb1.location = 'location'
        gb1.location = 'new location'
        self.assertEqual(gb1.location, 'new location')


class TestGroupBuilderSetters(TestCase):

    def test_set_attribute(self):
        gb = GroupBuilder('gb')
        gb.set_attribute('key', 'value')
        self.assertIn('key', gb.obj_type)
        self.assertIn('key', gb.attributes)
        self.assertEqual(gb['key'], 'value')

    def test_set_group(self):
        gb1 = GroupBuilder('gb1')
        gb2 = GroupBuilder('gb2')
        gb1.set_group(gb2)
        self.assertIs(gb2.parent, gb1)
        self.assertIn('gb2', gb1.obj_type)
        self.assertIn('gb2', gb1.groups)
        self.assertIs(gb1['gb2'], gb2)

    def test_set_dataset(self):
        gb = GroupBuilder('gb')
        db = DatasetBuilder('db', list(range(10)))
        gb.set_dataset(db)
        self.assertIs(db.parent, gb)
        self.assertIn('db', gb.obj_type)
        self.assertIn('db', gb.datasets)
        self.assertIs(gb['db'], db)

    def test_set_link(self):
        gb1 = GroupBuilder('gb1')
        gb2 = GroupBuilder('gb2')
        lb = LinkBuilder(gb2)
        gb1.set_link(lb)
        self.assertIs(lb.parent, gb1)
        self.assertIn('gb2', gb1.obj_type)
        self.assertIn('gb2', gb1.links)
        self.assertIs(gb1['gb2'], lb)

    def test_setitem_disabled(self):
        """Test __setitem__ is disabled"""
        gb = GroupBuilder('gb')
        with self.assertRaises(NotImplementedError):
            gb['key'] = 'value'

    def test_set_exists_wrong_type(self):
        gb1 = GroupBuilder('gb1')
        gb2 = GroupBuilder('gb2')
        db = DatasetBuilder('gb2')
        gb1.set_group(gb2)
        msg = "'gb2' already exists in gb1.groups, cannot set in datasets."
        with self.assertRaisesWith(ValueError, msg):
            gb1.set_dataset(db)


class TestGroupBuilderGetters(TestCase):

    def setUp(self):
        self.subgroup1 = GroupBuilder('subgroup1')
        self.dataset1 = DatasetBuilder('dataset1', list(range(10)))
        self.link1 = LinkBuilder(self.subgroup1, 'link1')
        self.int_attr = 1
        self.str_attr = "my_str"

        self.group1 = GroupBuilder('group1', {'subgroup1': self.subgroup1})
        self.gb = GroupBuilder(
            name='gb',
            groups={'group1': self.group1},
            datasets={'dataset1': self.dataset1},
            attributes={'int_attr': self.int_attr,
                        'str_attr': self.str_attr},
            links={'link1': self.link1}
        )

    def test_path(self):
        self.assertEqual(self.subgroup1.path, 'gb/group1/subgroup1')
        self.assertEqual(self.dataset1.path, 'gb/dataset1')
        self.assertEqual(self.link1.path, 'gb/link1')
        self.assertEqual(self.group1.path, 'gb/group1')
        self.assertEqual(self.gb.path, 'gb')

    def test_getitem_group(self):
        """Test __getitem__ for groups"""
        self.assertIs(self.gb['group1'], self.group1)

    def test_getitem_group_deeper(self):
        """Test __getitem__ for groups deeper in hierarchy"""
        self.assertIs(self.gb['group1/subgroup1'], self.subgroup1)

    def test_getitem_dataset(self):
        """Test __getitem__ for datasets"""
        self.assertIs(self.gb['dataset1'], self.dataset1)

    def test_getitem_attr(self):
        """Test __getitem__ for attributes"""
        self.assertEqual(self.gb['int_attr'], self.int_attr)
        self.assertEqual(self.gb['str_attr'], self.str_attr)

    def test_getitem_invalid_key(self):
        """Test __getitem__ for invalid key"""
        with self.assertRaises(KeyError):
            self.gb['invalid_key']

    def test_getitem_invalid_key_deeper(self):
        """Test __getitem__ for invalid key"""
        with self.assertRaises(KeyError):
            self.gb['group/invalid_key']

    def test_getitem_link(self):
        """Test __getitem__ for links"""
        self.assertIs(self.gb['link1'], self.link1)

    def test_get_group(self):
        """Test get() for groups"""
        self.assertIs(self.gb.get('group1'), self.group1)

    def test_get_group_deeper(self):
        """Test get() for groups deeper in hierarchy"""
        self.assertIs(self.gb.get('group1/subgroup1'), self.subgroup1)

    def test_get_dataset(self):
        """Test get() for datasets"""
        self.assertIs(self.gb.get('dataset1'), self.dataset1)

    def test_get_attr(self):
        """Test get() for attributes"""
        self.assertEqual(self.gb.get('int_attr'), self.int_attr)
        self.assertEqual(self.gb.get('str_attr'), self.str_attr)

    def test_get_link(self):
        """Test get() for links"""
        self.assertIs(self.gb.get('link1'), self.link1)

    def test_get_invalid_key(self):
        """Test get() for invalid key"""
        self.assertIs(self.gb.get('invalid_key'), None)

    def test_items(self):
        """Test items()"""
        items = (
            ('group1', self.group1),
            ('dataset1', self.dataset1),
            ('int_attr', self.int_attr),
            ('str_attr', self.str_attr),
            ('link1', self.link1),
        )
        # self.assertSetEqual(items, set(self.gb.items()))
        try:
            self.assertCountEqual(items, self.gb.items())
        except AttributeError:
            self.assertItemsEqual(items, self.gb.items())

    def test_keys(self):
        """Test keys()"""
        keys = (
            'group1',
            'dataset1',
            'int_attr',
            'str_attr',
            'link1',
        )
        try:
            self.assertCountEqual(keys, self.gb.keys())
        except AttributeError:
            self.assertItemsEqual(keys, self.gb.keys())

    def test_values(self):
        """Test values()"""
        values = (
            self.group1,
            self.dataset1,
            self.int_attr,
            self.str_attr,
            self.link1,
        )
        try:
            self.assertCountEqual(values, self.gb.values())
        except AttributeError:
            self.assertItemsEqual(values, self.gb.values())


class TestGroupBuilderIsEmpty(TestCase):

    def test_is_empty_true(self):
        """Test empty when group has nothing in it"""
        gb = GroupBuilder('gb')
        self.assertTrue(gb.is_empty())

    def test_is_empty_true_group_empty(self):
        """Test is_empty() when group has an empty subgroup"""
        gb1 = GroupBuilder('my_subgroup')
        gb2 = GroupBuilder('gb', {'my_subgroup': gb1})
        self.assertTrue(gb2.is_empty())

    def test_is_empty_false_dataset(self):
        """Test is_empty() when group has a dataset"""
        gb = GroupBuilder('gb', datasets={'my_dataset': DatasetBuilder('my_dataset')})
        self.assertFalse(gb.is_empty())

    def test_is_empty_false_group_dataset(self):
        """Test is_empty() when group has a subgroup with a dataset"""
        gb1 = GroupBuilder('my_subgroup', datasets={'my_dataset': DatasetBuilder('my_dataset')})
        gb2 = GroupBuilder('gb', {'my_subgroup': gb1})
        self.assertFalse(gb2.is_empty())

    def test_is_empty_false_attribute(self):
        """Test is_empty() when group has an attribute"""
        gb = GroupBuilder('gb', attributes={'my_attr': 'attr_value'})
        self.assertFalse(gb.is_empty())

    def test_is_empty_false_group_attribute(self):
        """Test is_empty() when group has subgroup with an attribute"""
        gb1 = GroupBuilder('my_subgroup', attributes={'my_attr': 'attr_value'})
        gb2 = GroupBuilder('gb', {'my_subgroup': gb1})
        self.assertFalse(gb2.is_empty())

    def test_is_empty_false_link(self):
        """Test is_empty() when group has a link"""
        gb1 = GroupBuilder('target')
        gb2 = GroupBuilder('gb', links={'my_link': LinkBuilder(gb1)})
        self.assertFalse(gb2.is_empty())

    def test_is_empty_false_group_link(self):
        """Test is_empty() when group has subgroup with a link"""
        gb1 = GroupBuilder('target')
        gb2 = GroupBuilder('my_subgroup', links={'my_link': LinkBuilder(gb1)})
        gb3 = GroupBuilder('gb', {'my_subgroup': gb2})
        self.assertFalse(gb3.is_empty())


class TestDatasetBuilder(TestCase):

    def test_constructor(self):
        gb1 = GroupBuilder('gb1')
        db1 = DatasetBuilder(
            name='db1',
            data=[1, 2, 3],
            dtype=int,
            attributes={'attr1': 10},
            maxshape=10,
            chunks=True,
            parent=gb1,
            source='source',
        )
        self.assertEqual(db1.name, 'db1')
        self.assertListEqual(db1.data, [1, 2, 3])
        self.assertEqual(db1.dtype, int)
        self.assertDictEqual(db1.attributes, {'attr1': 10})
        self.assertEqual(db1.maxshape, 10)
        self.assertTrue(db1.chunks)
        self.assertIs(db1.parent, gb1)
        self.assertEqual(db1.source, 'source')

    def test_constructor_data_builder_no_dtype(self):
        db1 = DatasetBuilder(name='db1', dtype=int)
        db2 = DatasetBuilder(name='db2', data=db1)
        self.assertEqual(db2.dtype, DatasetBuilder.OBJECT_REF_TYPE)

    def test_constructor_data_builder_dtype(self):
        db1 = DatasetBuilder(name='db1', dtype=int)
        db2 = DatasetBuilder(name='db2', data=db1, dtype=float)
        self.assertEqual(db2.dtype, float)

    def test_set_data(self):
        db1 = DatasetBuilder(name='db1')
        db1.data = [4, 5, 6]
        self.assertEqual(db1.data, [4, 5, 6])

    def test_set_dtype(self):
        db1 = DatasetBuilder(name='db1')
        db1.dtype = float
        self.assertEqual(db1.dtype, float)

    def test_overwrite_data(self):
        db1 = DatasetBuilder(name='db1', data=[1, 2, 3])
        msg = "Cannot overwrite data."
        with self.assertRaisesWith(AttributeError, msg):
            db1.data = [4, 5, 6]

    def test_overwrite_dtype(self):
        db1 = DatasetBuilder(name='db1', data=[1, 2, 3], dtype=int)
        msg = "Cannot overwrite dtype."
        with self.assertRaisesWith(AttributeError, msg):
            db1.dtype = float

    def test_overwrite_source(self):
        db1 = DatasetBuilder(name='db1', data=[1, 2, 3], source='source')
        msg = 'Cannot overwrite source.'
        with self.assertRaisesWith(AttributeError, msg):
            db1.source = 'new source'

    def test_overwrite_parent(self):
        gb1 = GroupBuilder('gb1')
        db1 = DatasetBuilder(name='db1', data=[1, 2, 3], parent=gb1)
        msg = 'Cannot overwrite parent.'
        with self.assertRaisesWith(AttributeError, msg):
            db1.parent = gb1

    def test_repr(self):
        gb1 = GroupBuilder('gb1')
        db1 = DatasetBuilder(
            name='db1',
            data=[1, 2, 3],
            dtype=int,
            attributes={'attr2': 10},
            maxshape=10,
            chunks=True,
            parent=gb1,
            source='source',
        )
        expected = "gb1/db1 DatasetBuilder {'attributes': {'attr2': 10}, 'data': [1, 2, 3]}"
        self.assertEqual(db1.__repr__(), expected)


class TestLinkBuilder(TestCase):

    def test_constructor(self):
        gb = GroupBuilder('gb1')
        db = DatasetBuilder('db1', [1, 2, 3])
        lb = LinkBuilder(db, 'link_name', gb, 'link_source')
        self.assertIs(lb.builder, db)
        self.assertEqual(lb.name, 'link_name')
        self.assertIs(lb.parent, gb)
        self.assertEqual(lb.source, 'link_source')

    def test_constructor_no_name(self):
        db = DatasetBuilder('db1', [1, 2, 3])
        lb = LinkBuilder(db)
        self.assertIs(lb.builder, db)
        self.assertEqual(lb.name, 'db1')


class TestReferenceBuilder(TestCase):

    def test_constructor(self):
        db = DatasetBuilder('db1', [1, 2, 3])
        rb = ReferenceBuilder(db)
        self.assertIs(rb.builder, db)


class TestRegionBuilder(TestCase):

    def test_constructor(self):
        db = DatasetBuilder('db1', [1, 2, 3])
        rb = RegionBuilder(slice(1, 3), db)
        self.assertEqual(rb.region, slice(1, 3))
        self.assertIs(rb.builder, db)