Show More
@@ -27,7 +27,7 b' from weakref import WeakValueDictionary' | |||||
27 | from IPython.utils.importstring import import_item |
|
27 | from IPython.utils.importstring import import_item | |
28 | from IPython.config.loader import Config |
|
28 | from IPython.config.loader import Config | |
29 | from IPython.utils.traitlets import ( |
|
29 | from IPython.utils.traitlets import ( | |
30 |
HasTraits, Trait |
|
30 | HasTraits, TraitError, MetaHasTraits, Instance, This | |
31 | ) |
|
31 | ) | |
32 |
|
32 | |||
33 |
|
33 | |||
@@ -186,7 +186,7 b' class Component(HasTraits):' | |||||
186 |
|
186 | |||
187 | __metaclass__ = MetaComponent |
|
187 | __metaclass__ = MetaComponent | |
188 |
|
188 | |||
189 |
# Trait |
|
189 | # Traits are fun! | |
190 | config = Instance(Config,(),{}) |
|
190 | config = Instance(Config,(),{}) | |
191 | parent = This() |
|
191 | parent = This() | |
192 | root = This() |
|
192 | root = This() | |
@@ -250,7 +250,7 b' class Component(HasTraits):' | |||||
250 | self.created = datetime.datetime.now() |
|
250 | self.created = datetime.datetime.now() | |
251 |
|
251 | |||
252 | #------------------------------------------------------------------------- |
|
252 | #------------------------------------------------------------------------- | |
253 |
# Static trait |
|
253 | # Static trait notifiations | |
254 | #------------------------------------------------------------------------- |
|
254 | #------------------------------------------------------------------------- | |
255 |
|
255 | |||
256 | def _parent_changed(self, name, old, new): |
|
256 | def _parent_changed(self, name, old, new): | |
@@ -276,12 +276,12 b' class Component(HasTraits):' | |||||
276 | def _config_changed(self, name, old, new): |
|
276 | def _config_changed(self, name, old, new): | |
277 | """Update all the class traits having ``config=True`` as metadata. |
|
277 | """Update all the class traits having ``config=True`` as metadata. | |
278 |
|
278 | |||
279 |
For any class trait |
|
279 | For any class trait with a ``config`` metadata attribute that is | |
280 |
``True``, we update the trait |
|
280 | ``True``, we update the trait with the value of the corresponding | |
281 | config entry. |
|
281 | config entry. | |
282 | """ |
|
282 | """ | |
283 |
# Get all trait |
|
283 | # Get all traits with a config metadata entry that is True | |
284 |
trait |
|
284 | traits = self.traits(config=True) | |
285 |
|
285 | |||
286 | # We auto-load config section for this class as well as any parent |
|
286 | # We auto-load config section for this class as well as any parent | |
287 | # classes that are Component subclasses. This starts with Component |
|
287 | # classes that are Component subclasses. This starts with Component | |
@@ -295,7 +295,7 b' class Component(HasTraits):' | |||||
295 | # dynamically create the section with name self.__class__.__name__. |
|
295 | # dynamically create the section with name self.__class__.__name__. | |
296 | if new._has_section(sname): |
|
296 | if new._has_section(sname): | |
297 | my_config = new[sname] |
|
297 | my_config = new[sname] | |
298 |
for k, v in trait |
|
298 | for k, v in traits.items(): | |
299 | try: |
|
299 | try: | |
300 | config_value = my_config[k] |
|
300 | config_value = my_config[k] | |
301 | except KeyError: |
|
301 | except KeyError: |
@@ -165,7 +165,7 b' def get_default_editor():' | |||||
165 | class SeparateStr(Str): |
|
165 | class SeparateStr(Str): | |
166 | """A Str subclass to validate separate_in, separate_out, etc. |
|
166 | """A Str subclass to validate separate_in, separate_out, etc. | |
167 |
|
167 | |||
168 |
This is a Str based trait |
|
168 | This is a Str based trait that converts '0'->'' and '\\n'->'\n'. | |
169 | """ |
|
169 | """ | |
170 |
|
170 | |||
171 | def validate(self, obj, value): |
|
171 | def validate(self, obj, value): | |
@@ -246,7 +246,7 b' class InteractiveShell(Component, Magic):' | |||||
246 |
|
246 | |||
247 | screen_length = Int(0, config=True) |
|
247 | screen_length = Int(0, config=True) | |
248 |
|
248 | |||
249 |
# Use custom Trait |
|
249 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
250 | separate_in = SeparateStr('\n', config=True) |
|
250 | separate_in = SeparateStr('\n', config=True) | |
251 | separate_out = SeparateStr('', config=True) |
|
251 | separate_out = SeparateStr('', config=True) | |
252 | separate_out2 = SeparateStr('', config=True) |
|
252 | separate_out2 = SeparateStr('', config=True) | |
@@ -269,7 +269,7 b' class InteractiveShell(Component, Magic):' | |||||
269 | banner1=None, banner2=None, display_banner=None, |
|
269 | banner1=None, banner2=None, display_banner=None, | |
270 | custom_exceptions=((),None)): |
|
270 | custom_exceptions=((),None)): | |
271 |
|
271 | |||
272 |
# This is where trait |
|
272 | # This is where traits with a config_key argument are updated | |
273 | # from the values on config. |
|
273 | # from the values on config. | |
274 | super(InteractiveShell, self).__init__(parent, config=config) |
|
274 | super(InteractiveShell, self).__init__(parent, config=config) | |
275 |
|
275 | |||
@@ -323,7 +323,7 b' class InteractiveShell(Component, Magic):' | |||||
323 | return self |
|
323 | return self | |
324 |
|
324 | |||
325 | #------------------------------------------------------------------------- |
|
325 | #------------------------------------------------------------------------- | |
326 |
# Trait |
|
326 | # Trait changed handlers | |
327 | #------------------------------------------------------------------------- |
|
327 | #------------------------------------------------------------------------- | |
328 |
|
328 | |||
329 | def _banner1_changed(self): |
|
329 | def _banner1_changed(self): |
@@ -24,7 +24,7 b' from unittest import TestCase' | |||||
24 |
|
24 | |||
25 | from IPython.core.component import Component, ComponentError |
|
25 | from IPython.core.component import Component, ComponentError | |
26 | from IPython.utils.traitlets import ( |
|
26 | from IPython.utils.traitlets import ( | |
27 |
Trait |
|
27 | TraitError, Int, Float, Str | |
28 | ) |
|
28 | ) | |
29 | from IPython.config.loader import Config |
|
29 | from IPython.config.loader import Config | |
30 |
|
30 | |||
@@ -109,7 +109,7 b' class TestComponent(TestCase):' | |||||
109 |
|
109 | |||
110 | def test_subclass_parent(self): |
|
110 | def test_subclass_parent(self): | |
111 | c1 = Component(None) |
|
111 | c1 = Component(None) | |
112 |
self.assertRaises(Trait |
|
112 | self.assertRaises(TraitError, setattr, c1, 'parent', 10) | |
113 |
|
113 | |||
114 | class MyComponent(Component): |
|
114 | class MyComponent(Component): | |
115 | pass |
|
115 | pass |
@@ -29,8 +29,8 b' import os' | |||||
29 | from unittest import TestCase |
|
29 | from unittest import TestCase | |
30 |
|
30 | |||
31 | from IPython.utils.traitlets import ( |
|
31 | from IPython.utils.traitlets import ( | |
32 |
HasTraits, MetaHasTraits, Trait |
|
32 | HasTraits, MetaHasTraits, TraitType, Any, | |
33 |
Int, Long, Float, Complex, Str, Unicode, Bool, Trait |
|
33 | Int, Long, Float, Complex, Str, Unicode, Bool, TraitError, | |
34 | Undefined, Type, This, Instance |
|
34 | Undefined, Type, This, Instance | |
35 | ) |
|
35 | ) | |
36 |
|
36 | |||
@@ -40,9 +40,9 b' from IPython.utils.traitlets import (' | |||||
40 | #----------------------------------------------------------------------------- |
|
40 | #----------------------------------------------------------------------------- | |
41 |
|
41 | |||
42 |
|
42 | |||
43 |
class HasTrait |
|
43 | class HasTraitsStub(HasTraits): | |
44 |
|
44 | |||
45 |
def _notify_trait |
|
45 | def _notify_trait(self, name, old, new): | |
46 | self._notify_name = name |
|
46 | self._notify_name = name | |
47 | self._notify_old = old |
|
47 | self._notify_old = old | |
48 | self._notify_new = new |
|
48 | self._notify_new = new | |
@@ -53,17 +53,17 b' class HasTraitletsStub(HasTraits):' | |||||
53 | #----------------------------------------------------------------------------- |
|
53 | #----------------------------------------------------------------------------- | |
54 |
|
54 | |||
55 |
|
55 | |||
56 |
class TestTrait |
|
56 | class TestTraitType(TestCase): | |
57 |
|
57 | |||
58 | def test_get_undefined(self): |
|
58 | def test_get_undefined(self): | |
59 | class A(HasTraits): |
|
59 | class A(HasTraits): | |
60 |
a = Trait |
|
60 | a = TraitType | |
61 | a = A() |
|
61 | a = A() | |
62 | self.assertEquals(a.a, Undefined) |
|
62 | self.assertEquals(a.a, Undefined) | |
63 |
|
63 | |||
64 | def test_set(self): |
|
64 | def test_set(self): | |
65 |
class A(HasTrait |
|
65 | class A(HasTraitsStub): | |
66 |
a = Trait |
|
66 | a = TraitType | |
67 |
|
67 | |||
68 | a = A() |
|
68 | a = A() | |
69 | a.a = 10 |
|
69 | a.a = 10 | |
@@ -73,10 +73,10 b' class TestTraitletType(TestCase):' | |||||
73 | self.assertEquals(a._notify_new, 10) |
|
73 | self.assertEquals(a._notify_new, 10) | |
74 |
|
74 | |||
75 | def test_validate(self): |
|
75 | def test_validate(self): | |
76 |
class MyTT(Trait |
|
76 | class MyTT(TraitType): | |
77 | def validate(self, inst, value): |
|
77 | def validate(self, inst, value): | |
78 | return -1 |
|
78 | return -1 | |
79 |
class A(HasTrait |
|
79 | class A(HasTraitsStub): | |
80 | tt = MyTT |
|
80 | tt = MyTT | |
81 |
|
81 | |||
82 | a = A() |
|
82 | a = A() | |
@@ -84,7 +84,7 b' class TestTraitletType(TestCase):' | |||||
84 | self.assertEquals(a.tt, -1) |
|
84 | self.assertEquals(a.tt, -1) | |
85 |
|
85 | |||
86 | def test_default_validate(self): |
|
86 | def test_default_validate(self): | |
87 |
class MyIntTT(Trait |
|
87 | class MyIntTT(TraitType): | |
88 | def validate(self, obj, value): |
|
88 | def validate(self, obj, value): | |
89 | if isinstance(value, int): |
|
89 | if isinstance(value, int): | |
90 | return value |
|
90 | return value | |
@@ -97,10 +97,10 b' class TestTraitletType(TestCase):' | |||||
97 | # Defaults are validated when the HasTraits is instantiated |
|
97 | # Defaults are validated when the HasTraits is instantiated | |
98 | class B(HasTraits): |
|
98 | class B(HasTraits): | |
99 | tt = MyIntTT('bad default') |
|
99 | tt = MyIntTT('bad default') | |
100 |
self.assertRaises(Trait |
|
100 | self.assertRaises(TraitError, B) | |
101 |
|
101 | |||
102 | def test_is_valid_for(self): |
|
102 | def test_is_valid_for(self): | |
103 |
class MyTT(Trait |
|
103 | class MyTT(TraitType): | |
104 | def is_valid_for(self, value): |
|
104 | def is_valid_for(self, value): | |
105 | return True |
|
105 | return True | |
106 | class A(HasTraits): |
|
106 | class A(HasTraits): | |
@@ -111,7 +111,7 b' class TestTraitletType(TestCase):' | |||||
111 | self.assertEquals(a.tt, 10) |
|
111 | self.assertEquals(a.tt, 10) | |
112 |
|
112 | |||
113 | def test_value_for(self): |
|
113 | def test_value_for(self): | |
114 |
class MyTT(Trait |
|
114 | class MyTT(TraitType): | |
115 | def value_for(self, value): |
|
115 | def value_for(self, value): | |
116 | return 20 |
|
116 | return 20 | |
117 | class A(HasTraits): |
|
117 | class A(HasTraits): | |
@@ -123,15 +123,15 b' class TestTraitletType(TestCase):' | |||||
123 |
|
123 | |||
124 | def test_info(self): |
|
124 | def test_info(self): | |
125 | class A(HasTraits): |
|
125 | class A(HasTraits): | |
126 |
tt = Trait |
|
126 | tt = TraitType | |
127 | a = A() |
|
127 | a = A() | |
128 | self.assertEquals(A.tt.info(), 'any value') |
|
128 | self.assertEquals(A.tt.info(), 'any value') | |
129 |
|
129 | |||
130 | def test_error(self): |
|
130 | def test_error(self): | |
131 | class A(HasTraits): |
|
131 | class A(HasTraits): | |
132 |
tt = Trait |
|
132 | tt = TraitType | |
133 | a = A() |
|
133 | a = A() | |
134 |
self.assertRaises(Trait |
|
134 | self.assertRaises(TraitError, A.tt.error, a, 10) | |
135 |
|
135 | |||
136 |
|
136 | |||
137 | class TestHasTraitsMeta(TestCase): |
|
137 | class TestHasTraitsMeta(TestCase): | |
@@ -204,8 +204,8 b' class TestHasTraitsNotify(TestCase):' | |||||
204 | self.assert_(('a',0,10) in self._notify1) |
|
204 | self.assert_(('a',0,10) in self._notify1) | |
205 | a.b = 10.0 |
|
205 | a.b = 10.0 | |
206 | self.assert_(('b',0.0,10.0) in self._notify1) |
|
206 | self.assert_(('b',0.0,10.0) in self._notify1) | |
207 |
self.assertRaises(Trait |
|
207 | self.assertRaises(TraitError,setattr,a,'a','bad string') | |
208 |
self.assertRaises(Trait |
|
208 | self.assertRaises(TraitError,setattr,a,'b','bad string') | |
209 | self._notify1 = [] |
|
209 | self._notify1 = [] | |
210 | a.on_trait_change(self.notify1,remove=True) |
|
210 | a.on_trait_change(self.notify1,remove=True) | |
211 | a.a = 20 |
|
211 | a.a = 20 | |
@@ -224,7 +224,7 b' class TestHasTraitsNotify(TestCase):' | |||||
224 | self.assertEquals(len(self._notify1),0) |
|
224 | self.assertEquals(len(self._notify1),0) | |
225 | a.a = 10 |
|
225 | a.a = 10 | |
226 | self.assert_(('a',0,10) in self._notify1) |
|
226 | self.assert_(('a',0,10) in self._notify1) | |
227 |
self.assertRaises(Trait |
|
227 | self.assertRaises(TraitError,setattr,a,'a','bad string') | |
228 |
|
228 | |||
229 | def test_subclass(self): |
|
229 | def test_subclass(self): | |
230 |
|
230 | |||
@@ -324,7 +324,7 b' class TestHasTraitsNotify(TestCase):' | |||||
324 | self.assertEquals(self.cb,('a',1000,10000)) |
|
324 | self.assertEquals(self.cb,('a',1000,10000)) | |
325 | a.on_trait_change(callback3, 'a', remove=True) |
|
325 | a.on_trait_change(callback3, 'a', remove=True) | |
326 |
|
326 | |||
327 |
self.assertEquals(len(a._trait |
|
327 | self.assertEquals(len(a._trait_notifiers['a']),0) | |
328 |
|
328 | |||
329 |
|
329 | |||
330 | class TestHasTraits(TestCase): |
|
330 | class TestHasTraits(TestCase): | |
@@ -356,17 +356,17 b' class TestHasTraits(TestCase):' | |||||
356 | j = Int(0) |
|
356 | j = Int(0) | |
357 | a = A() |
|
357 | a = A() | |
358 | self.assertEquals(a.traits(), dict(i=A.i, f=A.f, j=A.j)) |
|
358 | self.assertEquals(a.traits(), dict(i=A.i, f=A.f, j=A.j)) | |
359 |
trait |
|
359 | traits = a.traits(config_key='VALUE1', other_thing='VALUE2') | |
360 |
self.assertEquals(trait |
|
360 | self.assertEquals(traits, dict(i=A.i)) | |
361 |
|
361 | |||
362 | # This passes, but it shouldn't because I am replicating a bug in |
|
362 | # This passes, but it shouldn't because I am replicating a bug in | |
363 | # traits. |
|
363 | # traits. | |
364 |
trait |
|
364 | traits = a.traits(config_key=lambda v: True) | |
365 |
self.assertEquals(trait |
|
365 | self.assertEquals(traits, dict(i=A.i, f=A.f, j=A.j)) | |
366 |
|
366 | |||
367 |
|
367 | |||
368 | #----------------------------------------------------------------------------- |
|
368 | #----------------------------------------------------------------------------- | |
369 |
# Tests for specific trait |
|
369 | # Tests for specific trait types | |
370 | #----------------------------------------------------------------------------- |
|
370 | #----------------------------------------------------------------------------- | |
371 |
|
371 | |||
372 |
|
372 | |||
@@ -383,7 +383,7 b' class TestType(TestCase):' | |||||
383 |
|
383 | |||
384 | a.klass = B |
|
384 | a.klass = B | |
385 | self.assertEquals(a.klass, B) |
|
385 | self.assertEquals(a.klass, B) | |
386 |
self.assertRaises(Trait |
|
386 | self.assertRaises(TraitError, setattr, a, 'klass', 10) | |
387 |
|
387 | |||
388 | def test_value(self): |
|
388 | def test_value(self): | |
389 |
|
389 | |||
@@ -394,8 +394,8 b' class TestType(TestCase):' | |||||
394 |
|
394 | |||
395 | a = A() |
|
395 | a = A() | |
396 | self.assertEquals(a.klass, B) |
|
396 | self.assertEquals(a.klass, B) | |
397 |
self.assertRaises(Trait |
|
397 | self.assertRaises(TraitError, setattr, a, 'klass', C) | |
398 |
self.assertRaises(Trait |
|
398 | self.assertRaises(TraitError, setattr, a, 'klass', object) | |
399 | a.klass = B |
|
399 | a.klass = B | |
400 |
|
400 | |||
401 | def test_allow_none(self): |
|
401 | def test_allow_none(self): | |
@@ -407,7 +407,7 b' class TestType(TestCase):' | |||||
407 |
|
407 | |||
408 | a = A() |
|
408 | a = A() | |
409 | self.assertEquals(a.klass, B) |
|
409 | self.assertEquals(a.klass, B) | |
410 |
self.assertRaises(Trait |
|
410 | self.assertRaises(TraitError, setattr, a, 'klass', None) | |
411 | a.klass = C |
|
411 | a.klass = C | |
412 | self.assertEquals(a.klass, C) |
|
412 | self.assertEquals(a.klass, C) | |
413 |
|
413 | |||
@@ -434,7 +434,7 b' class TestType(TestCase):' | |||||
434 | class C(HasTraits): |
|
434 | class C(HasTraits): | |
435 | klass = Type(None, B, allow_none=False) |
|
435 | klass = Type(None, B, allow_none=False) | |
436 |
|
436 | |||
437 |
self.assertRaises(Trait |
|
437 | self.assertRaises(TraitError, C) | |
438 |
|
438 | |||
439 | def test_str_klass(self): |
|
439 | def test_str_klass(self): | |
440 |
|
440 | |||
@@ -446,7 +446,7 b' class TestType(TestCase):' | |||||
446 | a.klass = Struct |
|
446 | a.klass = Struct | |
447 | self.assertEquals(a.klass, Struct) |
|
447 | self.assertEquals(a.klass, Struct) | |
448 |
|
448 | |||
449 |
self.assertRaises(Trait |
|
449 | self.assertRaises(TraitError, setattr, a, 'klass', 10) | |
450 |
|
450 | |||
451 | class TestInstance(TestCase): |
|
451 | class TestInstance(TestCase): | |
452 |
|
452 | |||
@@ -464,9 +464,9 b' class TestInstance(TestCase):' | |||||
464 | self.assert_(isinstance(a.inst, Foo)) |
|
464 | self.assert_(isinstance(a.inst, Foo)) | |
465 | a.inst = Bar() |
|
465 | a.inst = Bar() | |
466 | self.assert_(isinstance(a.inst, Foo)) |
|
466 | self.assert_(isinstance(a.inst, Foo)) | |
467 |
self.assertRaises(Trait |
|
467 | self.assertRaises(TraitError, setattr, a, 'inst', Foo) | |
468 |
self.assertRaises(Trait |
|
468 | self.assertRaises(TraitError, setattr, a, 'inst', Bar) | |
469 |
self.assertRaises(Trait |
|
469 | self.assertRaises(TraitError, setattr, a, 'inst', Bah()) | |
470 |
|
470 | |||
471 | def test_unique_default_value(self): |
|
471 | def test_unique_default_value(self): | |
472 | class Foo(object): pass |
|
472 | class Foo(object): pass | |
@@ -507,7 +507,7 b' class TestInstance(TestCase):' | |||||
507 | class A(HasTraits): |
|
507 | class A(HasTraits): | |
508 | inst = Instance(Foo, allow_none=False) |
|
508 | inst = Instance(Foo, allow_none=False) | |
509 |
|
509 | |||
510 |
self.assertRaises(Trait |
|
510 | self.assertRaises(TraitError, A) | |
511 |
|
511 | |||
512 | def test_instance(self): |
|
512 | def test_instance(self): | |
513 | class Foo(object): pass |
|
513 | class Foo(object): pass | |
@@ -516,7 +516,7 b' class TestInstance(TestCase):' | |||||
516 | class A(HasTraits): |
|
516 | class A(HasTraits): | |
517 | inst = Instance(Foo()) |
|
517 | inst = Instance(Foo()) | |
518 |
|
518 | |||
519 |
self.assertRaises(Trait |
|
519 | self.assertRaises(TraitError, inner) | |
520 |
|
520 | |||
521 |
|
521 | |||
522 | class TestThis(TestCase): |
|
522 | class TestThis(TestCase): | |
@@ -530,7 +530,7 b' class TestThis(TestCase):' | |||||
530 | g = Foo() |
|
530 | g = Foo() | |
531 | f.this = g |
|
531 | f.this = g | |
532 | self.assertEquals(f.this, g) |
|
532 | self.assertEquals(f.this, g) | |
533 |
self.assertRaises(Trait |
|
533 | self.assertRaises(TraitError, setattr, f, 'this', 10) | |
534 |
|
534 | |||
535 | def test_this_inst(self): |
|
535 | def test_this_inst(self): | |
536 | class Foo(HasTraits): |
|
536 | class Foo(HasTraits): | |
@@ -561,10 +561,10 b' class TestThis(TestCase):' | |||||
561 | b = Bar() |
|
561 | b = Bar() | |
562 | f.t = b |
|
562 | f.t = b | |
563 | self.assertEquals(f.t, b) |
|
563 | self.assertEquals(f.t, b) | |
564 |
self.assertRaises(Trait |
|
564 | self.assertRaises(TraitError, setattr, b, 't', f) | |
565 |
|
565 | |||
566 |
class Trait |
|
566 | class TraitTestBase(TestCase): | |
567 |
"""A best testing class for basic trait |
|
567 | """A best testing class for basic trait types.""" | |
568 |
|
568 | |||
569 | def assign(self, value): |
|
569 | def assign(self, value): | |
570 | self.obj.value = value |
|
570 | self.obj.value = value | |
@@ -581,33 +581,33 b' class TraitletTestBase(TestCase):' | |||||
581 | def test_bad_values(self): |
|
581 | def test_bad_values(self): | |
582 | if hasattr(self, '_bad_values'): |
|
582 | if hasattr(self, '_bad_values'): | |
583 | for value in self._bad_values: |
|
583 | for value in self._bad_values: | |
584 |
self.assertRaises(Trait |
|
584 | self.assertRaises(TraitError, self.assign, value) | |
585 |
|
585 | |||
586 | def test_default_value(self): |
|
586 | def test_default_value(self): | |
587 | if hasattr(self, '_default_value'): |
|
587 | if hasattr(self, '_default_value'): | |
588 | self.assertEquals(self._default_value, self.obj.value) |
|
588 | self.assertEquals(self._default_value, self.obj.value) | |
589 |
|
589 | |||
590 |
|
590 | |||
591 |
class AnyTrait |
|
591 | class AnyTrait(HasTraits): | |
592 |
|
592 | |||
593 | value = Any |
|
593 | value = Any | |
594 |
|
594 | |||
595 |
class AnyTraitTest(Trait |
|
595 | class AnyTraitTest(TraitTestBase): | |
596 |
|
596 | |||
597 |
obj = AnyTrait |
|
597 | obj = AnyTrait() | |
598 |
|
598 | |||
599 | _default_value = None |
|
599 | _default_value = None | |
600 | _good_values = [10.0, 'ten', u'ten', [10], {'ten': 10},(10,), None, 1j] |
|
600 | _good_values = [10.0, 'ten', u'ten', [10], {'ten': 10},(10,), None, 1j] | |
601 | _bad_values = [] |
|
601 | _bad_values = [] | |
602 |
|
602 | |||
603 |
|
603 | |||
604 |
class IntTrait |
|
604 | class IntTrait(HasTraits): | |
605 |
|
605 | |||
606 | value = Int(99) |
|
606 | value = Int(99) | |
607 |
|
607 | |||
608 |
class TestInt(Trait |
|
608 | class TestInt(TraitTestBase): | |
609 |
|
609 | |||
610 |
obj = IntTrait |
|
610 | obj = IntTrait() | |
611 | _default_value = 99 |
|
611 | _default_value = 99 | |
612 | _good_values = [10, -10] |
|
612 | _good_values = [10, -10] | |
613 | _bad_values = ['ten', u'ten', [10], {'ten': 10},(10,), None, 1j, 10L, |
|
613 | _bad_values = ['ten', u'ten', [10], {'ten': 10},(10,), None, 1j, 10L, | |
@@ -615,13 +615,13 b' class TestInt(TraitletTestBase):' | |||||
615 | u'-10L', u'10.1', u'-10.1', '10', '-10', u'10', u'-10'] |
|
615 | u'-10L', u'10.1', u'-10.1', '10', '-10', u'10', u'-10'] | |
616 |
|
616 | |||
617 |
|
617 | |||
618 |
class LongTrait |
|
618 | class LongTrait(HasTraits): | |
619 |
|
619 | |||
620 | value = Long(99L) |
|
620 | value = Long(99L) | |
621 |
|
621 | |||
622 |
class TestLong(Trait |
|
622 | class TestLong(TraitTestBase): | |
623 |
|
623 | |||
624 |
obj = LongTrait |
|
624 | obj = LongTrait() | |
625 |
|
625 | |||
626 | _default_value = 99L |
|
626 | _default_value = 99L | |
627 | _good_values = [10, -10, 10L, -10L] |
|
627 | _good_values = [10, -10, 10L, -10L] | |
@@ -631,13 +631,13 b' class TestLong(TraitletTestBase):' | |||||
631 | u'-10.1'] |
|
631 | u'-10.1'] | |
632 |
|
632 | |||
633 |
|
633 | |||
634 |
class FloatTrait |
|
634 | class FloatTrait(HasTraits): | |
635 |
|
635 | |||
636 | value = Float(99.0) |
|
636 | value = Float(99.0) | |
637 |
|
637 | |||
638 |
class TestFloat(Trait |
|
638 | class TestFloat(TraitTestBase): | |
639 |
|
639 | |||
640 |
obj = FloatTrait |
|
640 | obj = FloatTrait() | |
641 |
|
641 | |||
642 | _default_value = 99.0 |
|
642 | _default_value = 99.0 | |
643 | _good_values = [10, -10, 10.1, -10.1] |
|
643 | _good_values = [10, -10, 10.1, -10.1] | |
@@ -646,13 +646,13 b' class TestFloat(TraitletTestBase):' | |||||
646 | u'-10', u'10L', u'-10L', u'10.1', u'-10.1'] |
|
646 | u'-10', u'10L', u'-10L', u'10.1', u'-10.1'] | |
647 |
|
647 | |||
648 |
|
648 | |||
649 |
class ComplexTrait |
|
649 | class ComplexTrait(HasTraits): | |
650 |
|
650 | |||
651 | value = Complex(99.0-99.0j) |
|
651 | value = Complex(99.0-99.0j) | |
652 |
|
652 | |||
653 |
class TestComplex(Trait |
|
653 | class TestComplex(TraitTestBase): | |
654 |
|
654 | |||
655 |
obj = ComplexTrait |
|
655 | obj = ComplexTrait() | |
656 |
|
656 | |||
657 | _default_value = 99.0-99.0j |
|
657 | _default_value = 99.0-99.0j | |
658 | _good_values = [10, -10, 10.1, -10.1, 10j, 10+10j, 10-10j, |
|
658 | _good_values = [10, -10, 10.1, -10.1, 10j, 10+10j, 10-10j, | |
@@ -660,13 +660,13 b' class TestComplex(TraitletTestBase):' | |||||
660 | _bad_values = [10L, -10L, u'10L', u'-10L', 'ten', [10], {'ten': 10},(10,), None] |
|
660 | _bad_values = [10L, -10L, u'10L', u'-10L', 'ten', [10], {'ten': 10},(10,), None] | |
661 |
|
661 | |||
662 |
|
662 | |||
663 |
class StringTrait |
|
663 | class StringTrait(HasTraits): | |
664 |
|
664 | |||
665 | value = Str('string') |
|
665 | value = Str('string') | |
666 |
|
666 | |||
667 |
class TestString(Trait |
|
667 | class TestString(TraitTestBase): | |
668 |
|
668 | |||
669 |
obj = StringTrait |
|
669 | obj = StringTrait() | |
670 |
|
670 | |||
671 | _default_value = 'string' |
|
671 | _default_value = 'string' | |
672 | _good_values = ['10', '-10', '10L', |
|
672 | _good_values = ['10', '-10', '10L', | |
@@ -675,13 +675,13 b' class TestString(TraitletTestBase):' | |||||
675 | ['ten'],{'ten': 10},(10,), None, u'string'] |
|
675 | ['ten'],{'ten': 10},(10,), None, u'string'] | |
676 |
|
676 | |||
677 |
|
677 | |||
678 |
class UnicodeTrait |
|
678 | class UnicodeTrait(HasTraits): | |
679 |
|
679 | |||
680 | value = Unicode(u'unicode') |
|
680 | value = Unicode(u'unicode') | |
681 |
|
681 | |||
682 |
class TestUnicode(Trait |
|
682 | class TestUnicode(TraitTestBase): | |
683 |
|
683 | |||
684 |
obj = UnicodeTrait |
|
684 | obj = UnicodeTrait() | |
685 |
|
685 | |||
686 | _default_value = u'unicode' |
|
686 | _default_value = u'unicode' | |
687 | _good_values = ['10', '-10', '10L', '-10L', '10.1', |
|
687 | _good_values = ['10', '-10', '10L', '-10L', '10.1', |
@@ -17,7 +17,7 b" We don't support:" | |||||
17 | * Delegation |
|
17 | * Delegation | |
18 | * Automatic GUI generation |
|
18 | * Automatic GUI generation | |
19 | * A full set of trait types. Most importantly, we don't provide container |
|
19 | * A full set of trait types. Most importantly, we don't provide container | |
20 |
trait |
|
20 | traits (list, dict, tuple) that can trigger notifications if their | |
21 | contents change. |
|
21 | contents change. | |
22 | * API compatibility with enthought.traits |
|
22 | * API compatibility with enthought.traits | |
23 |
|
23 | |||
@@ -86,16 +86,9 b' NoDefaultSpecified = NoDefaultSpecified()' | |||||
86 | class Undefined ( object ): pass |
|
86 | class Undefined ( object ): pass | |
87 | Undefined = Undefined() |
|
87 | Undefined = Undefined() | |
88 |
|
88 | |||
89 | # The following allows us to test specifically for a TraitletError, or more |
|
|||
90 | # generally for a TraitError if we are going for compatability with Enthought |
|
|||
91 | # Traits |
|
|||
92 | class TraitError(Exception): |
|
89 | class TraitError(Exception): | |
93 | pass |
|
90 | pass | |
94 |
|
91 | |||
95 | class TraitletError(TraitError): |
|
|||
96 | pass |
|
|||
97 |
|
||||
98 |
|
||||
99 | #----------------------------------------------------------------------------- |
|
92 | #----------------------------------------------------------------------------- | |
100 | # Utilities |
|
93 | # Utilities | |
101 | #----------------------------------------------------------------------------- |
|
94 | #----------------------------------------------------------------------------- | |
@@ -168,25 +161,25 b' class _SimpleTest:' | |||||
168 |
|
161 | |||
169 |
|
162 | |||
170 | #----------------------------------------------------------------------------- |
|
163 | #----------------------------------------------------------------------------- | |
171 |
# Base Trait |
|
164 | # Base TraitType for all traits | |
172 | #----------------------------------------------------------------------------- |
|
165 | #----------------------------------------------------------------------------- | |
173 |
|
166 | |||
174 |
|
167 | |||
175 |
class Trait |
|
168 | class TraitType(object): | |
176 |
"""A base class for all trait |
|
169 | """A base class for all trait descriptors. | |
177 |
|
170 | |||
178 | Notes |
|
171 | Notes | |
179 | ----- |
|
172 | ----- | |
180 |
Our implementation of trait |
|
173 | Our implementation of traits is based on Python's descriptor | |
181 | prototol. This class is the base class for all such descriptors. The |
|
174 | prototol. This class is the base class for all such descriptors. The | |
182 | only magic we use is a custom metaclass for the main :class:`HasTraits` |
|
175 | only magic we use is a custom metaclass for the main :class:`HasTraits` | |
183 | class that does the following: |
|
176 | class that does the following: | |
184 |
|
177 | |||
185 |
1. Sets the :attr:`name` attribute of every :class:`Trait |
|
178 | 1. Sets the :attr:`name` attribute of every :class:`TraitType` | |
186 | instance in the class dict to the name of the attribute. |
|
179 | instance in the class dict to the name of the attribute. | |
187 |
2. Sets the :attr:`this_class` attribute of every :class:`Trait |
|
180 | 2. Sets the :attr:`this_class` attribute of every :class:`TraitType` | |
188 |
instance in the class dict to the *class* that declared the trait |
|
181 | instance in the class dict to the *class* that declared the trait. | |
189 |
This is used by the :class:`This` trait |
|
182 | This is used by the :class:`This` trait to allow subclasses to | |
190 | accept superclasses for :class:`This` values. |
|
183 | accept superclasses for :class:`This` values. | |
191 | """ |
|
184 | """ | |
192 |
|
185 | |||
@@ -196,7 +189,7 b' class TraitletType(object):' | |||||
196 | info_text = 'any value' |
|
189 | info_text = 'any value' | |
197 |
|
190 | |||
198 | def __init__(self, default_value=NoDefaultSpecified, **metadata): |
|
191 | def __init__(self, default_value=NoDefaultSpecified, **metadata): | |
199 |
"""Create a Trait |
|
192 | """Create a TraitType. | |
200 | """ |
|
193 | """ | |
201 | if default_value is not NoDefaultSpecified: |
|
194 | if default_value is not NoDefaultSpecified: | |
202 | self.default_value = default_value |
|
195 | self.default_value = default_value | |
@@ -250,10 +243,10 b' class TraitletType(object):' | |||||
250 | """ |
|
243 | """ | |
251 | dv = self.get_default_value() |
|
244 | dv = self.get_default_value() | |
252 | newdv = self._validate(obj, dv) |
|
245 | newdv = self._validate(obj, dv) | |
253 |
obj._trait |
|
246 | obj._trait_values[self.name] = newdv | |
254 |
|
247 | |||
255 | def __get__(self, obj, cls=None): |
|
248 | def __get__(self, obj, cls=None): | |
256 |
"""Get the value of the trait |
|
249 | """Get the value of the trait by self.name for the instance. | |
257 |
|
250 | |||
258 | Default values are instantiated when :meth:`HasTraits.__new__` |
|
251 | Default values are instantiated when :meth:`HasTraits.__new__` | |
259 | is called. Thus by the time this method gets called either the |
|
252 | is called. Thus by the time this method gets called either the | |
@@ -264,11 +257,11 b' class TraitletType(object):' | |||||
264 | return self |
|
257 | return self | |
265 | else: |
|
258 | else: | |
266 | try: |
|
259 | try: | |
267 |
value = obj._trait |
|
260 | value = obj._trait_values[self.name] | |
268 | except: |
|
261 | except: | |
269 | # HasTraits should call set_default_value to populate |
|
262 | # HasTraits should call set_default_value to populate | |
270 | # this. So this should never be reached. |
|
263 | # this. So this should never be reached. | |
271 |
raise Trait |
|
264 | raise TraitError('Unexpected error in TraitType: ' | |
272 | 'default value not set properly') |
|
265 | 'default value not set properly') | |
273 | else: |
|
266 | else: | |
274 | return value |
|
267 | return value | |
@@ -277,8 +270,8 b' class TraitletType(object):' | |||||
277 | new_value = self._validate(obj, value) |
|
270 | new_value = self._validate(obj, value) | |
278 | old_value = self.__get__(obj) |
|
271 | old_value = self.__get__(obj) | |
279 | if old_value != new_value: |
|
272 | if old_value != new_value: | |
280 |
obj._trait |
|
273 | obj._trait_values[self.name] = new_value | |
281 |
obj._notify_trait |
|
274 | obj._notify_trait(self.name, old_value, new_value) | |
282 |
|
275 | |||
283 | def _validate(self, obj, value): |
|
276 | def _validate(self, obj, value): | |
284 | if hasattr(self, 'validate'): |
|
277 | if hasattr(self, 'validate'): | |
@@ -288,7 +281,7 b' class TraitletType(object):' | |||||
288 | if valid: |
|
281 | if valid: | |
289 | return value |
|
282 | return value | |
290 | else: |
|
283 | else: | |
291 |
raise Trait |
|
284 | raise TraitError('invalid value for type: %r' % value) | |
292 | elif hasattr(self, 'value_for'): |
|
285 | elif hasattr(self, 'value_for'): | |
293 | return self.value_for(value) |
|
286 | return self.value_for(value) | |
294 | else: |
|
287 | else: | |
@@ -299,13 +292,13 b' class TraitletType(object):' | |||||
299 |
|
292 | |||
300 | def error(self, obj, value): |
|
293 | def error(self, obj, value): | |
301 | if obj is not None: |
|
294 | if obj is not None: | |
302 |
e = "The '%s' trait |
|
295 | e = "The '%s' trait of %s instance must be %s, but a value of %s was specified." \ | |
303 | % (self.name, class_of(obj), |
|
296 | % (self.name, class_of(obj), | |
304 | self.info(), repr_type(value)) |
|
297 | self.info(), repr_type(value)) | |
305 | else: |
|
298 | else: | |
306 |
e = "The '%s' trait |
|
299 | e = "The '%s' trait must be %s, but a value of %r was specified." \ | |
307 | % (self.name, self.info(), repr_type(value)) |
|
300 | % (self.name, self.info(), repr_type(value)) | |
308 |
raise Trait |
|
301 | raise TraitError(e) | |
309 |
|
302 | |||
310 | def get_metadata(self, key): |
|
303 | def get_metadata(self, key): | |
311 | return getattr(self, '_metadata', {}).get(key, None) |
|
304 | return getattr(self, '_metadata', {}).get(key, None) | |
@@ -322,21 +315,21 b' class TraitletType(object):' | |||||
322 | class MetaHasTraits(type): |
|
315 | class MetaHasTraits(type): | |
323 | """A metaclass for HasTraits. |
|
316 | """A metaclass for HasTraits. | |
324 |
|
317 | |||
325 |
This metaclass makes sure that any Trait |
|
318 | This metaclass makes sure that any TraitType class attributes are | |
326 | instantiated and sets their name attribute. |
|
319 | instantiated and sets their name attribute. | |
327 | """ |
|
320 | """ | |
328 |
|
321 | |||
329 | def __new__(mcls, name, bases, classdict): |
|
322 | def __new__(mcls, name, bases, classdict): | |
330 | """Create the HasTraits class. |
|
323 | """Create the HasTraits class. | |
331 |
|
324 | |||
332 |
This instantiates all Trait |
|
325 | This instantiates all TraitTypes in the class dict and sets their | |
333 | :attr:`name` attribute. |
|
326 | :attr:`name` attribute. | |
334 | """ |
|
327 | """ | |
335 | for k,v in classdict.iteritems(): |
|
328 | for k,v in classdict.iteritems(): | |
336 |
if isinstance(v, Trait |
|
329 | if isinstance(v, TraitType): | |
337 | v.name = k |
|
330 | v.name = k | |
338 | elif inspect.isclass(v): |
|
331 | elif inspect.isclass(v): | |
339 |
if issubclass(v, Trait |
|
332 | if issubclass(v, TraitType): | |
340 | vinst = v() |
|
333 | vinst = v() | |
341 | vinst.name = k |
|
334 | vinst.name = k | |
342 | classdict[k] = vinst |
|
335 | classdict[k] = vinst | |
@@ -345,11 +338,11 b' class MetaHasTraits(type):' | |||||
345 | def __init__(cls, name, bases, classdict): |
|
338 | def __init__(cls, name, bases, classdict): | |
346 | """Finish initializing the HasTraits class. |
|
339 | """Finish initializing the HasTraits class. | |
347 |
|
340 | |||
348 |
This sets the :attr:`this_class` attribute of each Trait |
|
341 | This sets the :attr:`this_class` attribute of each TraitType in the | |
349 | class dict to the newly created class ``cls``. |
|
342 | class dict to the newly created class ``cls``. | |
350 | """ |
|
343 | """ | |
351 | for k, v in classdict.iteritems(): |
|
344 | for k, v in classdict.iteritems(): | |
352 |
if isinstance(v, Trait |
|
345 | if isinstance(v, TraitType): | |
353 | v.this_class = cls |
|
346 | v.this_class = cls | |
354 | super(MetaHasTraits, cls).__init__(name, bases, classdict) |
|
347 | super(MetaHasTraits, cls).__init__(name, bases, classdict) | |
355 |
|
348 | |||
@@ -365,25 +358,25 b' class HasTraits(object):' | |||||
365 | inst = new_meth(cls) |
|
358 | inst = new_meth(cls) | |
366 | else: |
|
359 | else: | |
367 | inst = new_meth(cls, *args, **kw) |
|
360 | inst = new_meth(cls, *args, **kw) | |
368 |
inst._trait |
|
361 | inst._trait_values = {} | |
369 |
inst._trait |
|
362 | inst._trait_notifiers = {} | |
370 |
# Here we tell all the Trait |
|
363 | # Here we tell all the TraitType instances to set their default | |
371 | # values on the instance. |
|
364 | # values on the instance. | |
372 | for key in dir(cls): |
|
365 | for key in dir(cls): | |
373 | value = getattr(cls, key) |
|
366 | value = getattr(cls, key) | |
374 |
if isinstance(value, Trait |
|
367 | if isinstance(value, TraitType): | |
375 | value.instance_init(inst) |
|
368 | value.instance_init(inst) | |
376 | return inst |
|
369 | return inst | |
377 |
|
370 | |||
378 | # def __init__(self): |
|
371 | # def __init__(self): | |
379 |
# self._trait |
|
372 | # self._trait_values = {} | |
380 |
# self._trait |
|
373 | # self._trait_notifiers = {} | |
381 |
|
374 | |||
382 |
def _notify_trait |
|
375 | def _notify_trait(self, name, old_value, new_value): | |
383 |
|
376 | |||
384 | # First dynamic ones |
|
377 | # First dynamic ones | |
385 |
callables = self._trait |
|
378 | callables = self._trait_notifiers.get(name,[]) | |
386 |
more_callables = self._trait |
|
379 | more_callables = self._trait_notifiers.get('anytrait',[]) | |
387 | callables.extend(more_callables) |
|
380 | callables.extend(more_callables) | |
388 |
|
381 | |||
389 | # Now static ones |
|
382 | # Now static ones | |
@@ -416,25 +409,25 b' class HasTraits(object):' | |||||
416 | elif nargs + offset == 3: |
|
409 | elif nargs + offset == 3: | |
417 | c(name, old_value, new_value) |
|
410 | c(name, old_value, new_value) | |
418 | else: |
|
411 | else: | |
419 |
raise Trait |
|
412 | raise TraitError('a trait changed callback ' | |
420 | 'must have 0-3 arguments.') |
|
413 | 'must have 0-3 arguments.') | |
421 | else: |
|
414 | else: | |
422 |
raise Trait |
|
415 | raise TraitError('a trait changed callback ' | |
423 | 'must be callable.') |
|
416 | 'must be callable.') | |
424 |
|
417 | |||
425 |
|
418 | |||
426 | def _add_notifiers(self, handler, name): |
|
419 | def _add_notifiers(self, handler, name): | |
427 |
if not self._trait |
|
420 | if not self._trait_notifiers.has_key(name): | |
428 | nlist = [] |
|
421 | nlist = [] | |
429 |
self._trait |
|
422 | self._trait_notifiers[name] = nlist | |
430 | else: |
|
423 | else: | |
431 |
nlist = self._trait |
|
424 | nlist = self._trait_notifiers[name] | |
432 | if handler not in nlist: |
|
425 | if handler not in nlist: | |
433 | nlist.append(handler) |
|
426 | nlist.append(handler) | |
434 |
|
427 | |||
435 | def _remove_notifiers(self, handler, name): |
|
428 | def _remove_notifiers(self, handler, name): | |
436 |
if self._trait |
|
429 | if self._trait_notifiers.has_key(name): | |
437 |
nlist = self._trait |
|
430 | nlist = self._trait_notifiers[name] | |
438 | try: |
|
431 | try: | |
439 | index = nlist.index(handler) |
|
432 | index = nlist.index(handler) | |
440 | except ValueError: |
|
433 | except ValueError: | |
@@ -443,24 +436,24 b' class HasTraits(object):' | |||||
443 | del nlist[index] |
|
436 | del nlist[index] | |
444 |
|
437 | |||
445 | def on_trait_change(self, handler, name=None, remove=False): |
|
438 | def on_trait_change(self, handler, name=None, remove=False): | |
446 |
"""Setup a handler to be called when a trait |
|
439 | """Setup a handler to be called when a trait changes. | |
447 |
|
440 | |||
448 |
This is used to setup dynamic notifications of trait |
|
441 | This is used to setup dynamic notifications of trait changes. | |
449 |
|
442 | |||
450 | Static handlers can be created by creating methods on a HasTraits |
|
443 | Static handlers can be created by creating methods on a HasTraits | |
451 |
subclass with the naming convention '_[trait |
|
444 | subclass with the naming convention '_[traitname]_changed'. Thus, | |
452 |
to create static handler for the trait |
|
445 | to create static handler for the trait 'a', create the method | |
453 | _a_changed(self, name, old, new) (fewer arguments can be used, see |
|
446 | _a_changed(self, name, old, new) (fewer arguments can be used, see | |
454 | below). |
|
447 | below). | |
455 |
|
448 | |||
456 | Parameters |
|
449 | Parameters | |
457 | ---------- |
|
450 | ---------- | |
458 | handler : callable |
|
451 | handler : callable | |
459 |
A callable that is called when a trait |
|
452 | A callable that is called when a trait changes. Its | |
460 | signature can be handler(), handler(name), handler(name, new) |
|
453 | signature can be handler(), handler(name), handler(name, new) | |
461 | or handler(name, old, new). |
|
454 | or handler(name, old, new). | |
462 | name : list, str, None |
|
455 | name : list, str, None | |
463 |
If None, the handler will apply to all trait |
|
456 | If None, the handler will apply to all traits. If a list | |
464 | of str, handler will apply to all names in the list. If a |
|
457 | of str, handler will apply to all names in the list. If a | |
465 | str, the handler will apply just to that name. |
|
458 | str, the handler will apply just to that name. | |
466 | remove : bool |
|
459 | remove : bool | |
@@ -477,61 +470,61 b' class HasTraits(object):' | |||||
477 | self._add_notifiers(handler, n) |
|
470 | self._add_notifiers(handler, n) | |
478 |
|
471 | |||
479 | def trait_names(self, **metadata): |
|
472 | def trait_names(self, **metadata): | |
480 |
"""Get a list of all the names of this classes trait |
|
473 | """Get a list of all the names of this classes traits.""" | |
481 | return self.traits(**metadata).keys() |
|
474 | return self.traits(**metadata).keys() | |
482 |
|
475 | |||
483 | def traits(self, **metadata): |
|
476 | def traits(self, **metadata): | |
484 |
"""Get a list of all the trait |
|
477 | """Get a list of all the traits of this class. | |
485 |
|
478 | |||
486 |
The Trait |
|
479 | The TraitTypes returned don't know anything about the values | |
487 |
that the various HasTrait |
|
480 | that the various HasTrait's instances are holding. | |
488 |
|
481 | |||
489 | This follows the same algorithm as traits does and does not allow |
|
482 | This follows the same algorithm as traits does and does not allow | |
490 | for any simple way of specifying merely that a metadata name |
|
483 | for any simple way of specifying merely that a metadata name | |
491 | exists, but has any value. This is because get_metadata returns |
|
484 | exists, but has any value. This is because get_metadata returns | |
492 | None if a metadata key doesn't exist. |
|
485 | None if a metadata key doesn't exist. | |
493 | """ |
|
486 | """ | |
494 |
trait |
|
487 | traits = dict([memb for memb in inspect.getmembers(self.__class__) if \ | |
495 |
isinstance(memb[1], Trait |
|
488 | isinstance(memb[1], TraitType)]) | |
496 |
|
489 | |||
497 | if len(metadata) == 0: |
|
490 | if len(metadata) == 0: | |
498 |
return trait |
|
491 | return traits | |
499 |
|
492 | |||
500 | for meta_name, meta_eval in metadata.items(): |
|
493 | for meta_name, meta_eval in metadata.items(): | |
501 | if type(meta_eval) is not FunctionType: |
|
494 | if type(meta_eval) is not FunctionType: | |
502 | metadata[meta_name] = _SimpleTest(meta_eval) |
|
495 | metadata[meta_name] = _SimpleTest(meta_eval) | |
503 |
|
496 | |||
504 | result = {} |
|
497 | result = {} | |
505 |
for name, trait |
|
498 | for name, trait in traits.items(): | |
506 | for meta_name, meta_eval in metadata.items(): |
|
499 | for meta_name, meta_eval in metadata.items(): | |
507 |
if not meta_eval(trait |
|
500 | if not meta_eval(trait.get_metadata(meta_name)): | |
508 | break |
|
501 | break | |
509 | else: |
|
502 | else: | |
510 |
result[name] = trait |
|
503 | result[name] = trait | |
511 |
|
504 | |||
512 | return result |
|
505 | return result | |
513 |
|
506 | |||
514 |
def trait_metadata(self, trait |
|
507 | def trait_metadata(self, traitname, key): | |
515 |
"""Get metadata values for trait |
|
508 | """Get metadata values for trait by key.""" | |
516 | try: |
|
509 | try: | |
517 |
trait |
|
510 | trait = getattr(self.__class__, traitname) | |
518 | except AttributeError: |
|
511 | except AttributeError: | |
519 |
raise Trait |
|
512 | raise TraitError("Class %s does not have a trait named %s" % | |
520 |
(self.__class__.__name__, trait |
|
513 | (self.__class__.__name__, traitname)) | |
521 | else: |
|
514 | else: | |
522 |
return trait |
|
515 | return trait.get_metadata(key) | |
523 |
|
516 | |||
524 | #----------------------------------------------------------------------------- |
|
517 | #----------------------------------------------------------------------------- | |
525 |
# Actual Trait |
|
518 | # Actual TraitTypes implementations/subclasses | |
526 | #----------------------------------------------------------------------------- |
|
519 | #----------------------------------------------------------------------------- | |
527 |
|
520 | |||
528 | #----------------------------------------------------------------------------- |
|
521 | #----------------------------------------------------------------------------- | |
529 |
# Trait |
|
522 | # TraitTypes subclasses for handling classes and instances of classes | |
530 | #----------------------------------------------------------------------------- |
|
523 | #----------------------------------------------------------------------------- | |
531 |
|
524 | |||
532 |
|
525 | |||
533 |
class ClassBasedTrait |
|
526 | class ClassBasedTraitType(TraitType): | |
534 |
"""A trait |
|
527 | """A trait with error reporting for Type, Instance and This.""" | |
535 |
|
528 | |||
536 | def error(self, obj, value): |
|
529 | def error(self, obj, value): | |
537 | kind = type(value) |
|
530 | kind = type(value) | |
@@ -540,16 +533,16 b' class ClassBasedTraitletType(TraitletType):' | |||||
540 | else: |
|
533 | else: | |
541 | msg = '%s (i.e. %s)' % ( str( kind )[1:-1], repr( value ) ) |
|
534 | msg = '%s (i.e. %s)' % ( str( kind )[1:-1], repr( value ) ) | |
542 |
|
535 | |||
543 |
super(ClassBasedTrait |
|
536 | super(ClassBasedTraitType, self).error(obj, msg) | |
544 |
|
537 | |||
545 |
|
538 | |||
546 |
class Type(ClassBasedTrait |
|
539 | class Type(ClassBasedTraitType): | |
547 |
"""A trait |
|
540 | """A trait whose value must be a subclass of a specified class.""" | |
548 |
|
541 | |||
549 | def __init__ (self, default_value=None, klass=None, allow_none=True, **metadata ): |
|
542 | def __init__ (self, default_value=None, klass=None, allow_none=True, **metadata ): | |
550 |
"""Construct a Type trait |
|
543 | """Construct a Type trait | |
551 |
|
544 | |||
552 |
A Type trait |
|
545 | A Type trait specifies that its values must be subclasses of | |
553 | a particular class. |
|
546 | a particular class. | |
554 |
|
547 | |||
555 | If only ``default_value`` is given, it is used for the ``klass`` as |
|
548 | If only ``default_value`` is given, it is used for the ``klass`` as | |
@@ -563,7 +556,7 b' class Type(ClassBasedTraitletType):' | |||||
563 | The string is resolved into real class, when the parent |
|
556 | The string is resolved into real class, when the parent | |
564 | :class:`HasTraits` class is instantiated. |
|
557 | :class:`HasTraits` class is instantiated. | |
565 | klass : class, str, None |
|
558 | klass : class, str, None | |
566 |
Values of this trait |
|
559 | Values of this trait must be a subclass of klass. The klass | |
567 | may be specified in a string like: 'foo.bar.MyClass'. |
|
560 | may be specified in a string like: 'foo.bar.MyClass'. | |
568 | The string is resolved into real class, when the parent |
|
561 | The string is resolved into real class, when the parent | |
569 | :class:`HasTraits` class is instantiated. |
|
562 | :class:`HasTraits` class is instantiated. | |
@@ -578,7 +571,7 b' class Type(ClassBasedTraitletType):' | |||||
578 | klass = default_value |
|
571 | klass = default_value | |
579 |
|
572 | |||
580 | if not (inspect.isclass(klass) or isinstance(klass, basestring)): |
|
573 | if not (inspect.isclass(klass) or isinstance(klass, basestring)): | |
581 |
raise Trait |
|
574 | raise TraitError("A Type trait must specify a class.") | |
582 |
|
575 | |||
583 | self.klass = klass |
|
576 | self.klass = klass | |
584 | self._allow_none = allow_none |
|
577 | self._allow_none = allow_none | |
@@ -632,7 +625,7 b' class DefaultValueGenerator(object):' | |||||
632 | return klass(*self.args, **self.kw) |
|
625 | return klass(*self.args, **self.kw) | |
633 |
|
626 | |||
634 |
|
627 | |||
635 |
class Instance(ClassBasedTrait |
|
628 | class Instance(ClassBasedTraitType): | |
636 | """A trait whose value must be an instance of a specified class. |
|
629 | """A trait whose value must be an instance of a specified class. | |
637 |
|
630 | |||
638 | The value can also be an instance of a subclass of the specified class. |
|
631 | The value can also be an instance of a subclass of the specified class. | |
@@ -640,9 +633,9 b' class Instance(ClassBasedTraitletType):' | |||||
640 |
|
633 | |||
641 | def __init__(self, klass=None, args=None, kw=None, |
|
634 | def __init__(self, klass=None, args=None, kw=None, | |
642 | allow_none=True, **metadata ): |
|
635 | allow_none=True, **metadata ): | |
643 |
"""Construct an Instance trait |
|
636 | """Construct an Instance trait. | |
644 |
|
637 | |||
645 |
This trait |
|
638 | This trait allows values that are instances of a particular | |
646 | class or its sublclasses. Our implementation is quite different |
|
639 | class or its sublclasses. Our implementation is quite different | |
647 | from that of enthough.traits as we don't allow instances to be used |
|
640 | from that of enthough.traits as we don't allow instances to be used | |
648 | for klass and we handle the ``args`` and ``kw`` arguments differently. |
|
641 | for klass and we handle the ``args`` and ``kw`` arguments differently. | |
@@ -650,7 +643,7 b' class Instance(ClassBasedTraitletType):' | |||||
650 | Parameters |
|
643 | Parameters | |
651 | ---------- |
|
644 | ---------- | |
652 | klass : class, str |
|
645 | klass : class, str | |
653 |
The class that forms the basis for the trait |
|
646 | The class that forms the basis for the trait. Class names | |
654 | can also be specified as strings, like 'foo.bar.Bar'. |
|
647 | can also be specified as strings, like 'foo.bar.Bar'. | |
655 | args : tuple |
|
648 | args : tuple | |
656 | Positional arguments for generating the default value. |
|
649 | Positional arguments for generating the default value. | |
@@ -670,7 +663,7 b' class Instance(ClassBasedTraitletType):' | |||||
670 | self._allow_none = allow_none |
|
663 | self._allow_none = allow_none | |
671 |
|
664 | |||
672 | if (klass is None) or (not (inspect.isclass(klass) or isinstance(klass, basestring))): |
|
665 | if (klass is None) or (not (inspect.isclass(klass) or isinstance(klass, basestring))): | |
673 |
raise Trait |
|
666 | raise TraitError('The klass argument must be a class' | |
674 | ' you gave: %r' % klass) |
|
667 | ' you gave: %r' % klass) | |
675 | self.klass = klass |
|
668 | self.klass = klass | |
676 |
|
669 | |||
@@ -686,9 +679,9 b' class Instance(ClassBasedTraitletType):' | |||||
686 | kw = {} |
|
679 | kw = {} | |
687 |
|
680 | |||
688 | if not isinstance(kw, dict): |
|
681 | if not isinstance(kw, dict): | |
689 |
raise Trait |
|
682 | raise TraitError("The 'kw' argument must be a dict or None.") | |
690 | if not isinstance(args, tuple): |
|
683 | if not isinstance(args, tuple): | |
691 |
raise Trait |
|
684 | raise TraitError("The 'args' argument must be a tuple or None.") | |
692 |
|
685 | |||
693 | default_value = DefaultValueGenerator(*args, **kw) |
|
686 | default_value = DefaultValueGenerator(*args, **kw) | |
694 |
|
687 | |||
@@ -738,11 +731,11 b' class Instance(ClassBasedTraitletType):' | |||||
738 | return dv |
|
731 | return dv | |
739 |
|
732 | |||
740 |
|
733 | |||
741 |
class This(ClassBasedTrait |
|
734 | class This(ClassBasedTraitType): | |
742 |
"""A trait |
|
735 | """A trait for instances of the class containing this trait. | |
743 |
|
736 | |||
744 | Because how how and when class bodies are executed, the ``This`` |
|
737 | Because how how and when class bodies are executed, the ``This`` | |
745 |
trait |
|
738 | trait can only have a default value of None. This, and because we | |
746 | always validate default values, ``allow_none`` is *always* true. |
|
739 | always validate default values, ``allow_none`` is *always* true. | |
747 | """ |
|
740 | """ | |
748 |
|
741 | |||
@@ -754,7 +747,7 b' class This(ClassBasedTraitletType):' | |||||
754 | def validate(self, obj, value): |
|
747 | def validate(self, obj, value): | |
755 | # What if value is a superclass of obj.__class__? This is |
|
748 | # What if value is a superclass of obj.__class__? This is | |
756 | # complicated if it was the superclass that defined the This |
|
749 | # complicated if it was the superclass that defined the This | |
757 |
# trait |
|
750 | # trait. | |
758 | if isinstance(value, self.this_class) or (value is None): |
|
751 | if isinstance(value, self.this_class) or (value is None): | |
759 | return value |
|
752 | return value | |
760 | else: |
|
753 | else: | |
@@ -762,17 +755,17 b' class This(ClassBasedTraitletType):' | |||||
762 |
|
755 | |||
763 |
|
756 | |||
764 | #----------------------------------------------------------------------------- |
|
757 | #----------------------------------------------------------------------------- | |
765 |
# Basic Trait |
|
758 | # Basic TraitTypes implementations/subclasses | |
766 | #----------------------------------------------------------------------------- |
|
759 | #----------------------------------------------------------------------------- | |
767 |
|
760 | |||
768 |
|
761 | |||
769 |
class Any(Trait |
|
762 | class Any(TraitType): | |
770 | default_value = None |
|
763 | default_value = None | |
771 | info_text = 'any value' |
|
764 | info_text = 'any value' | |
772 |
|
765 | |||
773 |
|
766 | |||
774 |
class Int(Trait |
|
767 | class Int(TraitType): | |
775 |
"""A integer trait |
|
768 | """A integer trait.""" | |
776 |
|
769 | |||
777 | evaluate = int |
|
770 | evaluate = int | |
778 | default_value = 0 |
|
771 | default_value = 0 | |
@@ -784,7 +777,7 b' class Int(TraitletType):' | |||||
784 | self.error(obj, value) |
|
777 | self.error(obj, value) | |
785 |
|
778 | |||
786 | class CInt(Int): |
|
779 | class CInt(Int): | |
787 |
"""A casting version of the int trait |
|
780 | """A casting version of the int trait.""" | |
788 |
|
781 | |||
789 | def validate(self, obj, value): |
|
782 | def validate(self, obj, value): | |
790 | try: |
|
783 | try: | |
@@ -793,8 +786,8 b' class CInt(Int):' | |||||
793 | self.error(obj, value) |
|
786 | self.error(obj, value) | |
794 |
|
787 | |||
795 |
|
788 | |||
796 |
class Long(Trait |
|
789 | class Long(TraitType): | |
797 |
"""A long integer trait |
|
790 | """A long integer trait.""" | |
798 |
|
791 | |||
799 | evaluate = long |
|
792 | evaluate = long | |
800 | default_value = 0L |
|
793 | default_value = 0L | |
@@ -809,7 +802,7 b' class Long(TraitletType):' | |||||
809 |
|
802 | |||
810 |
|
803 | |||
811 | class CLong(Long): |
|
804 | class CLong(Long): | |
812 |
"""A casting version of the long integer trait |
|
805 | """A casting version of the long integer trait.""" | |
813 |
|
806 | |||
814 | def validate(self, obj, value): |
|
807 | def validate(self, obj, value): | |
815 | try: |
|
808 | try: | |
@@ -818,8 +811,8 b' class CLong(Long):' | |||||
818 | self.error(obj, value) |
|
811 | self.error(obj, value) | |
819 |
|
812 | |||
820 |
|
813 | |||
821 |
class Float(Trait |
|
814 | class Float(TraitType): | |
822 |
"""A float trait |
|
815 | """A float trait.""" | |
823 |
|
816 | |||
824 | evaluate = float |
|
817 | evaluate = float | |
825 | default_value = 0.0 |
|
818 | default_value = 0.0 | |
@@ -834,7 +827,7 b' class Float(TraitletType):' | |||||
834 |
|
827 | |||
835 |
|
828 | |||
836 | class CFloat(Float): |
|
829 | class CFloat(Float): | |
837 |
"""A casting version of the float trait |
|
830 | """A casting version of the float trait.""" | |
838 |
|
831 | |||
839 | def validate(self, obj, value): |
|
832 | def validate(self, obj, value): | |
840 | try: |
|
833 | try: | |
@@ -842,8 +835,8 b' class CFloat(Float):' | |||||
842 | except: |
|
835 | except: | |
843 | self.error(obj, value) |
|
836 | self.error(obj, value) | |
844 |
|
837 | |||
845 |
class Complex(Trait |
|
838 | class Complex(TraitType): | |
846 |
"""A trait |
|
839 | """A trait for complex numbers.""" | |
847 |
|
840 | |||
848 | evaluate = complex |
|
841 | evaluate = complex | |
849 | default_value = 0.0 + 0.0j |
|
842 | default_value = 0.0 + 0.0j | |
@@ -858,7 +851,7 b' class Complex(TraitletType):' | |||||
858 |
|
851 | |||
859 |
|
852 | |||
860 | class CComplex(Complex): |
|
853 | class CComplex(Complex): | |
861 |
"""A casting version of the complex number trait |
|
854 | """A casting version of the complex number trait.""" | |
862 |
|
855 | |||
863 | def validate (self, obj, value): |
|
856 | def validate (self, obj, value): | |
864 | try: |
|
857 | try: | |
@@ -867,8 +860,8 b' class CComplex(Complex):' | |||||
867 | self.error(obj, value) |
|
860 | self.error(obj, value) | |
868 |
|
861 | |||
869 |
|
862 | |||
870 |
class Str(Trait |
|
863 | class Str(TraitType): | |
871 |
"""A trait |
|
864 | """A trait for strings.""" | |
872 |
|
865 | |||
873 | evaluate = lambda x: x |
|
866 | evaluate = lambda x: x | |
874 | default_value = '' |
|
867 | default_value = '' | |
@@ -881,7 +874,7 b' class Str(TraitletType):' | |||||
881 |
|
874 | |||
882 |
|
875 | |||
883 | class CStr(Str): |
|
876 | class CStr(Str): | |
884 |
"""A casting version of the string trait |
|
877 | """A casting version of the string trait.""" | |
885 |
|
878 | |||
886 | def validate(self, obj, value): |
|
879 | def validate(self, obj, value): | |
887 | try: |
|
880 | try: | |
@@ -893,8 +886,8 b' class CStr(Str):' | |||||
893 | self.error(obj, value) |
|
886 | self.error(obj, value) | |
894 |
|
887 | |||
895 |
|
888 | |||
896 |
class Unicode(Trait |
|
889 | class Unicode(TraitType): | |
897 |
"""A trait |
|
890 | """A trait for unicode strings.""" | |
898 |
|
891 | |||
899 | evaluate = unicode |
|
892 | evaluate = unicode | |
900 | default_value = u'' |
|
893 | default_value = u'' | |
@@ -909,7 +902,7 b' class Unicode(TraitletType):' | |||||
909 |
|
902 | |||
910 |
|
903 | |||
911 | class CUnicode(Unicode): |
|
904 | class CUnicode(Unicode): | |
912 |
"""A casting version of the unicode trait |
|
905 | """A casting version of the unicode trait.""" | |
913 |
|
906 | |||
914 | def validate(self, obj, value): |
|
907 | def validate(self, obj, value): | |
915 | try: |
|
908 | try: | |
@@ -918,8 +911,8 b' class CUnicode(Unicode):' | |||||
918 | self.error(obj, value) |
|
911 | self.error(obj, value) | |
919 |
|
912 | |||
920 |
|
913 | |||
921 |
class Bool(Trait |
|
914 | class Bool(TraitType): | |
922 |
"""A boolean (True, False) trait |
|
915 | """A boolean (True, False) trait.""" | |
923 | evaluate = bool |
|
916 | evaluate = bool | |
924 | default_value = False |
|
917 | default_value = False | |
925 | info_text = 'a boolean' |
|
918 | info_text = 'a boolean' | |
@@ -931,7 +924,7 b' class Bool(TraitletType):' | |||||
931 |
|
924 | |||
932 |
|
925 | |||
933 | class CBool(Bool): |
|
926 | class CBool(Bool): | |
934 |
"""A casting version of the boolean trait |
|
927 | """A casting version of the boolean trait.""" | |
935 |
|
928 | |||
936 | def validate(self, obj, value): |
|
929 | def validate(self, obj, value): | |
937 | try: |
|
930 | try: | |
@@ -940,7 +933,7 b' class CBool(Bool):' | |||||
940 | self.error(obj, value) |
|
933 | self.error(obj, value) | |
941 |
|
934 | |||
942 |
|
935 | |||
943 |
class Enum(Trait |
|
936 | class Enum(TraitType): | |
944 | """An enum that whose value must be in a given sequence.""" |
|
937 | """An enum that whose value must be in a given sequence.""" | |
945 |
|
938 | |||
946 | def __init__(self, values, default_value=None, allow_none=True, **metadata): |
|
939 | def __init__(self, values, default_value=None, allow_none=True, **metadata): | |
@@ -985,7 +978,7 b' class List(Instance):' | |||||
985 | """An instance of a Python list.""" |
|
978 | """An instance of a Python list.""" | |
986 |
|
979 | |||
987 | def __init__(self, default_value=None, allow_none=True, **metadata): |
|
980 | def __init__(self, default_value=None, allow_none=True, **metadata): | |
988 |
"""Create a list trait |
|
981 | """Create a list trait type from a list or tuple. | |
989 |
|
982 | |||
990 | The default value is created by doing ``list(default_value)``, |
|
983 | The default value is created by doing ``list(default_value)``, | |
991 | which creates a copy of the ``default_value``. |
|
984 | which creates a copy of the ``default_value``. |
General Comments 0
You need to be logged in to leave comments.
Login now