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
|
import pytest
import pyqtgraph as pg
import pyqtgraph.dockarea as da
pg.mkQApp()
def test_dockarea():
a = da.DockArea()
d1 = da.Dock("dock 1")
a.addDock(d1, 'left')
assert a.topContainer is d1.container()
assert d1.container().container() is a
assert d1.area is a
assert a.topContainer.widget(0) is d1
d2 = da.Dock("dock 2")
a.addDock(d2, 'right')
assert a.topContainer is d1.container()
assert a.topContainer is d2.container()
assert d1.container().container() is a
assert d2.container().container() is a
assert d2.area is a
assert a.topContainer.widget(0) is d1
assert a.topContainer.widget(1) is d2
d3 = da.Dock("dock 3")
a.addDock(d3, 'bottom')
assert a.topContainer is d3.container()
assert d2.container().container() is d3.container()
assert d1.container().container() is d3.container()
assert d1.container().container().container() is a
assert d2.container().container().container() is a
assert d3.container().container() is a
assert d3.area is a
assert d2.area is a
assert a.topContainer.widget(0) is d1.container()
assert a.topContainer.widget(1) is d3
d4 = da.Dock("dock 4")
a.addDock(d4, 'below', d3)
assert d4.container().type() == 'tab'
assert d4.container() is d3.container()
assert d3.container().container() is d2.container().container()
assert d4.area is a
a.printState()
# layout now looks like:
# vcontainer
# hcontainer
# dock 1
# dock 2
# tcontainer
# dock 3
# dock 4
# test save/restore state
state = a.saveState()
a2 = da.DockArea()
# default behavior is to raise exception if docks are missing
with pytest.raises(Exception):
a2.restoreState(state)
# test restore with ignore missing
a2.restoreState(state, missing='ignore')
assert a2.topContainer is None
# test restore with auto-create
a2.restoreState(state, missing='create')
assert a2.saveState() == state
a2.printState()
# double-check that state actually matches the output of saveState()
c1 = a2.topContainer
assert c1.type() == 'vertical'
c2 = c1.widget(0)
c3 = c1.widget(1)
assert c2.type() == 'horizontal'
assert c2.widget(0).name() == 'dock 1'
assert c2.widget(1).name() == 'dock 2'
assert c3.type() == 'tab'
assert c3.widget(0).name() == 'dock 3'
assert c3.widget(1).name() == 'dock 4'
# test restore with docks already present
a3 = da.DockArea()
a3docks = []
for i in range(1, 5):
dock = da.Dock('dock %d' % i)
a3docks.append(dock)
a3.addDock(dock, 'right')
a3.restoreState(state)
assert a3.saveState() == state
# test restore with extra docks present
a3 = da.DockArea()
a3docks = []
for i in [1, 2, 5, 4, 3]:
dock = da.Dock('dock %d' % i)
a3docks.append(dock)
a3.addDock(dock, 'left')
a3.restoreState(state)
a3.printState()
# test a more complex restore
a4 = da.DockArea()
state1 = {'float': [], 'main':
('horizontal', [
('vertical', [
('horizontal', [
('tab', [
('dock', 'dock1', {}),
('dock', 'dock2', {}),
('dock', 'dock3', {}),
('dock', 'dock4', {})
], {'index': 1}),
('vertical', [
('dock', 'dock5', {}),
('horizontal', [
('dock', 'dock6', {}),
('dock', 'dock7', {})
], {'sizes': [184, 363]})
], {'sizes': [355, 120]})
], {'sizes': [9, 552]})
], {'sizes': [480]}),
('dock', 'dock8', {})
], {'sizes': [566, 69]})
}
state2 = {'float': [], 'main':
('horizontal', [
('vertical', [
('horizontal', [
('dock', 'dock2', {}),
('vertical', [
('dock', 'dock5', {}),
('horizontal', [
('dock', 'dock6', {}),
('dock', 'dock7', {})
], {'sizes': [492, 485]})
], {'sizes': [936, 0]})
], {'sizes': [172, 982]})
], {'sizes': [941]}),
('vertical', [
('dock', 'dock8', {}),
('dock', 'dock4', {}),
('dock', 'dock1', {})
], {'sizes': [681, 225, 25]})
], {'sizes': [1159, 116]})}
a4.restoreState(state1, missing='create')
# dock3 not mentioned in restored state; stays in dockarea by default
c, d = a4.findAll()
assert d['dock3'].area is a4
a4.restoreState(state2, missing='ignore', extra='float')
a4.printState()
c, d = a4.findAll()
# dock3 not mentioned in restored state; goes to float due to `extra` argument
assert d['dock3'].area is not a4
assert d['dock1'].container() is d['dock4'].container() is d['dock8'].container()
assert d['dock6'].container() is d['dock7'].container()
assert a4 is d['dock2'].area is d['dock2'].container().container().container()
assert a4 is d['dock5'].area is d['dock5'].container().container().container().container()
# States should be the same with two exceptions:
# dock3 is in a float because it does not appear in state2
# a superfluous vertical splitter in state2 has been removed
state4 = a4.saveState()
state4['main'][1][0] = state4['main'][1][0][1][0]
with pytest.raises(AssertionError):
# this test doesn't work, likely due to clean_state not working as intended
assert clean_state(state4['main']) == clean_state(state2['main'])
def test_restoring_fails_silently_if_only_one_dock_in_container():
# Test that restoring state with a single dock in a container does not silently collapse and delete an entire
# container tree.
# Regression test for GH issue #2887
dockArea = da.DockArea()
dockArea.addDock(da.Dock(name="Plot 1", closable=False), 'left')
dockArea.addDock(da.Dock(name="Plot 2", closable=False), 'left')
dockArea.addDock(da.Dock(name="Plot 4", closable=False), 'left')
dockArea.addDock(da.Dock(name="Table 1", closable=False), 'left')
dockArea.addDock(da.Dock(name="Table 2", closable=False), 'left')
dockArea.addDock(da.Dock(name="Table 3", closable=False), 'left')
state = {'main':
['vertical', [
['horizontal', [
['vertical', [
['vertical', [ # A single dock in a container should not lead to the collapse of this side of the tree.
['dock', 'Plot 1', {}]],
{'sizes': [314]}
],
['dock', 'Plot 2', {}]],
{'sizes': [314, 313]}],
['vertical', [
['dock', 'Table 3', {}],
['dock', 'Table 2', {}],
['dock', 'Table 1', {}]],
{'sizes': [208, 207, 208]}]
],
{'sizes': [784, 783]}
],
['dock', 'Plot 4', {}]
],
{'sizes': [631, 210]}
],
'float': []}
dockArea.restoreState(state)
c, d = dockArea.findAll()
assert len(d) == 6
def test_floating_and_closed_before_save_and_restore_state():
# Test that undocking and redocking a dock by closing the temporary window doesn't break
# save- and restoreState functionality. Regression test for GH issue #3125
a = da.DockArea()
d1 = da.Dock("dock 1")
a.addDock(d1, 'left')
a.floatDock(d1)
a.tempAreas[0].win.close()
state = a.saveState()
a2 = da.DockArea()
a2.restoreState(state, missing='create')
assert a2.saveState() == state
def test_floating_and_redock_by_dragging_back_before_save_and_restore_state():
# Test that undocking and dragging the dock back to the main window closes the temporary window and therefore
# doesn't break save- and restoreState functionality. Regression test for GH issue #3125
a = da.DockArea()
d1 = da.Dock("dock 1")
a.addDock(d1, 'left')
a.floatDock(d1)
a.moveDock(d1, 'left', None)
state = a.saveState()
a2 = da.DockArea()
a2.restoreState(state, missing='create')
assert a2.saveState() == state
def test_floating_dock_closed_by_restore_state_doesnt_error():
# Test that closing a floating dock by calling restoreState doesn't raise an exception.
a = da.DockArea()
d1 = da.Dock("dock 1")
a.addDock(d1, 'left')
d2 = da.Dock("dock 2")
a.addDock(d2, 'left')
state = a.saveState()
a.floatDock(d1)
a.restoreState(state) # Should not raise an exception
assert a.saveState() == state
def clean_state(state):
# return state dict with sizes removed
ch = [clean_state(x) for x in state[1]] if isinstance(state[1], list) else state[1]
state = (state[0], ch, {})
return state
|
