PyAPI: Fast buffer access to id property arrays
[blender.git] / tests / python / bl_pyapi_idprop.py
1 # Apache License, Version 2.0
2
3 # ./blender.bin --background -noaudio --python tests/python/bl_pyapi_idprop.py -- --verbose
4 import bpy
5 import unittest
6 import numpy as np
7 from array import array
8
9
10 class TestHelper:
11
12     @property
13     def id(self):
14         return self._id
15
16     def setUp(self):
17         self._id = bpy.context.scene
18         assert(len(self._id.keys()) == 0)
19
20     def tearDown(self):
21         for key in list(self._id.keys()):
22             del self._id[key]
23
24     def assertAlmostEqualSeq(self, list1, list2):
25         self.assertEqual(len(list1), len(list2))
26         for v1, v2 in zip(list1, list2):
27             self.assertAlmostEqual(v1, v2, places=5)
28
29
30 class TestIdPropertyCreation(TestHelper, unittest.TestCase):
31
32     def test_name_empty(self):
33         self.id[""] = 4
34         self.assertEqual(self.id[""], 4)
35
36     def test_name_too_long(self):
37         with self.assertRaises(KeyError):
38             self.id["name" * 30] = 4
39
40     def test_int(self):
41         self.id["a"] = 2
42         self.assertEqual(self.id["a"], 2)
43         self.assertTrue(isinstance(self.id["a"], int))
44
45         with self.assertRaises(OverflowError):
46             self.id["a"] = 2 ** 31  # integer <= 2 ** 31-1
47
48     def test_double(self):
49         self.id["a"] = 2.5
50         self.assertEqual(self.id["a"], 2.5)
51         self.assertTrue(isinstance(self.id["a"], float))
52
53     def test_unicode(self):
54         self.id["a"] = "Hello World"
55         self.assertEqual(self.id["a"], "Hello World")
56         self.assertTrue(isinstance(self.id["a"], str))
57
58     def test_bytes(self):
59         self.id["a"] = b"Hello World"
60         self.assertEqual(self.id["a"], b"Hello World")
61         self.assertTrue(isinstance(self.id["a"], bytes))
62
63     def test_sequence_double_list(self):
64         mylist = [1.2, 3.4, 5.6]
65         self.id["a"] = mylist
66         self.assertEqual(self.id["a"].to_list(), mylist)
67         self.assertEqual(self.id["a"].typecode, "d")
68
69     def test_sequence_int_list(self):
70         mylist = [1, 2, 3]
71         self.id["a"] = mylist
72         self.assertEqual(self.id["a"].to_list(), mylist)
73         self.assertEqual(self.id["a"].typecode, "i")
74
75     def test_sequence_float_array(self):
76         mylist = [1.2, 3.4, 5.6]
77         self.id["a"] = array("f", mylist)
78         self.assertAlmostEqualSeq(self.id["a"].to_list(), mylist)
79         self.assertEqual(self.id["a"].typecode, "f")
80
81     def test_sequence_double_array(self):
82         mylist = [1.2, 3.4, 5.6]
83         self.id["a"] = array("d", mylist)
84         self.assertAlmostEqualSeq(self.id["a"].to_list(), mylist)
85         self.assertEqual(self.id["a"].typecode, "d")
86
87     def test_sequence_int_array(self):
88         mylist = [1, 2, 3]
89         self.id["a"] = array("i", mylist)
90         self.assertAlmostEqualSeq(self.id["a"].to_list(), mylist)
91         self.assertEqual(self.id["a"].typecode, "i")
92
93     def test_sequence_other_array(self):
94         mylist = [1, 2, 3]
95         self.id["a"] = array("Q", mylist)
96         self.assertEqual(self.id["a"].to_list(), mylist)
97
98     def test_sequence_mixed_numerical_type(self):
99         self.id["a"] = [1, 2, 3.4, 5]
100         self.assertAlmostEqualSeq(self.id["a"].to_list(), [1.0, 2.0, 3.4, 5.0])
101         self.assertEqual(self.id["a"].typecode, "d")
102
103     def test_sequence_str_list(self):
104         # I'm a bit surprised that this works
105         mylist = ["abc", "qwe"]
106         self.id["a"] = mylist
107         self.assertEqual(self.id["a"], mylist)
108
109     def test_sequence_mixed_type(self):
110         with self.assertRaises(TypeError):
111             mylist = ["abc", 3, "qwe", 3.4]
112             self.id["a"] = mylist
113
114     def test_mapping_simple(self):
115         mydict = {"1": 10, "2": "20", "3": 30.5}
116         self.id["a"] = mydict
117         self.assertEqual(self.id["a"]["1"], mydict["1"])
118         self.assertEqual(self.id["a"]["2"], mydict["2"])
119         self.assertEqual(self.id["a"]["3"], mydict["3"])
120
121     def test_mapping_complex(self):
122         mydict = {
123             "1": [1, 2, 3],
124             "2": {"1": "abc", "2": array("i", [4, 5, 6])},
125             "3": {"1": {"1": 10}, "2": b"qwe"},
126         }
127         self.id["a"] = mydict
128         self.assertEqual(self.id["a"]["1"].to_list(), [1, 2, 3])
129         self.assertEqual(self.id["a"]["2"]["1"], "abc")
130         self.assertEqual(self.id["a"]["2"]["2"].to_list(), [4, 5, 6])
131         self.assertEqual(self.id["a"]["3"]["1"]["1"], 10)
132         self.assertEqual(self.id["a"]["3"]["2"], b"qwe")
133
134         with self.assertRaises(KeyError):
135             a = self.id["a"]["2"]["a"]
136
137     def test_invalid_type(self):
138         with self.assertRaises(TypeError):
139             self.id["a"] = self
140
141
142 class TestBufferProtocol(TestHelper, unittest.TestCase):
143
144     def test_int(self):
145         self.id["a"] = array("i", [1, 2, 3, 4, 5])
146         a = np.frombuffer(self.id["a"], self.id["a"].typecode)
147         self.assertEqual(len(a), 5)
148         a[2] = 10
149         self.assertEqual(self.id["a"].to_list(), [1, 2, 10, 4, 5])
150
151     def test_float(self):
152         self.id["a"] = array("f", [1.0, 2.0, 3.0, 4.0])
153         a = np.frombuffer(self.id["a"], self.id["a"].typecode)
154         self.assertEqual(len(a), 4)
155         a[-1] = 10
156         self.assertEqual(self.id["a"].to_list(), [1.0, 2.0, 3.0, 10.0])
157
158     def test_double(self):
159         self.id["a"] = array("d", [1.0, 2.0, 3.0, 4.0])
160         a = np.frombuffer(self.id["a"], self.id["a"].typecode)
161         a[1] = 10
162         self.assertEqual(self.id["a"].to_list(), [1.0, 10.0, 3.0, 4.0])
163
164     def test_full_update(self):
165         self.id["a"] = array("i", [1, 2, 3, 4, 5, 6])
166         a = np.frombuffer(self.id["a"], self.id["a"].typecode)
167         a[:] = [10, 20, 30, 40, 50, 60]
168         self.assertEqual(self.id["a"].to_list(), [10, 20, 30, 40, 50, 60])
169
170     def test_partial_update(self):
171         self.id["a"] = array("i", [1, 2, 3, 4, 5, 6, 7, 8])
172         a = np.frombuffer(self.id["a"], self.id["a"].typecode)
173         a[1:5] = [10, 20, 30, 40]
174         self.assertEqual(self.id["a"].to_list(), [1, 10, 20, 30, 40, 6, 7, 8])
175
176     def test_copy(self):
177         self.id["a"] = array("i", [1, 2, 3, 4, 5])
178         self.id["b"] = self.id["a"]
179         self.assertEqual(self.id["a"].to_list(), self.id["b"].to_list())
180
181     def test_memview_attributes(self):
182         mylist = [1, 2, 3]
183         self.id["a"] = mylist
184
185         view1 = memoryview(self.id["a"])
186         view2 = memoryview(array("i", mylist))
187
188         self.assertEqualMemviews(view1, view2)
189
190     def assertEqualMemviews(self, view1, view2):
191         props_to_compare = (
192             "contiguous", "format", "itemsize", "nbytes", "ndim",
193             "readonly", "shape", "strides", "suboffsets"
194         )
195         for attr in props_to_compare:
196             self.assertEqual(getattr(view1, attr), getattr(view2, attr))
197
198         self.assertEqual(list(view1), list(view2))
199         self.assertEqual(view1.tobytes(), view2.tobytes())
200
201 if __name__ == '__main__':
202     import sys
203     sys.argv = [__file__] + (sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else [])
204     unittest.main()