File: table_editor_test.py

package info (click to toggle)
python-traitsui 8.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,232 kB
  • sloc: python: 58,982; makefile: 113
file content (241 lines) | stat: -rw-r--r-- 7,846 bytes parent folder | download
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
# (C) Copyright 2004-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!

# -------------------------------------------------------------------------
#  Imports:
# -------------------------------------------------------------------------

from traits.api import HasStrictTraits, Str, Int, Regex, List, Instance

from traitsui.api import View, Group, Item, TableEditor, EnumEditor

from traitsui.table_column import ObjectColumn

from traitsui.table_filter import (
    TableFilter,
    RuleTableFilter,
    RuleFilterTemplate,
    MenuFilterTemplate,
    EvalFilterTemplate,
)

# -------------------------------------------------------------------------
#  'Person' class:
# -------------------------------------------------------------------------


class Person(HasStrictTraits):

    # -------------------------------------------------------------------------
    #  Trait definitions:
    # -------------------------------------------------------------------------

    name = Str()
    age = Int()
    phone = Regex(value='000-0000', regex=r'\d\d\d[-]\d\d\d\d')
    state = Str()

    # -------------------------------------------------------------------------
    #  Traits view definition:
    # -------------------------------------------------------------------------

    traits_view = View(
        'name',
        'age',
        'phone',
        'state',
        title='Create new person',
        width=0.18,
        buttons=['OK', 'Cancel'],
    )


# -------------------------------------------------------------------------
#  Sample data:
# -------------------------------------------------------------------------

people = [
    Person(name='Dave', age=39, phone='555-1212'),
    Person(name='Mike', age=28, phone='555-3526'),
    Person(name='Joe', age=34, phone='555-6943'),
    Person(name='Tom', age=22, phone='555-7586'),
    Person(name='Dick', age=63, phone='555-3895'),
    Person(name='Harry', age=46, phone='555-3285'),
    Person(name='Sally', age=43, phone='555-8797'),
    Person(name='Fields', age=31, phone='555-3547'),
]

# -------------------------------------------------------------------------
#  'AgeFilter' class:
# -------------------------------------------------------------------------


class AgeFilter(TableFilter):

    # -------------------------------------------------------------------------
    #  Trait definitions:
    # -------------------------------------------------------------------------

    name = "Age filter"
    _name = "Age filter"

    age = Int(0)

    # -------------------------------------------------------------------------
    #  Traits view definitions:
    # -------------------------------------------------------------------------

    # filter_view = Group( 'age{Age >=}' )

    # -------------------------------------------------------------------------
    #  Returns whether an object passes the filter or not:
    # -------------------------------------------------------------------------

    def filter(self, person):
        """Returns whether an object passes the filter or not."""
        return person.age >= self.age

    # -------------------------------------------------------------------------
    #  Returns a user readable description of what the filter does:
    # -------------------------------------------------------------------------

    def description(self):
        """Returns a user readable description of what the filter does."""
        return 'Age >= %d' % self.age

    def _age_changed(self, old, new):
        self.name = self.description()
        print('AgeFilter _age_changed', self.name)


# -------------------------------------------------------------------------
#  'NameFilter' class:
# -------------------------------------------------------------------------


class NameFilter(TableFilter):

    # -------------------------------------------------------------------------
    #  Trait definitions:
    # -------------------------------------------------------------------------

    mname = Str()

    # -------------------------------------------------------------------------
    #  Traits view definitions:
    # -------------------------------------------------------------------------

    filter_view = Group('mname{Name contains}')

    # -------------------------------------------------------------------------
    #  Returns whether an object passes the filter or not:
    # -------------------------------------------------------------------------

    def filter(self, person):
        """Returns whether an object passes the filter or not."""
        return person.name.lower().find(self.mname.lower()) >= 0

    # -------------------------------------------------------------------------
    #  Returns a user readable description of what the filter does:
    # -------------------------------------------------------------------------

    def description(self):
        """Returns a user readable description of what the filter does."""
        return "Name contains '%s'" % self.mname


# -------------------------------------------------------------------------
#  Table editor definition:
# -------------------------------------------------------------------------

filters = [
    AgeFilter(age=30),
    NameFilter(mname='d'),
    EvalFilterTemplate,
    MenuFilterTemplate,
    RuleFilterTemplate,
]


def evaluate_value(v):
    print('evaluate_value', v)
    return str(v)


# -------------------------------------------------------------------------
#  'TableTest' class:
# -------------------------------------------------------------------------


class TableTest(HasStrictTraits):

    # -------------------------------------------------------------------------
    #  Trait definitions:
    # -------------------------------------------------------------------------

    # people = Instance( Person )
    people = List(Person)

    # -------------------------------------------------------------------------
    #  Traits view definitions:
    # -------------------------------------------------------------------------

    _valid_states = List(["AL", "AR", "AZ", "AK"])

    _state_editor = EnumEditor(
        name="_valid_states",
        evaluate=evaluate_value,
        object='table_editor_object',
    )

    table_editor = TableEditor(
        columns=[
            ObjectColumn(name='name'),
            ObjectColumn(name='age'),
            ObjectColumn(name='phone'),
            ObjectColumn(name='state', editor=_state_editor),
        ],
        editable=True,
        deletable=True,
        sortable=True,
        sort_model=True,
        show_lines=True,
        orientation='vertical',
        show_column_labels=True,
        edit_view=View(
            ['name', 'age', 'phone', 'state', '|[]'], resizable=True
        ),
        filter=None,
        filters=filters,
        row_factory=Person,
    )

    traits_view = View(
        [Item('people', id='people', editor=table_editor), '|[]<>'],
        title='Table Editor Test',
        id='traitsui.tests.table_editor_test',
        dock='horizontal',
        width=0.4,
        height=0.3,
        resizable=True,
        kind='live',
    )


# -------------------------------------------------------------------------
#  Run the tests:
# -------------------------------------------------------------------------

if __name__ == '__main__':
    tt = TableTest(people=people)
    tt.configure_traits()
    for p in tt.people:
        p.print_traits()
        print('--------------')