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
|
# (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!
""" Classes for extracting data from objects
This module provides helper classes for the row table data model and
related classes for extracting data from an object in a consistent way.
"""
from abc import abstractmethod
from collections.abc import Hashable, MutableMapping, MutableSequence
from traits.api import (
ABCHasStrictTraits, Any, Event, Instance, Int, Str, observe
)
from traits.trait_base import xgetattr, xsetattr
from pyface.data_view.abstract_data_model import DataViewSetError
from pyface.data_view.abstract_value_type import AbstractValueType
from pyface.data_view.value_types.api import TextValue
class AbstractDataAccessor(ABCHasStrictTraits):
""" Accessor that gets and sets data on an object.
"""
#: A human-readable label for the accessor.
title = Str()
#: The value type of the title of this accessor, suitable for use in a
#: header.
title_type = Instance(AbstractValueType, factory=TextValue)
#: The value type of the data accessed.
value_type = Instance(AbstractValueType)
#: An event fired when accessor is updated update. The payload is
#: a tuple of the accessor info and whether the title or value changed
#: (or both).
updated = Event
@abstractmethod
def get_value(self, obj):
""" Return a value for the provided object.
Parameters
----------
obj : Any
The object that contains the data.
Returns
-------
value : Any
The data value contained in the object.
"""
raise NotImplementedError()
def can_set_value(self, obj):
""" Return whether the value can be set on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
Returns
-------
can_set_value : bool
Whether or not the value can be set.
"""
return False
def set_value(self, obj, value):
""" Set the value on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
value : Any
The data value to set.
Raises
-------
DataViewSetError
If setting the value fails.
"""
raise DataViewSetError(
"Cannot set {!r} column of {!r}.".format(self.title, obj)
)
# 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')
class ConstantDataAccessor(AbstractDataAccessor):
""" DataAccessor that returns a constant value.
"""
#: The value to return.
value = Any()
def get_value(self, obj):
""" Return the value ignoring the provided object.
Parameters
----------
obj : Any
An object.
Returns
-------
value : Any
The data value contained in this class' value trait.
"""
return self.value
@observe('value')
def _value_updated(self, event):
self.updated = (self, 'value')
class AttributeDataAccessor(AbstractDataAccessor):
""" DataAccessor that presents an extended attribute on an object.
This is suitable for use with Python objects, including HasTraits
classes.
"""
#: The extended attribute name of the trait holding the value.
attr = Str()
def get_value(self, obj):
""" Return the attribute value for the provided object.
Parameters
----------
obj : Any
The object that contains the data.
Returns
-------
value : Any
The data value contained in the object's attribute.
"""
return xgetattr(obj, self.attr)
def can_set_value(self, obj):
""" Return whether the value can be set on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
Returns
-------
can_set_value : bool
Whether or not the value can be set.
"""
return bool(self.attr)
def set_value(self, obj, value):
if not self.can_set_value(obj):
raise DataViewSetError(
"Attribute is not specified for {!r}".format(self)
)
xsetattr(obj, self.attr, value)
@observe('attr')
def _attr_updated(self, event):
self.updated = (self, 'value')
def _title_default(self):
# create human-friendly version of extended attribute
attr = self.attr.split('.')[-1]
title = attr.replace('_', ' ').title()
return title
class IndexDataAccessor(AbstractDataAccessor):
""" DataAccessor that presents an index on a sequence object.
This is suitable for use with a sequence.
"""
#: The index in a sequence which holds the value.
index = Int()
def get_value(self, obj):
""" Return the indexed value for the provided object.
Parameters
----------
obj : sequence
The object that contains the data.
Returns
-------
value : Any
The data value contained in the object at the index.
"""
return obj[self.index]
def can_set_value(self, obj):
""" Return whether the value can be set on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
Returns
-------
can_set_value : bool
Whether or not the value can be set.
"""
return isinstance(obj, MutableSequence) and 0 <= self.index < len(obj)
def set_value(self, obj, value):
""" Set the value on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
value : Any
The data value to set.
Raises
-------
DataViewSetError
If setting the value fails.
"""
if not self.can_set_value(obj):
raise DataViewSetError(
"Cannot set {!r} index of {!r}.".format(self.index, obj)
)
obj[self.index] = value
@observe('index')
def _index_updated(self, event):
self.updated = (self, 'value')
def _title_default(self):
title = str(self.index)
return title
class KeyDataAccessor(AbstractDataAccessor):
""" DataAccessor that presents an item on a mapping object.
This is suitable for use with a mapping, such as a dictionary.
"""
#: The key in the mapping holding the value.
key = Instance(Hashable)
def get_value(self, obj):
""" Return the key's value for the provided object.
Parameters
----------
obj : mapping
The object that contains the data.
Returns
-------
value : Any
The data value contained in the given key of the object.
"""
return obj[self.key]
def can_set_value(self, obj):
""" Set the value on the provided object.
Parameters
----------
obj : mapping
The object that contains the data.
value : Any
The data value to set.
Raises
-------
DataViewSetError
If setting the value fails.
"""
return isinstance(obj, MutableMapping)
def set_value(self, obj, value):
""" Set the value on the provided object.
Parameters
----------
obj : Any
The object that contains the data.
value : Any
The data value to set.
Raises
-------
DataViewSetError
If setting the value fails.
"""
if not self.can_set_value(obj):
raise DataViewSetError(
"Cannot set {!r} key of {!r}.".format(self.key, obj)
)
obj[self.key] = value
@observe('key')
def _key_updated(self, event):
self.updated = (self, 'value')
def _title_default(self):
title = str(self.key).title()
return title
|
