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
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from abc import abstractmethod
from traits.api import (
ABCHasStrictTraits, Event, HasTraits, Instance,
List, Str, observe
)
from traits.trait_base import xgetattr, xsetattr
from pyface.data_view.api import (
AbstractDataModel, AbstractValueType, DataViewSetError, TupleIndexManager
)
from pyface.data_view.value_types.api import TextValue
class AbstractRowInfo(ABCHasStrictTraits):
""" Configuration for a data row in a ColumnDataModel.
"""
#: The text to display in the first column.
title = Str()
#: The child rows of this row, if any.
rows = List(Instance('AbstractRowInfo'))
#: The value type of the data stored in this row.
title_type = Instance(
AbstractValueType,
factory=TextValue,
kw={'is_editable': False},
)
#: The value type of the data stored in this row.
value_type = Instance(AbstractValueType)
#: An event fired when the row or its children update. The payload is
#: a tuple of whether the title or value changed (or both), and the
#: row_index affected.
updated = Event
def __iter__(self):
yield self
for row in self.rows:
yield from row
@abstractmethod
def get_value(self, obj):
raise NotImplementedError()
@abstractmethod
def can_set_value(self, obj):
raise NotImplementedError()
def set_value(self, obj):
return
@abstractmethod
def get_observable(self, obj):
raise NotImplementedError()
# trait observers
@observe('title,title_type.updated')
def title_updated(self, event):
self.updated = (self, 'title', [])
@observe('value_type.updated')
def value_type_updated(self, event):
self.updated = (self, 'value', [])
@observe('rows.items')
def rows_updated(self, event):
self.updated = (self, 'rows', [])
@observe('rows:items:updated')
def row_item_updated(self, event):
row = event.object
row_info, part, row_index = event.new
row_index = [self.rows.index(row)] + row_index
self.updated = (row_info, part, row_index)
class HasTraitsRowInfo(AbstractRowInfo):
""" RowInfo that presents a named trait value.
"""
#: The extended trait name of the trait holding the value.
value = Str()
def get_value(self, obj):
return xgetattr(obj, self.value, None)
def can_set_value(self, obj):
return self.value != ''
def set_value(self, obj, value):
if not self.value:
return
xsetattr(obj, self.value, value)
def get_observable(self):
return self.value
@observe('value')
def value_type_updated(self, event):
self.updated = (self, 'value', [])
class DictRowInfo(AbstractRowInfo):
""" RowInfo that presents an item in a dictionary.
The attribute ``value`` should reference a dictionary trait on a
has traits object.
"""
#: The extended trait name of the dictionary holding the values.
value = Str()
#: The key holding the value.
key = Str()
def get_value(self, obj):
data = xgetattr(obj, self.value, None)
return data.get(self.key, None)
def can_set_value(self, obj):
return self.value != ''
def set_value(self, obj, value):
data = xgetattr(obj, self.value, None)
data[self.key] = value
def get_observable(self):
return self.value + '.items'
@observe('value,key')
def value_type_updated(self, event):
self.updated = (self, 'value', [])
class ColumnDataModel(AbstractDataModel):
""" A data model that presents a list of objects as columns.
"""
#: A list of objects to display in columns.
data = List(Instance(HasTraits))
#: An object which describes how to map data for each row.
row_info = Instance(AbstractRowInfo)
#: The index manager that helps convert toolkit indices to data view
#: indices.
index_manager = Instance(TupleIndexManager, args=())
def get_column_count(self):
return len(self.data)
def can_have_children(self, row):
if len(row) == 0:
return True
row_info = self._row_info_object(row)
return len(row_info.rows) != 0
def get_row_count(self, row):
row_info = self._row_info_object(row)
return len(row_info.rows)
def get_value(self, row, column):
row_info = self._row_info_object(row)
if len(column) == 0:
return row_info.title
obj = self.data[column[0]]
return row_info.get_value(obj)
def can_set_value(self, row, column):
""" Whether the value in the indicated row and column can be set.
This returns False for row headers, but True for all other values.
Parameters
----------
row : sequence of int
The indices of the row as a sequence from root to leaf.
column : sequence of int
The indices of the column as a sequence of length 0 or 1.
Returns
-------
can_set_value : bool
Whether or not the value can be set.
"""
if len(column) == 0:
return False
else:
return True
def set_value(self, row, column, value):
row_info = self._row_info_object(row)
if len(column) == 0:
raise DataViewSetError("Cannot set value for row header.")
obj = self.data[column[0]]
row_info.set_value(obj, value)
def get_value_type(self, row, column):
row_info = self._row_info_object(row)
if len(column) == 0:
return row_info.title_type
else:
return row_info.value_type
def _row_info_object(self, row):
row_info = self.row_info
for index in row:
row_info = row_info.rows[index]
return row_info
|
