##// END OF EJS Templates
DEV: Forward this_class in container traits....
Scott Sanderson -
Show More
@@ -1,1308 +1,1322 b''
1 1 # encoding: utf-8
2 2 """Tests for IPython.utils.traitlets."""
3 3
4 4 # Copyright (c) IPython Development Team.
5 5 # Distributed under the terms of the Modified BSD License.
6 6 #
7 7 # Adapted from enthought.traits, Copyright (c) Enthought, Inc.,
8 8 # also under the terms of the Modified BSD License.
9 9
10 10 import pickle
11 11 import re
12 12 import sys
13 13 from unittest import TestCase
14 14
15 15 import nose.tools as nt
16 16 from nose import SkipTest
17 17
18 18 from IPython.utils.traitlets import (
19 19 HasTraits, MetaHasTraits, TraitType, Any, CBytes, Dict,
20 20 Int, Long, Integer, Float, Complex, Bytes, Unicode, TraitError,
21 21 Undefined, Type, This, Instance, TCPAddress, List, Tuple,
22 22 ObjectName, DottedObjectName, CRegExp, link, directional_link,
23 23 EventfulList, EventfulDict
24 24 )
25 25 from IPython.utils import py3compat
26 26 from IPython.testing.decorators import skipif
27 27
28 28 #-----------------------------------------------------------------------------
29 29 # Helper classes for testing
30 30 #-----------------------------------------------------------------------------
31 31
32 32
33 33 class HasTraitsStub(HasTraits):
34 34
35 35 def _notify_trait(self, name, old, new):
36 36 self._notify_name = name
37 37 self._notify_old = old
38 38 self._notify_new = new
39 39
40 40
41 41 #-----------------------------------------------------------------------------
42 42 # Test classes
43 43 #-----------------------------------------------------------------------------
44 44
45 45
46 46 class TestTraitType(TestCase):
47 47
48 48 def test_get_undefined(self):
49 49 class A(HasTraits):
50 50 a = TraitType
51 51 a = A()
52 52 self.assertEqual(a.a, Undefined)
53 53
54 54 def test_set(self):
55 55 class A(HasTraitsStub):
56 56 a = TraitType
57 57
58 58 a = A()
59 59 a.a = 10
60 60 self.assertEqual(a.a, 10)
61 61 self.assertEqual(a._notify_name, 'a')
62 62 self.assertEqual(a._notify_old, Undefined)
63 63 self.assertEqual(a._notify_new, 10)
64 64
65 65 def test_validate(self):
66 66 class MyTT(TraitType):
67 67 def validate(self, inst, value):
68 68 return -1
69 69 class A(HasTraitsStub):
70 70 tt = MyTT
71 71
72 72 a = A()
73 73 a.tt = 10
74 74 self.assertEqual(a.tt, -1)
75 75
76 76 def test_default_validate(self):
77 77 class MyIntTT(TraitType):
78 78 def validate(self, obj, value):
79 79 if isinstance(value, int):
80 80 return value
81 81 self.error(obj, value)
82 82 class A(HasTraits):
83 83 tt = MyIntTT(10)
84 84 a = A()
85 85 self.assertEqual(a.tt, 10)
86 86
87 87 # Defaults are validated when the HasTraits is instantiated
88 88 class B(HasTraits):
89 89 tt = MyIntTT('bad default')
90 90 self.assertRaises(TraitError, B)
91 91
92 92 def test_is_valid_for(self):
93 93 class MyTT(TraitType):
94 94 def is_valid_for(self, value):
95 95 return True
96 96 class A(HasTraits):
97 97 tt = MyTT
98 98
99 99 a = A()
100 100 a.tt = 10
101 101 self.assertEqual(a.tt, 10)
102 102
103 103 def test_value_for(self):
104 104 class MyTT(TraitType):
105 105 def value_for(self, value):
106 106 return 20
107 107 class A(HasTraits):
108 108 tt = MyTT
109 109
110 110 a = A()
111 111 a.tt = 10
112 112 self.assertEqual(a.tt, 20)
113 113
114 114 def test_info(self):
115 115 class A(HasTraits):
116 116 tt = TraitType
117 117 a = A()
118 118 self.assertEqual(A.tt.info(), 'any value')
119 119
120 120 def test_error(self):
121 121 class A(HasTraits):
122 122 tt = TraitType
123 123 a = A()
124 124 self.assertRaises(TraitError, A.tt.error, a, 10)
125 125
126 126 def test_dynamic_initializer(self):
127 127 class A(HasTraits):
128 128 x = Int(10)
129 129 def _x_default(self):
130 130 return 11
131 131 class B(A):
132 132 x = Int(20)
133 133 class C(A):
134 134 def _x_default(self):
135 135 return 21
136 136
137 137 a = A()
138 138 self.assertEqual(a._trait_values, {})
139 139 self.assertEqual(list(a._trait_dyn_inits.keys()), ['x'])
140 140 self.assertEqual(a.x, 11)
141 141 self.assertEqual(a._trait_values, {'x': 11})
142 142 b = B()
143 143 self.assertEqual(b._trait_values, {'x': 20})
144 144 self.assertEqual(list(a._trait_dyn_inits.keys()), ['x'])
145 145 self.assertEqual(b.x, 20)
146 146 c = C()
147 147 self.assertEqual(c._trait_values, {})
148 148 self.assertEqual(list(a._trait_dyn_inits.keys()), ['x'])
149 149 self.assertEqual(c.x, 21)
150 150 self.assertEqual(c._trait_values, {'x': 21})
151 151 # Ensure that the base class remains unmolested when the _default
152 152 # initializer gets overridden in a subclass.
153 153 a = A()
154 154 c = C()
155 155 self.assertEqual(a._trait_values, {})
156 156 self.assertEqual(list(a._trait_dyn_inits.keys()), ['x'])
157 157 self.assertEqual(a.x, 11)
158 158 self.assertEqual(a._trait_values, {'x': 11})
159 159
160 160
161 161
162 162 class TestHasTraitsMeta(TestCase):
163 163
164 164 def test_metaclass(self):
165 165 self.assertEqual(type(HasTraits), MetaHasTraits)
166 166
167 167 class A(HasTraits):
168 168 a = Int
169 169
170 170 a = A()
171 171 self.assertEqual(type(a.__class__), MetaHasTraits)
172 172 self.assertEqual(a.a,0)
173 173 a.a = 10
174 174 self.assertEqual(a.a,10)
175 175
176 176 class B(HasTraits):
177 177 b = Int()
178 178
179 179 b = B()
180 180 self.assertEqual(b.b,0)
181 181 b.b = 10
182 182 self.assertEqual(b.b,10)
183 183
184 184 class C(HasTraits):
185 185 c = Int(30)
186 186
187 187 c = C()
188 188 self.assertEqual(c.c,30)
189 189 c.c = 10
190 190 self.assertEqual(c.c,10)
191 191
192 192 def test_this_class(self):
193 193 class A(HasTraits):
194 194 t = This()
195 195 tt = This()
196 196 class B(A):
197 197 tt = This()
198 198 ttt = This()
199 199 self.assertEqual(A.t.this_class, A)
200 200 self.assertEqual(B.t.this_class, A)
201 201 self.assertEqual(B.tt.this_class, B)
202 202 self.assertEqual(B.ttt.this_class, B)
203 203
204 204 class TestHasTraitsNotify(TestCase):
205 205
206 206 def setUp(self):
207 207 self._notify1 = []
208 208 self._notify2 = []
209 209
210 210 def notify1(self, name, old, new):
211 211 self._notify1.append((name, old, new))
212 212
213 213 def notify2(self, name, old, new):
214 214 self._notify2.append((name, old, new))
215 215
216 216 def test_notify_all(self):
217 217
218 218 class A(HasTraits):
219 219 a = Int
220 220 b = Float
221 221
222 222 a = A()
223 223 a.on_trait_change(self.notify1)
224 224 a.a = 0
225 225 self.assertEqual(len(self._notify1),0)
226 226 a.b = 0.0
227 227 self.assertEqual(len(self._notify1),0)
228 228 a.a = 10
229 229 self.assertTrue(('a',0,10) in self._notify1)
230 230 a.b = 10.0
231 231 self.assertTrue(('b',0.0,10.0) in self._notify1)
232 232 self.assertRaises(TraitError,setattr,a,'a','bad string')
233 233 self.assertRaises(TraitError,setattr,a,'b','bad string')
234 234 self._notify1 = []
235 235 a.on_trait_change(self.notify1,remove=True)
236 236 a.a = 20
237 237 a.b = 20.0
238 238 self.assertEqual(len(self._notify1),0)
239 239
240 240 def test_notify_one(self):
241 241
242 242 class A(HasTraits):
243 243 a = Int
244 244 b = Float
245 245
246 246 a = A()
247 247 a.on_trait_change(self.notify1, 'a')
248 248 a.a = 0
249 249 self.assertEqual(len(self._notify1),0)
250 250 a.a = 10
251 251 self.assertTrue(('a',0,10) in self._notify1)
252 252 self.assertRaises(TraitError,setattr,a,'a','bad string')
253 253
254 254 def test_subclass(self):
255 255
256 256 class A(HasTraits):
257 257 a = Int
258 258
259 259 class B(A):
260 260 b = Float
261 261
262 262 b = B()
263 263 self.assertEqual(b.a,0)
264 264 self.assertEqual(b.b,0.0)
265 265 b.a = 100
266 266 b.b = 100.0
267 267 self.assertEqual(b.a,100)
268 268 self.assertEqual(b.b,100.0)
269 269
270 270 def test_notify_subclass(self):
271 271
272 272 class A(HasTraits):
273 273 a = Int
274 274
275 275 class B(A):
276 276 b = Float
277 277
278 278 b = B()
279 279 b.on_trait_change(self.notify1, 'a')
280 280 b.on_trait_change(self.notify2, 'b')
281 281 b.a = 0
282 282 b.b = 0.0
283 283 self.assertEqual(len(self._notify1),0)
284 284 self.assertEqual(len(self._notify2),0)
285 285 b.a = 10
286 286 b.b = 10.0
287 287 self.assertTrue(('a',0,10) in self._notify1)
288 288 self.assertTrue(('b',0.0,10.0) in self._notify2)
289 289
290 290 def test_static_notify(self):
291 291
292 292 class A(HasTraits):
293 293 a = Int
294 294 _notify1 = []
295 295 def _a_changed(self, name, old, new):
296 296 self._notify1.append((name, old, new))
297 297
298 298 a = A()
299 299 a.a = 0
300 300 # This is broken!!!
301 301 self.assertEqual(len(a._notify1),0)
302 302 a.a = 10
303 303 self.assertTrue(('a',0,10) in a._notify1)
304 304
305 305 class B(A):
306 306 b = Float
307 307 _notify2 = []
308 308 def _b_changed(self, name, old, new):
309 309 self._notify2.append((name, old, new))
310 310
311 311 b = B()
312 312 b.a = 10
313 313 b.b = 10.0
314 314 self.assertTrue(('a',0,10) in b._notify1)
315 315 self.assertTrue(('b',0.0,10.0) in b._notify2)
316 316
317 317 def test_notify_args(self):
318 318
319 319 def callback0():
320 320 self.cb = ()
321 321 def callback1(name):
322 322 self.cb = (name,)
323 323 def callback2(name, new):
324 324 self.cb = (name, new)
325 325 def callback3(name, old, new):
326 326 self.cb = (name, old, new)
327 327
328 328 class A(HasTraits):
329 329 a = Int
330 330
331 331 a = A()
332 332 a.on_trait_change(callback0, 'a')
333 333 a.a = 10
334 334 self.assertEqual(self.cb,())
335 335 a.on_trait_change(callback0, 'a', remove=True)
336 336
337 337 a.on_trait_change(callback1, 'a')
338 338 a.a = 100
339 339 self.assertEqual(self.cb,('a',))
340 340 a.on_trait_change(callback1, 'a', remove=True)
341 341
342 342 a.on_trait_change(callback2, 'a')
343 343 a.a = 1000
344 344 self.assertEqual(self.cb,('a',1000))
345 345 a.on_trait_change(callback2, 'a', remove=True)
346 346
347 347 a.on_trait_change(callback3, 'a')
348 348 a.a = 10000
349 349 self.assertEqual(self.cb,('a',1000,10000))
350 350 a.on_trait_change(callback3, 'a', remove=True)
351 351
352 352 self.assertEqual(len(a._trait_notifiers['a']),0)
353 353
354 354 def test_notify_only_once(self):
355 355
356 356 class A(HasTraits):
357 357 listen_to = ['a']
358 358
359 359 a = Int(0)
360 360 b = 0
361 361
362 362 def __init__(self, **kwargs):
363 363 super(A, self).__init__(**kwargs)
364 364 self.on_trait_change(self.listener1, ['a'])
365 365
366 366 def listener1(self, name, old, new):
367 367 self.b += 1
368 368
369 369 class B(A):
370 370
371 371 c = 0
372 372 d = 0
373 373
374 374 def __init__(self, **kwargs):
375 375 super(B, self).__init__(**kwargs)
376 376 self.on_trait_change(self.listener2)
377 377
378 378 def listener2(self, name, old, new):
379 379 self.c += 1
380 380
381 381 def _a_changed(self, name, old, new):
382 382 self.d += 1
383 383
384 384 b = B()
385 385 b.a += 1
386 386 self.assertEqual(b.b, b.c)
387 387 self.assertEqual(b.b, b.d)
388 388 b.a += 1
389 389 self.assertEqual(b.b, b.c)
390 390 self.assertEqual(b.b, b.d)
391 391
392 392
393 393 class TestHasTraits(TestCase):
394 394
395 395 def test_trait_names(self):
396 396 class A(HasTraits):
397 397 i = Int
398 398 f = Float
399 399 a = A()
400 400 self.assertEqual(sorted(a.trait_names()),['f','i'])
401 401 self.assertEqual(sorted(A.class_trait_names()),['f','i'])
402 402
403 403 def test_trait_metadata(self):
404 404 class A(HasTraits):
405 405 i = Int(config_key='MY_VALUE')
406 406 a = A()
407 407 self.assertEqual(a.trait_metadata('i','config_key'), 'MY_VALUE')
408 408
409 409 def test_trait_metadata_default(self):
410 410 class A(HasTraits):
411 411 i = Int()
412 412 a = A()
413 413 self.assertEqual(a.trait_metadata('i', 'config_key'), None)
414 414 self.assertEqual(a.trait_metadata('i', 'config_key', 'default'), 'default')
415 415
416 416 def test_traits(self):
417 417 class A(HasTraits):
418 418 i = Int
419 419 f = Float
420 420 a = A()
421 421 self.assertEqual(a.traits(), dict(i=A.i, f=A.f))
422 422 self.assertEqual(A.class_traits(), dict(i=A.i, f=A.f))
423 423
424 424 def test_traits_metadata(self):
425 425 class A(HasTraits):
426 426 i = Int(config_key='VALUE1', other_thing='VALUE2')
427 427 f = Float(config_key='VALUE3', other_thing='VALUE2')
428 428 j = Int(0)
429 429 a = A()
430 430 self.assertEqual(a.traits(), dict(i=A.i, f=A.f, j=A.j))
431 431 traits = a.traits(config_key='VALUE1', other_thing='VALUE2')
432 432 self.assertEqual(traits, dict(i=A.i))
433 433
434 434 # This passes, but it shouldn't because I am replicating a bug in
435 435 # traits.
436 436 traits = a.traits(config_key=lambda v: True)
437 437 self.assertEqual(traits, dict(i=A.i, f=A.f, j=A.j))
438 438
439 439 def test_init(self):
440 440 class A(HasTraits):
441 441 i = Int()
442 442 x = Float()
443 443 a = A(i=1, x=10.0)
444 444 self.assertEqual(a.i, 1)
445 445 self.assertEqual(a.x, 10.0)
446 446
447 447 def test_positional_args(self):
448 448 class A(HasTraits):
449 449 i = Int(0)
450 450 def __init__(self, i):
451 451 super(A, self).__init__()
452 452 self.i = i
453 453
454 454 a = A(5)
455 455 self.assertEqual(a.i, 5)
456 456 # should raise TypeError if no positional arg given
457 457 self.assertRaises(TypeError, A)
458 458
459 459 #-----------------------------------------------------------------------------
460 460 # Tests for specific trait types
461 461 #-----------------------------------------------------------------------------
462 462
463 463
464 464 class TestType(TestCase):
465 465
466 466 def test_default(self):
467 467
468 468 class B(object): pass
469 469 class A(HasTraits):
470 470 klass = Type
471 471
472 472 a = A()
473 473 self.assertEqual(a.klass, None)
474 474
475 475 a.klass = B
476 476 self.assertEqual(a.klass, B)
477 477 self.assertRaises(TraitError, setattr, a, 'klass', 10)
478 478
479 479 def test_value(self):
480 480
481 481 class B(object): pass
482 482 class C(object): pass
483 483 class A(HasTraits):
484 484 klass = Type(B)
485 485
486 486 a = A()
487 487 self.assertEqual(a.klass, B)
488 488 self.assertRaises(TraitError, setattr, a, 'klass', C)
489 489 self.assertRaises(TraitError, setattr, a, 'klass', object)
490 490 a.klass = B
491 491
492 492 def test_allow_none(self):
493 493
494 494 class B(object): pass
495 495 class C(B): pass
496 496 class A(HasTraits):
497 497 klass = Type(B, allow_none=False)
498 498
499 499 a = A()
500 500 self.assertEqual(a.klass, B)
501 501 self.assertRaises(TraitError, setattr, a, 'klass', None)
502 502 a.klass = C
503 503 self.assertEqual(a.klass, C)
504 504
505 505 def test_validate_klass(self):
506 506
507 507 class A(HasTraits):
508 508 klass = Type('no strings allowed')
509 509
510 510 self.assertRaises(ImportError, A)
511 511
512 512 class A(HasTraits):
513 513 klass = Type('rub.adub.Duck')
514 514
515 515 self.assertRaises(ImportError, A)
516 516
517 517 def test_validate_default(self):
518 518
519 519 class B(object): pass
520 520 class A(HasTraits):
521 521 klass = Type('bad default', B)
522 522
523 523 self.assertRaises(ImportError, A)
524 524
525 525 class C(HasTraits):
526 526 klass = Type(None, B, allow_none=False)
527 527
528 528 self.assertRaises(TraitError, C)
529 529
530 530 def test_str_klass(self):
531 531
532 532 class A(HasTraits):
533 533 klass = Type('IPython.utils.ipstruct.Struct')
534 534
535 535 from IPython.utils.ipstruct import Struct
536 536 a = A()
537 537 a.klass = Struct
538 538 self.assertEqual(a.klass, Struct)
539 539
540 540 self.assertRaises(TraitError, setattr, a, 'klass', 10)
541 541
542 542 def test_set_str_klass(self):
543 543
544 544 class A(HasTraits):
545 545 klass = Type()
546 546
547 547 a = A(klass='IPython.utils.ipstruct.Struct')
548 548 from IPython.utils.ipstruct import Struct
549 549 self.assertEqual(a.klass, Struct)
550 550
551 551 class TestInstance(TestCase):
552 552
553 553 def test_basic(self):
554 554 class Foo(object): pass
555 555 class Bar(Foo): pass
556 556 class Bah(object): pass
557 557
558 558 class A(HasTraits):
559 559 inst = Instance(Foo)
560 560
561 561 a = A()
562 562 self.assertTrue(a.inst is None)
563 563 a.inst = Foo()
564 564 self.assertTrue(isinstance(a.inst, Foo))
565 565 a.inst = Bar()
566 566 self.assertTrue(isinstance(a.inst, Foo))
567 567 self.assertRaises(TraitError, setattr, a, 'inst', Foo)
568 568 self.assertRaises(TraitError, setattr, a, 'inst', Bar)
569 569 self.assertRaises(TraitError, setattr, a, 'inst', Bah())
570 570
571 571 def test_default_klass(self):
572 572 class Foo(object): pass
573 573 class Bar(Foo): pass
574 574 class Bah(object): pass
575 575
576 576 class FooInstance(Instance):
577 577 klass = Foo
578 578
579 579 class A(HasTraits):
580 580 inst = FooInstance()
581 581
582 582 a = A()
583 583 self.assertTrue(a.inst is None)
584 584 a.inst = Foo()
585 585 self.assertTrue(isinstance(a.inst, Foo))
586 586 a.inst = Bar()
587 587 self.assertTrue(isinstance(a.inst, Foo))
588 588 self.assertRaises(TraitError, setattr, a, 'inst', Foo)
589 589 self.assertRaises(TraitError, setattr, a, 'inst', Bar)
590 590 self.assertRaises(TraitError, setattr, a, 'inst', Bah())
591 591
592 592 def test_unique_default_value(self):
593 593 class Foo(object): pass
594 594 class A(HasTraits):
595 595 inst = Instance(Foo,(),{})
596 596
597 597 a = A()
598 598 b = A()
599 599 self.assertTrue(a.inst is not b.inst)
600 600
601 601 def test_args_kw(self):
602 602 class Foo(object):
603 603 def __init__(self, c): self.c = c
604 604 class Bar(object): pass
605 605 class Bah(object):
606 606 def __init__(self, c, d):
607 607 self.c = c; self.d = d
608 608
609 609 class A(HasTraits):
610 610 inst = Instance(Foo, (10,))
611 611 a = A()
612 612 self.assertEqual(a.inst.c, 10)
613 613
614 614 class B(HasTraits):
615 615 inst = Instance(Bah, args=(10,), kw=dict(d=20))
616 616 b = B()
617 617 self.assertEqual(b.inst.c, 10)
618 618 self.assertEqual(b.inst.d, 20)
619 619
620 620 class C(HasTraits):
621 621 inst = Instance(Foo)
622 622 c = C()
623 623 self.assertTrue(c.inst is None)
624 624
625 625 def test_bad_default(self):
626 626 class Foo(object): pass
627 627
628 628 class A(HasTraits):
629 629 inst = Instance(Foo, allow_none=False)
630 630
631 631 self.assertRaises(TraitError, A)
632 632
633 633 def test_instance(self):
634 634 class Foo(object): pass
635 635
636 636 def inner():
637 637 class A(HasTraits):
638 638 inst = Instance(Foo())
639 639
640 640 self.assertRaises(TraitError, inner)
641 641
642 642
643 643 class TestThis(TestCase):
644 644
645 645 def test_this_class(self):
646 646 class Foo(HasTraits):
647 647 this = This
648 648
649 649 f = Foo()
650 650 self.assertEqual(f.this, None)
651 651 g = Foo()
652 652 f.this = g
653 653 self.assertEqual(f.this, g)
654 654 self.assertRaises(TraitError, setattr, f, 'this', 10)
655 655
656 656 def test_this_inst(self):
657 657 class Foo(HasTraits):
658 658 this = This()
659 659
660 660 f = Foo()
661 661 f.this = Foo()
662 662 self.assertTrue(isinstance(f.this, Foo))
663 663
664 664 def test_subclass(self):
665 665 class Foo(HasTraits):
666 666 t = This()
667 667 class Bar(Foo):
668 668 pass
669 669 f = Foo()
670 670 b = Bar()
671 671 f.t = b
672 672 b.t = f
673 673 self.assertEqual(f.t, b)
674 674 self.assertEqual(b.t, f)
675 675
676 676 def test_subclass_override(self):
677 677 class Foo(HasTraits):
678 678 t = This()
679 679 class Bar(Foo):
680 680 t = This()
681 681 f = Foo()
682 682 b = Bar()
683 683 f.t = b
684 684 self.assertEqual(f.t, b)
685 685 self.assertRaises(TraitError, setattr, b, 't', f)
686 686
687 def test_this_in_container(self):
688
689 class Tree(HasTraits):
690 value = Unicode()
691 leaves = List(This())
692
693 tree = Tree(
694 value='foo',
695 leaves=[Tree('bar'), Tree('buzz')]
696 )
697
698 with self.assertRaises(TraitError):
699 tree.leaves = [1, 2]
700
687 701 class TraitTestBase(TestCase):
688 702 """A best testing class for basic trait types."""
689 703
690 704 def assign(self, value):
691 705 self.obj.value = value
692 706
693 707 def coerce(self, value):
694 708 return value
695 709
696 710 def test_good_values(self):
697 711 if hasattr(self, '_good_values'):
698 712 for value in self._good_values:
699 713 self.assign(value)
700 714 self.assertEqual(self.obj.value, self.coerce(value))
701 715
702 716 def test_bad_values(self):
703 717 if hasattr(self, '_bad_values'):
704 718 for value in self._bad_values:
705 719 try:
706 720 self.assertRaises(TraitError, self.assign, value)
707 721 except AssertionError:
708 722 assert False, value
709 723
710 724 def test_default_value(self):
711 725 if hasattr(self, '_default_value'):
712 726 self.assertEqual(self._default_value, self.obj.value)
713 727
714 728 def test_allow_none(self):
715 729 if (hasattr(self, '_bad_values') and hasattr(self, '_good_values') and
716 730 None in self._bad_values):
717 731 trait=self.obj.traits()['value']
718 732 try:
719 733 trait.allow_none = True
720 734 self._bad_values.remove(None)
721 735 #skip coerce. Allow None casts None to None.
722 736 self.assign(None)
723 737 self.assertEqual(self.obj.value,None)
724 738 self.test_good_values()
725 739 self.test_bad_values()
726 740 finally:
727 741 #tear down
728 742 trait.allow_none = False
729 743 self._bad_values.append(None)
730 744
731 745 def tearDown(self):
732 746 # restore default value after tests, if set
733 747 if hasattr(self, '_default_value'):
734 748 self.obj.value = self._default_value
735 749
736 750
737 751 class AnyTrait(HasTraits):
738 752
739 753 value = Any
740 754
741 755 class AnyTraitTest(TraitTestBase):
742 756
743 757 obj = AnyTrait()
744 758
745 759 _default_value = None
746 760 _good_values = [10.0, 'ten', u'ten', [10], {'ten': 10},(10,), None, 1j]
747 761 _bad_values = []
748 762
749 763
750 764 class IntTrait(HasTraits):
751 765
752 766 value = Int(99)
753 767
754 768 class TestInt(TraitTestBase):
755 769
756 770 obj = IntTrait()
757 771 _default_value = 99
758 772 _good_values = [10, -10]
759 773 _bad_values = ['ten', u'ten', [10], {'ten': 10},(10,), None, 1j,
760 774 10.1, -10.1, '10L', '-10L', '10.1', '-10.1', u'10L',
761 775 u'-10L', u'10.1', u'-10.1', '10', '-10', u'10', u'-10']
762 776 if not py3compat.PY3:
763 777 _bad_values.extend([long(10), long(-10), 10*sys.maxint, -10*sys.maxint])
764 778
765 779
766 780 class LongTrait(HasTraits):
767 781
768 782 value = Long(99 if py3compat.PY3 else long(99))
769 783
770 784 class TestLong(TraitTestBase):
771 785
772 786 obj = LongTrait()
773 787
774 788 _default_value = 99 if py3compat.PY3 else long(99)
775 789 _good_values = [10, -10]
776 790 _bad_values = ['ten', u'ten', [10], {'ten': 10},(10,),
777 791 None, 1j, 10.1, -10.1, '10', '-10', '10L', '-10L', '10.1',
778 792 '-10.1', u'10', u'-10', u'10L', u'-10L', u'10.1',
779 793 u'-10.1']
780 794 if not py3compat.PY3:
781 795 # maxint undefined on py3, because int == long
782 796 _good_values.extend([long(10), long(-10), 10*sys.maxint, -10*sys.maxint])
783 797 _bad_values.extend([[long(10)], (long(10),)])
784 798
785 799 @skipif(py3compat.PY3, "not relevant on py3")
786 800 def test_cast_small(self):
787 801 """Long casts ints to long"""
788 802 self.obj.value = 10
789 803 self.assertEqual(type(self.obj.value), long)
790 804
791 805
792 806 class IntegerTrait(HasTraits):
793 807 value = Integer(1)
794 808
795 809 class TestInteger(TestLong):
796 810 obj = IntegerTrait()
797 811 _default_value = 1
798 812
799 813 def coerce(self, n):
800 814 return int(n)
801 815
802 816 @skipif(py3compat.PY3, "not relevant on py3")
803 817 def test_cast_small(self):
804 818 """Integer casts small longs to int"""
805 819 if py3compat.PY3:
806 820 raise SkipTest("not relevant on py3")
807 821
808 822 self.obj.value = long(100)
809 823 self.assertEqual(type(self.obj.value), int)
810 824
811 825
812 826 class FloatTrait(HasTraits):
813 827
814 828 value = Float(99.0)
815 829
816 830 class TestFloat(TraitTestBase):
817 831
818 832 obj = FloatTrait()
819 833
820 834 _default_value = 99.0
821 835 _good_values = [10, -10, 10.1, -10.1]
822 836 _bad_values = ['ten', u'ten', [10], {'ten': 10},(10,), None,
823 837 1j, '10', '-10', '10L', '-10L', '10.1', '-10.1', u'10',
824 838 u'-10', u'10L', u'-10L', u'10.1', u'-10.1']
825 839 if not py3compat.PY3:
826 840 _bad_values.extend([long(10), long(-10)])
827 841
828 842
829 843 class ComplexTrait(HasTraits):
830 844
831 845 value = Complex(99.0-99.0j)
832 846
833 847 class TestComplex(TraitTestBase):
834 848
835 849 obj = ComplexTrait()
836 850
837 851 _default_value = 99.0-99.0j
838 852 _good_values = [10, -10, 10.1, -10.1, 10j, 10+10j, 10-10j,
839 853 10.1j, 10.1+10.1j, 10.1-10.1j]
840 854 _bad_values = [u'10L', u'-10L', 'ten', [10], {'ten': 10},(10,), None]
841 855 if not py3compat.PY3:
842 856 _bad_values.extend([long(10), long(-10)])
843 857
844 858
845 859 class BytesTrait(HasTraits):
846 860
847 861 value = Bytes(b'string')
848 862
849 863 class TestBytes(TraitTestBase):
850 864
851 865 obj = BytesTrait()
852 866
853 867 _default_value = b'string'
854 868 _good_values = [b'10', b'-10', b'10L',
855 869 b'-10L', b'10.1', b'-10.1', b'string']
856 870 _bad_values = [10, -10, 10.1, -10.1, 1j, [10],
857 871 ['ten'],{'ten': 10},(10,), None, u'string']
858 872 if not py3compat.PY3:
859 873 _bad_values.extend([long(10), long(-10)])
860 874
861 875
862 876 class UnicodeTrait(HasTraits):
863 877
864 878 value = Unicode(u'unicode')
865 879
866 880 class TestUnicode(TraitTestBase):
867 881
868 882 obj = UnicodeTrait()
869 883
870 884 _default_value = u'unicode'
871 885 _good_values = ['10', '-10', '10L', '-10L', '10.1',
872 886 '-10.1', '', u'', 'string', u'string', u"€"]
873 887 _bad_values = [10, -10, 10.1, -10.1, 1j,
874 888 [10], ['ten'], [u'ten'], {'ten': 10},(10,), None]
875 889 if not py3compat.PY3:
876 890 _bad_values.extend([long(10), long(-10)])
877 891
878 892
879 893 class ObjectNameTrait(HasTraits):
880 894 value = ObjectName("abc")
881 895
882 896 class TestObjectName(TraitTestBase):
883 897 obj = ObjectNameTrait()
884 898
885 899 _default_value = "abc"
886 900 _good_values = ["a", "gh", "g9", "g_", "_G", u"a345_"]
887 901 _bad_values = [1, "", u"€", "9g", "!", "#abc", "aj@", "a.b", "a()", "a[0]",
888 902 None, object(), object]
889 903 if sys.version_info[0] < 3:
890 904 _bad_values.append(u"ΓΎ")
891 905 else:
892 906 _good_values.append(u"ΓΎ") # ΓΎ=1 is valid in Python 3 (PEP 3131).
893 907
894 908
895 909 class DottedObjectNameTrait(HasTraits):
896 910 value = DottedObjectName("a.b")
897 911
898 912 class TestDottedObjectName(TraitTestBase):
899 913 obj = DottedObjectNameTrait()
900 914
901 915 _default_value = "a.b"
902 916 _good_values = ["A", "y.t", "y765.__repr__", "os.path.join", u"os.path.join"]
903 917 _bad_values = [1, u"abc.€", "_.@", ".", ".abc", "abc.", ".abc.", None]
904 918 if sys.version_info[0] < 3:
905 919 _bad_values.append(u"t.ΓΎ")
906 920 else:
907 921 _good_values.append(u"t.ΓΎ")
908 922
909 923
910 924 class TCPAddressTrait(HasTraits):
911 925
912 926 value = TCPAddress()
913 927
914 928 class TestTCPAddress(TraitTestBase):
915 929
916 930 obj = TCPAddressTrait()
917 931
918 932 _default_value = ('127.0.0.1',0)
919 933 _good_values = [('localhost',0),('192.168.0.1',1000),('www.google.com',80)]
920 934 _bad_values = [(0,0),('localhost',10.0),('localhost',-1), None]
921 935
922 936 class ListTrait(HasTraits):
923 937
924 938 value = List(Int)
925 939
926 940 class TestList(TraitTestBase):
927 941
928 942 obj = ListTrait()
929 943
930 944 _default_value = []
931 945 _good_values = [[], [1], list(range(10)), (1,2)]
932 946 _bad_values = [10, [1,'a'], 'a']
933 947
934 948 def coerce(self, value):
935 949 if value is not None:
936 950 value = list(value)
937 951 return value
938 952
939 953 class Foo(object):
940 954 pass
941 955
942 956 class InstanceListTrait(HasTraits):
943 957
944 958 value = List(Instance(__name__+'.Foo'))
945 959
946 960 class TestInstanceList(TraitTestBase):
947 961
948 962 obj = InstanceListTrait()
949 963
950 964 def test_klass(self):
951 965 """Test that the instance klass is properly assigned."""
952 966 self.assertIs(self.obj.traits()['value']._trait.klass, Foo)
953 967
954 968 _default_value = []
955 969 _good_values = [[Foo(), Foo(), None], None]
956 970 _bad_values = [['1', 2,], '1', [Foo]]
957 971
958 972 class LenListTrait(HasTraits):
959 973
960 974 value = List(Int, [0], minlen=1, maxlen=2)
961 975
962 976 class TestLenList(TraitTestBase):
963 977
964 978 obj = LenListTrait()
965 979
966 980 _default_value = [0]
967 981 _good_values = [[1], [1,2], (1,2)]
968 982 _bad_values = [10, [1,'a'], 'a', [], list(range(3))]
969 983
970 984 def coerce(self, value):
971 985 if value is not None:
972 986 value = list(value)
973 987 return value
974 988
975 989 class TupleTrait(HasTraits):
976 990
977 991 value = Tuple(Int(allow_none=True))
978 992
979 993 class TestTupleTrait(TraitTestBase):
980 994
981 995 obj = TupleTrait()
982 996
983 997 _default_value = None
984 998 _good_values = [(1,), None, (0,), [1], (None,)]
985 999 _bad_values = [10, (1,2), ('a'), ()]
986 1000
987 1001 def coerce(self, value):
988 1002 if value is not None:
989 1003 value = tuple(value)
990 1004 return value
991 1005
992 1006 def test_invalid_args(self):
993 1007 self.assertRaises(TypeError, Tuple, 5)
994 1008 self.assertRaises(TypeError, Tuple, default_value='hello')
995 1009 t = Tuple(Int, CBytes, default_value=(1,5))
996 1010
997 1011 class LooseTupleTrait(HasTraits):
998 1012
999 1013 value = Tuple((1,2,3))
1000 1014
1001 1015 class TestLooseTupleTrait(TraitTestBase):
1002 1016
1003 1017 obj = LooseTupleTrait()
1004 1018
1005 1019 _default_value = (1,2,3)
1006 1020 _good_values = [(1,), None, [1], (0,), tuple(range(5)), tuple('hello'), ('a',5), ()]
1007 1021 _bad_values = [10, 'hello', {}]
1008 1022
1009 1023 def coerce(self, value):
1010 1024 if value is not None:
1011 1025 value = tuple(value)
1012 1026 return value
1013 1027
1014 1028 def test_invalid_args(self):
1015 1029 self.assertRaises(TypeError, Tuple, 5)
1016 1030 self.assertRaises(TypeError, Tuple, default_value='hello')
1017 1031 t = Tuple(Int, CBytes, default_value=(1,5))
1018 1032
1019 1033
1020 1034 class MultiTupleTrait(HasTraits):
1021 1035
1022 1036 value = Tuple(Int, Bytes, default_value=[99,b'bottles'])
1023 1037
1024 1038 class TestMultiTuple(TraitTestBase):
1025 1039
1026 1040 obj = MultiTupleTrait()
1027 1041
1028 1042 _default_value = (99,b'bottles')
1029 1043 _good_values = [(1,b'a'), (2,b'b')]
1030 1044 _bad_values = ((),10, b'a', (1,b'a',3), (b'a',1), (1, u'a'))
1031 1045
1032 1046 class CRegExpTrait(HasTraits):
1033 1047
1034 1048 value = CRegExp(r'')
1035 1049
1036 1050 class TestCRegExp(TraitTestBase):
1037 1051
1038 1052 def coerce(self, value):
1039 1053 return re.compile(value)
1040 1054
1041 1055 obj = CRegExpTrait()
1042 1056
1043 1057 _default_value = re.compile(r'')
1044 1058 _good_values = [r'\d+', re.compile(r'\d+')]
1045 1059 _bad_values = ['(', None, ()]
1046 1060
1047 1061 class DictTrait(HasTraits):
1048 1062 value = Dict()
1049 1063
1050 1064 def test_dict_assignment():
1051 1065 d = dict()
1052 1066 c = DictTrait()
1053 1067 c.value = d
1054 1068 d['a'] = 5
1055 1069 nt.assert_equal(d, c.value)
1056 1070 nt.assert_true(c.value is d)
1057 1071
1058 1072 class TestLink(TestCase):
1059 1073 def test_connect_same(self):
1060 1074 """Verify two traitlets of the same type can be linked together using link."""
1061 1075
1062 1076 # Create two simple classes with Int traitlets.
1063 1077 class A(HasTraits):
1064 1078 value = Int()
1065 1079 a = A(value=9)
1066 1080 b = A(value=8)
1067 1081
1068 1082 # Conenct the two classes.
1069 1083 c = link((a, 'value'), (b, 'value'))
1070 1084
1071 1085 # Make sure the values are the same at the point of linking.
1072 1086 self.assertEqual(a.value, b.value)
1073 1087
1074 1088 # Change one of the values to make sure they stay in sync.
1075 1089 a.value = 5
1076 1090 self.assertEqual(a.value, b.value)
1077 1091 b.value = 6
1078 1092 self.assertEqual(a.value, b.value)
1079 1093
1080 1094 def test_link_different(self):
1081 1095 """Verify two traitlets of different types can be linked together using link."""
1082 1096
1083 1097 # Create two simple classes with Int traitlets.
1084 1098 class A(HasTraits):
1085 1099 value = Int()
1086 1100 class B(HasTraits):
1087 1101 count = Int()
1088 1102 a = A(value=9)
1089 1103 b = B(count=8)
1090 1104
1091 1105 # Conenct the two classes.
1092 1106 c = link((a, 'value'), (b, 'count'))
1093 1107
1094 1108 # Make sure the values are the same at the point of linking.
1095 1109 self.assertEqual(a.value, b.count)
1096 1110
1097 1111 # Change one of the values to make sure they stay in sync.
1098 1112 a.value = 5
1099 1113 self.assertEqual(a.value, b.count)
1100 1114 b.count = 4
1101 1115 self.assertEqual(a.value, b.count)
1102 1116
1103 1117 def test_unlink(self):
1104 1118 """Verify two linked traitlets can be unlinked."""
1105 1119
1106 1120 # Create two simple classes with Int traitlets.
1107 1121 class A(HasTraits):
1108 1122 value = Int()
1109 1123 a = A(value=9)
1110 1124 b = A(value=8)
1111 1125
1112 1126 # Connect the two classes.
1113 1127 c = link((a, 'value'), (b, 'value'))
1114 1128 a.value = 4
1115 1129 c.unlink()
1116 1130
1117 1131 # Change one of the values to make sure they don't stay in sync.
1118 1132 a.value = 5
1119 1133 self.assertNotEqual(a.value, b.value)
1120 1134
1121 1135 def test_callbacks(self):
1122 1136 """Verify two linked traitlets have their callbacks called once."""
1123 1137
1124 1138 # Create two simple classes with Int traitlets.
1125 1139 class A(HasTraits):
1126 1140 value = Int()
1127 1141 class B(HasTraits):
1128 1142 count = Int()
1129 1143 a = A(value=9)
1130 1144 b = B(count=8)
1131 1145
1132 1146 # Register callbacks that count.
1133 1147 callback_count = []
1134 1148 def a_callback(name, old, new):
1135 1149 callback_count.append('a')
1136 1150 a.on_trait_change(a_callback, 'value')
1137 1151 def b_callback(name, old, new):
1138 1152 callback_count.append('b')
1139 1153 b.on_trait_change(b_callback, 'count')
1140 1154
1141 1155 # Connect the two classes.
1142 1156 c = link((a, 'value'), (b, 'count'))
1143 1157
1144 1158 # Make sure b's count was set to a's value once.
1145 1159 self.assertEqual(''.join(callback_count), 'b')
1146 1160 del callback_count[:]
1147 1161
1148 1162 # Make sure a's value was set to b's count once.
1149 1163 b.count = 5
1150 1164 self.assertEqual(''.join(callback_count), 'ba')
1151 1165 del callback_count[:]
1152 1166
1153 1167 # Make sure b's count was set to a's value once.
1154 1168 a.value = 4
1155 1169 self.assertEqual(''.join(callback_count), 'ab')
1156 1170 del callback_count[:]
1157 1171
1158 1172 class TestDirectionalLink(TestCase):
1159 1173 def test_connect_same(self):
1160 1174 """Verify two traitlets of the same type can be linked together using directional_link."""
1161 1175
1162 1176 # Create two simple classes with Int traitlets.
1163 1177 class A(HasTraits):
1164 1178 value = Int()
1165 1179 a = A(value=9)
1166 1180 b = A(value=8)
1167 1181
1168 1182 # Conenct the two classes.
1169 1183 c = directional_link((a, 'value'), (b, 'value'))
1170 1184
1171 1185 # Make sure the values are the same at the point of linking.
1172 1186 self.assertEqual(a.value, b.value)
1173 1187
1174 1188 # Change one the value of the source and check that it synchronizes the target.
1175 1189 a.value = 5
1176 1190 self.assertEqual(b.value, 5)
1177 1191 # Change one the value of the target and check that it has no impact on the source
1178 1192 b.value = 6
1179 1193 self.assertEqual(a.value, 5)
1180 1194
1181 1195 def test_link_different(self):
1182 1196 """Verify two traitlets of different types can be linked together using link."""
1183 1197
1184 1198 # Create two simple classes with Int traitlets.
1185 1199 class A(HasTraits):
1186 1200 value = Int()
1187 1201 class B(HasTraits):
1188 1202 count = Int()
1189 1203 a = A(value=9)
1190 1204 b = B(count=8)
1191 1205
1192 1206 # Conenct the two classes.
1193 1207 c = directional_link((a, 'value'), (b, 'count'))
1194 1208
1195 1209 # Make sure the values are the same at the point of linking.
1196 1210 self.assertEqual(a.value, b.count)
1197 1211
1198 1212 # Change one the value of the source and check that it synchronizes the target.
1199 1213 a.value = 5
1200 1214 self.assertEqual(b.count, 5)
1201 1215 # Change one the value of the target and check that it has no impact on the source
1202 1216 b.value = 6
1203 1217 self.assertEqual(a.value, 5)
1204 1218
1205 1219 def test_unlink(self):
1206 1220 """Verify two linked traitlets can be unlinked."""
1207 1221
1208 1222 # Create two simple classes with Int traitlets.
1209 1223 class A(HasTraits):
1210 1224 value = Int()
1211 1225 a = A(value=9)
1212 1226 b = A(value=8)
1213 1227
1214 1228 # Connect the two classes.
1215 1229 c = directional_link((a, 'value'), (b, 'value'))
1216 1230 a.value = 4
1217 1231 c.unlink()
1218 1232
1219 1233 # Change one of the values to make sure they don't stay in sync.
1220 1234 a.value = 5
1221 1235 self.assertNotEqual(a.value, b.value)
1222 1236
1223 1237 class Pickleable(HasTraits):
1224 1238 i = Int()
1225 1239 j = Int()
1226 1240
1227 1241 def _i_default(self):
1228 1242 return 1
1229 1243
1230 1244 def _i_changed(self, name, old, new):
1231 1245 self.j = new
1232 1246
1233 1247 def test_pickle_hastraits():
1234 1248 c = Pickleable()
1235 1249 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
1236 1250 p = pickle.dumps(c, protocol)
1237 1251 c2 = pickle.loads(p)
1238 1252 nt.assert_equal(c2.i, c.i)
1239 1253 nt.assert_equal(c2.j, c.j)
1240 1254
1241 1255 c.i = 5
1242 1256 for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
1243 1257 p = pickle.dumps(c, protocol)
1244 1258 c2 = pickle.loads(p)
1245 1259 nt.assert_equal(c2.i, c.i)
1246 1260 nt.assert_equal(c2.j, c.j)
1247 1261
1248 1262 class TestEventful(TestCase):
1249 1263
1250 1264 def test_list(self):
1251 1265 """Does the EventfulList work?"""
1252 1266 event_cache = []
1253 1267
1254 1268 class A(HasTraits):
1255 1269 x = EventfulList([c for c in 'abc'])
1256 1270 a = A()
1257 1271 a.x.on_events(lambda i, x: event_cache.append('insert'), \
1258 1272 lambda i, x: event_cache.append('set'), \
1259 1273 lambda i: event_cache.append('del'), \
1260 1274 lambda: event_cache.append('reverse'), \
1261 1275 lambda *p, **k: event_cache.append('sort'))
1262 1276
1263 1277 a.x.remove('c')
1264 1278 # ab
1265 1279 a.x.insert(0, 'z')
1266 1280 # zab
1267 1281 del a.x[1]
1268 1282 # zb
1269 1283 a.x.reverse()
1270 1284 # bz
1271 1285 a.x[1] = 'o'
1272 1286 # bo
1273 1287 a.x.append('a')
1274 1288 # boa
1275 1289 a.x.sort()
1276 1290 # abo
1277 1291
1278 1292 # Were the correct events captured?
1279 1293 self.assertEqual(event_cache, ['del', 'insert', 'del', 'reverse', 'set', 'set', 'sort'])
1280 1294
1281 1295 # Is the output correct?
1282 1296 self.assertEqual(a.x, [c for c in 'abo'])
1283 1297
1284 1298 def test_dict(self):
1285 1299 """Does the EventfulDict work?"""
1286 1300 event_cache = []
1287 1301
1288 1302 class A(HasTraits):
1289 1303 x = EventfulDict({c: c for c in 'abc'})
1290 1304 a = A()
1291 1305 a.x.on_events(lambda k, v: event_cache.append('add'), \
1292 1306 lambda k, v: event_cache.append('set'), \
1293 1307 lambda k: event_cache.append('del'))
1294 1308
1295 1309 del a.x['c']
1296 1310 # ab
1297 1311 a.x['z'] = 1
1298 1312 # abz
1299 1313 a.x['z'] = 'z'
1300 1314 # abz
1301 1315 a.x.pop('a')
1302 1316 # bz
1303 1317
1304 1318 # Were the correct events captured?
1305 1319 self.assertEqual(event_cache, ['del', 'add', 'set', 'del'])
1306 1320
1307 1321 # Is the output correct?
1308 1322 self.assertEqual(a.x, {c: c for c in 'bz'})
@@ -1,1622 +1,1624 b''
1 1 # encoding: utf-8
2 2 """
3 3 A lightweight Traits like module.
4 4
5 5 This is designed to provide a lightweight, simple, pure Python version of
6 6 many of the capabilities of enthought.traits. This includes:
7 7
8 8 * Validation
9 9 * Type specification with defaults
10 10 * Static and dynamic notification
11 11 * Basic predefined types
12 12 * An API that is similar to enthought.traits
13 13
14 14 We don't support:
15 15
16 16 * Delegation
17 17 * Automatic GUI generation
18 18 * A full set of trait types. Most importantly, we don't provide container
19 19 traits (list, dict, tuple) that can trigger notifications if their
20 20 contents change.
21 21 * API compatibility with enthought.traits
22 22
23 23 There are also some important difference in our design:
24 24
25 25 * enthought.traits does not validate default values. We do.
26 26
27 27 We choose to create this module because we need these capabilities, but
28 28 we need them to be pure Python so they work in all Python implementations,
29 29 including Jython and IronPython.
30 30
31 31 Inheritance diagram:
32 32
33 33 .. inheritance-diagram:: IPython.utils.traitlets
34 34 :parts: 3
35 35 """
36 36
37 37 # Copyright (c) IPython Development Team.
38 38 # Distributed under the terms of the Modified BSD License.
39 39 #
40 40 # Adapted from enthought.traits, Copyright (c) Enthought, Inc.,
41 41 # also under the terms of the Modified BSD License.
42 42
43 43 import contextlib
44 44 import inspect
45 45 import re
46 46 import sys
47 47 import types
48 48 from types import FunctionType
49 49 try:
50 50 from types import ClassType, InstanceType
51 51 ClassTypes = (ClassType, type)
52 52 except:
53 53 ClassTypes = (type,)
54 54
55 55 from .importstring import import_item
56 56 from IPython.utils import py3compat
57 57 from IPython.utils import eventful
58 58 from IPython.utils.py3compat import iteritems, string_types
59 59 from IPython.testing.skipdoctest import skip_doctest
60 60
61 61 SequenceTypes = (list, tuple, set, frozenset)
62 62
63 63 #-----------------------------------------------------------------------------
64 64 # Basic classes
65 65 #-----------------------------------------------------------------------------
66 66
67 67
68 68 class NoDefaultSpecified ( object ): pass
69 69 NoDefaultSpecified = NoDefaultSpecified()
70 70
71 71
72 72 class Undefined ( object ): pass
73 73 Undefined = Undefined()
74 74
75 75 class TraitError(Exception):
76 76 pass
77 77
78 78 #-----------------------------------------------------------------------------
79 79 # Utilities
80 80 #-----------------------------------------------------------------------------
81 81
82 82
83 83 def class_of ( object ):
84 84 """ Returns a string containing the class name of an object with the
85 85 correct indefinite article ('a' or 'an') preceding it (e.g., 'an Image',
86 86 'a PlotValue').
87 87 """
88 88 if isinstance( object, py3compat.string_types ):
89 89 return add_article( object )
90 90
91 91 return add_article( object.__class__.__name__ )
92 92
93 93
94 94 def add_article ( name ):
95 95 """ Returns a string containing the correct indefinite article ('a' or 'an')
96 96 prefixed to the specified string.
97 97 """
98 98 if name[:1].lower() in 'aeiou':
99 99 return 'an ' + name
100 100
101 101 return 'a ' + name
102 102
103 103
104 104 def repr_type(obj):
105 105 """ Return a string representation of a value and its type for readable
106 106 error messages.
107 107 """
108 108 the_type = type(obj)
109 109 if (not py3compat.PY3) and the_type is InstanceType:
110 110 # Old-style class.
111 111 the_type = obj.__class__
112 112 msg = '%r %r' % (obj, the_type)
113 113 return msg
114 114
115 115
116 116 def is_trait(t):
117 117 """ Returns whether the given value is an instance or subclass of TraitType.
118 118 """
119 119 return (isinstance(t, TraitType) or
120 120 (isinstance(t, type) and issubclass(t, TraitType)))
121 121
122 122
123 123 def parse_notifier_name(name):
124 124 """Convert the name argument to a list of names.
125 125
126 126 Examples
127 127 --------
128 128
129 129 >>> parse_notifier_name('a')
130 130 ['a']
131 131 >>> parse_notifier_name(['a','b'])
132 132 ['a', 'b']
133 133 >>> parse_notifier_name(None)
134 134 ['anytrait']
135 135 """
136 136 if isinstance(name, string_types):
137 137 return [name]
138 138 elif name is None:
139 139 return ['anytrait']
140 140 elif isinstance(name, (list, tuple)):
141 141 for n in name:
142 142 assert isinstance(n, string_types), "names must be strings"
143 143 return name
144 144
145 145
146 146 class _SimpleTest:
147 147 def __init__ ( self, value ): self.value = value
148 148 def __call__ ( self, test ):
149 149 return test == self.value
150 150 def __repr__(self):
151 151 return "<SimpleTest(%r)" % self.value
152 152 def __str__(self):
153 153 return self.__repr__()
154 154
155 155
156 156 def getmembers(object, predicate=None):
157 157 """A safe version of inspect.getmembers that handles missing attributes.
158 158
159 159 This is useful when there are descriptor based attributes that for
160 160 some reason raise AttributeError even though they exist. This happens
161 161 in zope.inteface with the __provides__ attribute.
162 162 """
163 163 results = []
164 164 for key in dir(object):
165 165 try:
166 166 value = getattr(object, key)
167 167 except AttributeError:
168 168 pass
169 169 else:
170 170 if not predicate or predicate(value):
171 171 results.append((key, value))
172 172 results.sort()
173 173 return results
174 174
175 175 @skip_doctest
176 176 class link(object):
177 177 """Link traits from different objects together so they remain in sync.
178 178
179 179 Parameters
180 180 ----------
181 181 obj : pairs of objects/attributes
182 182
183 183 Examples
184 184 --------
185 185
186 186 >>> c = link((obj1, 'value'), (obj2, 'value'), (obj3, 'value'))
187 187 >>> obj1.value = 5 # updates other objects as well
188 188 """
189 189 updating = False
190 190 def __init__(self, *args):
191 191 if len(args) < 2:
192 192 raise TypeError('At least two traitlets must be provided.')
193 193
194 194 self.objects = {}
195 195 initial = getattr(args[0][0], args[0][1])
196 196 for obj,attr in args:
197 197 if getattr(obj, attr) != initial:
198 198 setattr(obj, attr, initial)
199 199
200 200 callback = self._make_closure(obj,attr)
201 201 obj.on_trait_change(callback, attr)
202 202 self.objects[(obj,attr)] = callback
203 203
204 204 @contextlib.contextmanager
205 205 def _busy_updating(self):
206 206 self.updating = True
207 207 try:
208 208 yield
209 209 finally:
210 210 self.updating = False
211 211
212 212 def _make_closure(self, sending_obj, sending_attr):
213 213 def update(name, old, new):
214 214 self._update(sending_obj, sending_attr, new)
215 215 return update
216 216
217 217 def _update(self, sending_obj, sending_attr, new):
218 218 if self.updating:
219 219 return
220 220 with self._busy_updating():
221 221 for obj,attr in self.objects.keys():
222 222 if obj is not sending_obj or attr != sending_attr:
223 223 setattr(obj, attr, new)
224 224
225 225 def unlink(self):
226 226 for key, callback in self.objects.items():
227 227 (obj,attr) = key
228 228 obj.on_trait_change(callback, attr, remove=True)
229 229
230 230 @skip_doctest
231 231 class directional_link(object):
232 232 """Link the trait of a source object with traits of target objects.
233 233
234 234 Parameters
235 235 ----------
236 236 source : pair of object, name
237 237 targets : pairs of objects/attributes
238 238
239 239 Examples
240 240 --------
241 241
242 242 >>> c = directional_link((src, 'value'), (tgt1, 'value'), (tgt2, 'value'))
243 243 >>> src.value = 5 # updates target objects
244 244 >>> tgt1.value = 6 # does not update other objects
245 245 """
246 246 updating = False
247 247
248 248 def __init__(self, source, *targets):
249 249 self.source = source
250 250 self.targets = targets
251 251
252 252 # Update current value
253 253 src_attr_value = getattr(source[0], source[1])
254 254 for obj, attr in targets:
255 255 if getattr(obj, attr) != src_attr_value:
256 256 setattr(obj, attr, src_attr_value)
257 257
258 258 # Wire
259 259 self.source[0].on_trait_change(self._update, self.source[1])
260 260
261 261 @contextlib.contextmanager
262 262 def _busy_updating(self):
263 263 self.updating = True
264 264 try:
265 265 yield
266 266 finally:
267 267 self.updating = False
268 268
269 269 def _update(self, name, old, new):
270 270 if self.updating:
271 271 return
272 272 with self._busy_updating():
273 273 for obj, attr in self.targets:
274 274 setattr(obj, attr, new)
275 275
276 276 def unlink(self):
277 277 self.source[0].on_trait_change(self._update, self.source[1], remove=True)
278 278 self.source = None
279 279 self.targets = []
280 280
281 281 def dlink(source, *targets):
282 282 """Shorter helper function returning a directional_link object"""
283 283 return directional_link(source, *targets)
284 284
285 285 #-----------------------------------------------------------------------------
286 286 # Base TraitType for all traits
287 287 #-----------------------------------------------------------------------------
288 288
289 289
290 290 class TraitType(object):
291 291 """A base class for all trait descriptors.
292 292
293 293 Notes
294 294 -----
295 295 Our implementation of traits is based on Python's descriptor
296 296 prototol. This class is the base class for all such descriptors. The
297 297 only magic we use is a custom metaclass for the main :class:`HasTraits`
298 298 class that does the following:
299 299
300 300 1. Sets the :attr:`name` attribute of every :class:`TraitType`
301 301 instance in the class dict to the name of the attribute.
302 302 2. Sets the :attr:`this_class` attribute of every :class:`TraitType`
303 303 instance in the class dict to the *class* that declared the trait.
304 304 This is used by the :class:`This` trait to allow subclasses to
305 305 accept superclasses for :class:`This` values.
306 306 """
307 307
308 308
309 309 metadata = {}
310 310 default_value = Undefined
311 311 allow_none = False
312 312 info_text = 'any value'
313 313
314 314 def __init__(self, default_value=NoDefaultSpecified, allow_none=None, **metadata):
315 315 """Create a TraitType.
316 316 """
317 317 if default_value is not NoDefaultSpecified:
318 318 self.default_value = default_value
319 319 if allow_none is not None:
320 320 self.allow_none = allow_none
321 321
322 322 if len(metadata) > 0:
323 323 if len(self.metadata) > 0:
324 324 self._metadata = self.metadata.copy()
325 325 self._metadata.update(metadata)
326 326 else:
327 327 self._metadata = metadata
328 328 else:
329 329 self._metadata = self.metadata
330 330
331 331 self.init()
332 332
333 333 def init(self):
334 334 pass
335 335
336 336 def get_default_value(self):
337 337 """Create a new instance of the default value."""
338 338 return self.default_value
339 339
340 340 def instance_init(self, obj):
341 341 """This is called by :meth:`HasTraits.__new__` to finish init'ing.
342 342
343 343 Some stages of initialization must be delayed until the parent
344 344 :class:`HasTraits` instance has been created. This method is
345 345 called in :meth:`HasTraits.__new__` after the instance has been
346 346 created.
347 347
348 348 This method trigger the creation and validation of default values
349 349 and also things like the resolution of str given class names in
350 350 :class:`Type` and :class`Instance`.
351 351
352 352 Parameters
353 353 ----------
354 354 obj : :class:`HasTraits` instance
355 355 The parent :class:`HasTraits` instance that has just been
356 356 created.
357 357 """
358 358 self.set_default_value(obj)
359 359
360 360 def set_default_value(self, obj):
361 361 """Set the default value on a per instance basis.
362 362
363 363 This method is called by :meth:`instance_init` to create and
364 364 validate the default value. The creation and validation of
365 365 default values must be delayed until the parent :class:`HasTraits`
366 366 class has been instantiated.
367 367 """
368 368 # Check for a deferred initializer defined in the same class as the
369 369 # trait declaration or above.
370 370 mro = type(obj).mro()
371 371 meth_name = '_%s_default' % self.name
372 372 for cls in mro[:mro.index(self.this_class)+1]:
373 373 if meth_name in cls.__dict__:
374 374 break
375 375 else:
376 376 # We didn't find one. Do static initialization.
377 377 dv = self.get_default_value()
378 378 newdv = self._validate(obj, dv)
379 379 obj._trait_values[self.name] = newdv
380 380 return
381 381 # Complete the dynamic initialization.
382 382 obj._trait_dyn_inits[self.name] = meth_name
383 383
384 384 def __get__(self, obj, cls=None):
385 385 """Get the value of the trait by self.name for the instance.
386 386
387 387 Default values are instantiated when :meth:`HasTraits.__new__`
388 388 is called. Thus by the time this method gets called either the
389 389 default value or a user defined value (they called :meth:`__set__`)
390 390 is in the :class:`HasTraits` instance.
391 391 """
392 392 if obj is None:
393 393 return self
394 394 else:
395 395 try:
396 396 value = obj._trait_values[self.name]
397 397 except KeyError:
398 398 # Check for a dynamic initializer.
399 399 if self.name in obj._trait_dyn_inits:
400 400 method = getattr(obj, obj._trait_dyn_inits[self.name])
401 401 value = method()
402 402 # FIXME: Do we really validate here?
403 403 value = self._validate(obj, value)
404 404 obj._trait_values[self.name] = value
405 405 return value
406 406 else:
407 407 raise TraitError('Unexpected error in TraitType: '
408 408 'both default value and dynamic initializer are '
409 409 'absent.')
410 410 except Exception:
411 411 # HasTraits should call set_default_value to populate
412 412 # this. So this should never be reached.
413 413 raise TraitError('Unexpected error in TraitType: '
414 414 'default value not set properly')
415 415 else:
416 416 return value
417 417
418 418 def __set__(self, obj, value):
419 419 new_value = self._validate(obj, value)
420 420 old_value = self.__get__(obj)
421 421 obj._trait_values[self.name] = new_value
422 422 try:
423 423 silent = bool(old_value == new_value)
424 424 except:
425 425 # if there is an error in comparing, default to notify
426 426 silent = False
427 427 if silent is not True:
428 428 # we explicitly compare silent to True just in case the equality
429 429 # comparison above returns something other than True/False
430 430 obj._notify_trait(self.name, old_value, new_value)
431 431
432 432 def _validate(self, obj, value):
433 433 if value is None and self.allow_none:
434 434 return value
435 435 if hasattr(self, 'validate'):
436 436 return self.validate(obj, value)
437 437 elif hasattr(self, 'is_valid_for'):
438 438 valid = self.is_valid_for(value)
439 439 if valid:
440 440 return value
441 441 else:
442 442 raise TraitError('invalid value for type: %r' % value)
443 443 elif hasattr(self, 'value_for'):
444 444 return self.value_for(value)
445 445 else:
446 446 return value
447 447
448 448 def info(self):
449 449 return self.info_text
450 450
451 451 def error(self, obj, value):
452 452 if obj is not None:
453 453 e = "The '%s' trait of %s instance must be %s, but a value of %s was specified." \
454 454 % (self.name, class_of(obj),
455 455 self.info(), repr_type(value))
456 456 else:
457 457 e = "The '%s' trait must be %s, but a value of %r was specified." \
458 458 % (self.name, self.info(), repr_type(value))
459 459 raise TraitError(e)
460 460
461 461 def get_metadata(self, key, default=None):
462 462 return getattr(self, '_metadata', {}).get(key, default)
463 463
464 464 def set_metadata(self, key, value):
465 465 getattr(self, '_metadata', {})[key] = value
466 466
467 467
468 468 #-----------------------------------------------------------------------------
469 469 # The HasTraits implementation
470 470 #-----------------------------------------------------------------------------
471 471
472 472
473 473 class MetaHasTraits(type):
474 474 """A metaclass for HasTraits.
475 475
476 476 This metaclass makes sure that any TraitType class attributes are
477 477 instantiated and sets their name attribute.
478 478 """
479 479
480 480 def __new__(mcls, name, bases, classdict):
481 481 """Create the HasTraits class.
482 482
483 483 This instantiates all TraitTypes in the class dict and sets their
484 484 :attr:`name` attribute.
485 485 """
486 486 # print "MetaHasTraitlets (mcls, name): ", mcls, name
487 487 # print "MetaHasTraitlets (bases): ", bases
488 488 # print "MetaHasTraitlets (classdict): ", classdict
489 489 for k,v in iteritems(classdict):
490 490 if isinstance(v, TraitType):
491 491 v.name = k
492 492 elif inspect.isclass(v):
493 493 if issubclass(v, TraitType):
494 494 vinst = v()
495 495 vinst.name = k
496 496 classdict[k] = vinst
497 497 return super(MetaHasTraits, mcls).__new__(mcls, name, bases, classdict)
498 498
499 499 def __init__(cls, name, bases, classdict):
500 500 """Finish initializing the HasTraits class.
501 501
502 502 This sets the :attr:`this_class` attribute of each TraitType in the
503 503 class dict to the newly created class ``cls``.
504 504 """
505 505 for k, v in iteritems(classdict):
506 506 if isinstance(v, TraitType):
507 507 v.this_class = cls
508 508 super(MetaHasTraits, cls).__init__(name, bases, classdict)
509 509
510 510 class HasTraits(py3compat.with_metaclass(MetaHasTraits, object)):
511 511
512 512 def __new__(cls, *args, **kw):
513 513 # This is needed because object.__new__ only accepts
514 514 # the cls argument.
515 515 new_meth = super(HasTraits, cls).__new__
516 516 if new_meth is object.__new__:
517 517 inst = new_meth(cls)
518 518 else:
519 519 inst = new_meth(cls, **kw)
520 520 inst._trait_values = {}
521 521 inst._trait_notifiers = {}
522 522 inst._trait_dyn_inits = {}
523 523 # Here we tell all the TraitType instances to set their default
524 524 # values on the instance.
525 525 for key in dir(cls):
526 526 # Some descriptors raise AttributeError like zope.interface's
527 527 # __provides__ attributes even though they exist. This causes
528 528 # AttributeErrors even though they are listed in dir(cls).
529 529 try:
530 530 value = getattr(cls, key)
531 531 except AttributeError:
532 532 pass
533 533 else:
534 534 if isinstance(value, TraitType):
535 535 value.instance_init(inst)
536 536
537 537 return inst
538 538
539 539 def __init__(self, *args, **kw):
540 540 # Allow trait values to be set using keyword arguments.
541 541 # We need to use setattr for this to trigger validation and
542 542 # notifications.
543 543 for key, value in iteritems(kw):
544 544 setattr(self, key, value)
545 545
546 546 def _notify_trait(self, name, old_value, new_value):
547 547
548 548 # First dynamic ones
549 549 callables = []
550 550 callables.extend(self._trait_notifiers.get(name,[]))
551 551 callables.extend(self._trait_notifiers.get('anytrait',[]))
552 552
553 553 # Now static ones
554 554 try:
555 555 cb = getattr(self, '_%s_changed' % name)
556 556 except:
557 557 pass
558 558 else:
559 559 callables.append(cb)
560 560
561 561 # Call them all now
562 562 for c in callables:
563 563 # Traits catches and logs errors here. I allow them to raise
564 564 if callable(c):
565 565 argspec = inspect.getargspec(c)
566 566 nargs = len(argspec[0])
567 567 # Bound methods have an additional 'self' argument
568 568 # I don't know how to treat unbound methods, but they
569 569 # can't really be used for callbacks.
570 570 if isinstance(c, types.MethodType):
571 571 offset = -1
572 572 else:
573 573 offset = 0
574 574 if nargs + offset == 0:
575 575 c()
576 576 elif nargs + offset == 1:
577 577 c(name)
578 578 elif nargs + offset == 2:
579 579 c(name, new_value)
580 580 elif nargs + offset == 3:
581 581 c(name, old_value, new_value)
582 582 else:
583 583 raise TraitError('a trait changed callback '
584 584 'must have 0-3 arguments.')
585 585 else:
586 586 raise TraitError('a trait changed callback '
587 587 'must be callable.')
588 588
589 589
590 590 def _add_notifiers(self, handler, name):
591 591 if name not in self._trait_notifiers:
592 592 nlist = []
593 593 self._trait_notifiers[name] = nlist
594 594 else:
595 595 nlist = self._trait_notifiers[name]
596 596 if handler not in nlist:
597 597 nlist.append(handler)
598 598
599 599 def _remove_notifiers(self, handler, name):
600 600 if name in self._trait_notifiers:
601 601 nlist = self._trait_notifiers[name]
602 602 try:
603 603 index = nlist.index(handler)
604 604 except ValueError:
605 605 pass
606 606 else:
607 607 del nlist[index]
608 608
609 609 def on_trait_change(self, handler, name=None, remove=False):
610 610 """Setup a handler to be called when a trait changes.
611 611
612 612 This is used to setup dynamic notifications of trait changes.
613 613
614 614 Static handlers can be created by creating methods on a HasTraits
615 615 subclass with the naming convention '_[traitname]_changed'. Thus,
616 616 to create static handler for the trait 'a', create the method
617 617 _a_changed(self, name, old, new) (fewer arguments can be used, see
618 618 below).
619 619
620 620 Parameters
621 621 ----------
622 622 handler : callable
623 623 A callable that is called when a trait changes. Its
624 624 signature can be handler(), handler(name), handler(name, new)
625 625 or handler(name, old, new).
626 626 name : list, str, None
627 627 If None, the handler will apply to all traits. If a list
628 628 of str, handler will apply to all names in the list. If a
629 629 str, the handler will apply just to that name.
630 630 remove : bool
631 631 If False (the default), then install the handler. If True
632 632 then unintall it.
633 633 """
634 634 if remove:
635 635 names = parse_notifier_name(name)
636 636 for n in names:
637 637 self._remove_notifiers(handler, n)
638 638 else:
639 639 names = parse_notifier_name(name)
640 640 for n in names:
641 641 self._add_notifiers(handler, n)
642 642
643 643 @classmethod
644 644 def class_trait_names(cls, **metadata):
645 645 """Get a list of all the names of this class' traits.
646 646
647 647 This method is just like the :meth:`trait_names` method,
648 648 but is unbound.
649 649 """
650 650 return cls.class_traits(**metadata).keys()
651 651
652 652 @classmethod
653 653 def class_traits(cls, **metadata):
654 654 """Get a `dict` of all the traits of this class. The dictionary
655 655 is keyed on the name and the values are the TraitType objects.
656 656
657 657 This method is just like the :meth:`traits` method, but is unbound.
658 658
659 659 The TraitTypes returned don't know anything about the values
660 660 that the various HasTrait's instances are holding.
661 661
662 662 The metadata kwargs allow functions to be passed in which
663 663 filter traits based on metadata values. The functions should
664 664 take a single value as an argument and return a boolean. If
665 665 any function returns False, then the trait is not included in
666 666 the output. This does not allow for any simple way of
667 667 testing that a metadata name exists and has any
668 668 value because get_metadata returns None if a metadata key
669 669 doesn't exist.
670 670 """
671 671 traits = dict([memb for memb in getmembers(cls) if
672 672 isinstance(memb[1], TraitType)])
673 673
674 674 if len(metadata) == 0:
675 675 return traits
676 676
677 677 for meta_name, meta_eval in metadata.items():
678 678 if type(meta_eval) is not FunctionType:
679 679 metadata[meta_name] = _SimpleTest(meta_eval)
680 680
681 681 result = {}
682 682 for name, trait in traits.items():
683 683 for meta_name, meta_eval in metadata.items():
684 684 if not meta_eval(trait.get_metadata(meta_name)):
685 685 break
686 686 else:
687 687 result[name] = trait
688 688
689 689 return result
690 690
691 691 def trait_names(self, **metadata):
692 692 """Get a list of all the names of this class' traits."""
693 693 return self.traits(**metadata).keys()
694 694
695 695 def traits(self, **metadata):
696 696 """Get a `dict` of all the traits of this class. The dictionary
697 697 is keyed on the name and the values are the TraitType objects.
698 698
699 699 The TraitTypes returned don't know anything about the values
700 700 that the various HasTrait's instances are holding.
701 701
702 702 The metadata kwargs allow functions to be passed in which
703 703 filter traits based on metadata values. The functions should
704 704 take a single value as an argument and return a boolean. If
705 705 any function returns False, then the trait is not included in
706 706 the output. This does not allow for any simple way of
707 707 testing that a metadata name exists and has any
708 708 value because get_metadata returns None if a metadata key
709 709 doesn't exist.
710 710 """
711 711 traits = dict([memb for memb in getmembers(self.__class__) if
712 712 isinstance(memb[1], TraitType)])
713 713
714 714 if len(metadata) == 0:
715 715 return traits
716 716
717 717 for meta_name, meta_eval in metadata.items():
718 718 if type(meta_eval) is not FunctionType:
719 719 metadata[meta_name] = _SimpleTest(meta_eval)
720 720
721 721 result = {}
722 722 for name, trait in traits.items():
723 723 for meta_name, meta_eval in metadata.items():
724 724 if not meta_eval(trait.get_metadata(meta_name)):
725 725 break
726 726 else:
727 727 result[name] = trait
728 728
729 729 return result
730 730
731 731 def trait_metadata(self, traitname, key, default=None):
732 732 """Get metadata values for trait by key."""
733 733 try:
734 734 trait = getattr(self.__class__, traitname)
735 735 except AttributeError:
736 736 raise TraitError("Class %s does not have a trait named %s" %
737 737 (self.__class__.__name__, traitname))
738 738 else:
739 739 return trait.get_metadata(key, default)
740 740
741 741 #-----------------------------------------------------------------------------
742 742 # Actual TraitTypes implementations/subclasses
743 743 #-----------------------------------------------------------------------------
744 744
745 745 #-----------------------------------------------------------------------------
746 746 # TraitTypes subclasses for handling classes and instances of classes
747 747 #-----------------------------------------------------------------------------
748 748
749 749
750 750 class ClassBasedTraitType(TraitType):
751 751 """A trait with error reporting for Type, Instance and This."""
752 752
753 753 def error(self, obj, value):
754 754 kind = type(value)
755 755 if (not py3compat.PY3) and kind is InstanceType:
756 756 msg = 'class %s' % value.__class__.__name__
757 757 else:
758 758 msg = '%s (i.e. %s)' % ( str( kind )[1:-1], repr( value ) )
759 759
760 760 if obj is not None:
761 761 e = "The '%s' trait of %s instance must be %s, but a value of %s was specified." \
762 762 % (self.name, class_of(obj),
763 763 self.info(), msg)
764 764 else:
765 765 e = "The '%s' trait must be %s, but a value of %r was specified." \
766 766 % (self.name, self.info(), msg)
767 767
768 768 raise TraitError(e)
769 769
770 770
771 771 class Type(ClassBasedTraitType):
772 772 """A trait whose value must be a subclass of a specified class."""
773 773
774 774 def __init__ (self, default_value=None, klass=None, allow_none=True, **metadata ):
775 775 """Construct a Type trait
776 776
777 777 A Type trait specifies that its values must be subclasses of
778 778 a particular class.
779 779
780 780 If only ``default_value`` is given, it is used for the ``klass`` as
781 781 well.
782 782
783 783 Parameters
784 784 ----------
785 785 default_value : class, str or None
786 786 The default value must be a subclass of klass. If an str,
787 787 the str must be a fully specified class name, like 'foo.bar.Bah'.
788 788 The string is resolved into real class, when the parent
789 789 :class:`HasTraits` class is instantiated.
790 790 klass : class, str, None
791 791 Values of this trait must be a subclass of klass. The klass
792 792 may be specified in a string like: 'foo.bar.MyClass'.
793 793 The string is resolved into real class, when the parent
794 794 :class:`HasTraits` class is instantiated.
795 795 allow_none : boolean
796 796 Indicates whether None is allowed as an assignable value. Even if
797 797 ``False``, the default value may be ``None``.
798 798 """
799 799 if default_value is None:
800 800 if klass is None:
801 801 klass = object
802 802 elif klass is None:
803 803 klass = default_value
804 804
805 805 if not (inspect.isclass(klass) or isinstance(klass, py3compat.string_types)):
806 806 raise TraitError("A Type trait must specify a class.")
807 807
808 808 self.klass = klass
809 809
810 810 super(Type, self).__init__(default_value, allow_none=allow_none, **metadata)
811 811
812 812 def validate(self, obj, value):
813 813 """Validates that the value is a valid object instance."""
814 814 if isinstance(value, py3compat.string_types):
815 815 try:
816 816 value = import_item(value)
817 817 except ImportError:
818 818 raise TraitError("The '%s' trait of %s instance must be a type, but "
819 819 "%r could not be imported" % (self.name, obj, value))
820 820 try:
821 821 if issubclass(value, self.klass):
822 822 return value
823 823 except:
824 824 pass
825 825
826 826 self.error(obj, value)
827 827
828 828 def info(self):
829 829 """ Returns a description of the trait."""
830 830 if isinstance(self.klass, py3compat.string_types):
831 831 klass = self.klass
832 832 else:
833 833 klass = self.klass.__name__
834 834 result = 'a subclass of ' + klass
835 835 if self.allow_none:
836 836 return result + ' or None'
837 837 return result
838 838
839 839 def instance_init(self, obj):
840 840 self._resolve_classes()
841 841 super(Type, self).instance_init(obj)
842 842
843 843 def _resolve_classes(self):
844 844 if isinstance(self.klass, py3compat.string_types):
845 845 self.klass = import_item(self.klass)
846 846 if isinstance(self.default_value, py3compat.string_types):
847 847 self.default_value = import_item(self.default_value)
848 848
849 849 def get_default_value(self):
850 850 return self.default_value
851 851
852 852
853 853 class DefaultValueGenerator(object):
854 854 """A class for generating new default value instances."""
855 855
856 856 def __init__(self, *args, **kw):
857 857 self.args = args
858 858 self.kw = kw
859 859
860 860 def generate(self, klass):
861 861 return klass(*self.args, **self.kw)
862 862
863 863
864 864 class Instance(ClassBasedTraitType):
865 865 """A trait whose value must be an instance of a specified class.
866 866
867 867 The value can also be an instance of a subclass of the specified class.
868 868
869 869 Subclasses can declare default classes by overriding the klass attribute
870 870 """
871 871
872 872 klass = None
873 873
874 874 def __init__(self, klass=None, args=None, kw=None,
875 875 allow_none=True, **metadata ):
876 876 """Construct an Instance trait.
877 877
878 878 This trait allows values that are instances of a particular
879 879 class or its sublclasses. Our implementation is quite different
880 880 from that of enthough.traits as we don't allow instances to be used
881 881 for klass and we handle the ``args`` and ``kw`` arguments differently.
882 882
883 883 Parameters
884 884 ----------
885 885 klass : class, str
886 886 The class that forms the basis for the trait. Class names
887 887 can also be specified as strings, like 'foo.bar.Bar'.
888 888 args : tuple
889 889 Positional arguments for generating the default value.
890 890 kw : dict
891 891 Keyword arguments for generating the default value.
892 892 allow_none : bool
893 893 Indicates whether None is allowed as a value.
894 894
895 895 Notes
896 896 -----
897 897 If both ``args`` and ``kw`` are None, then the default value is None.
898 898 If ``args`` is a tuple and ``kw`` is a dict, then the default is
899 899 created as ``klass(*args, **kw)``. If exactly one of ``args`` or ``kw`` is
900 900 None, the None is replaced by ``()`` or ``{}``, respectively.
901 901 """
902 902 if klass is None:
903 903 klass = self.klass
904 904
905 905 if (klass is not None) and (inspect.isclass(klass) or isinstance(klass, py3compat.string_types)):
906 906 self.klass = klass
907 907 else:
908 908 raise TraitError('The klass attribute must be a class'
909 909 ' not: %r' % klass)
910 910
911 911 # self.klass is a class, so handle default_value
912 912 if args is None and kw is None:
913 913 default_value = None
914 914 else:
915 915 if args is None:
916 916 # kw is not None
917 917 args = ()
918 918 elif kw is None:
919 919 # args is not None
920 920 kw = {}
921 921
922 922 if not isinstance(kw, dict):
923 923 raise TraitError("The 'kw' argument must be a dict or None.")
924 924 if not isinstance(args, tuple):
925 925 raise TraitError("The 'args' argument must be a tuple or None.")
926 926
927 927 default_value = DefaultValueGenerator(*args, **kw)
928 928
929 929 super(Instance, self).__init__(default_value, allow_none=allow_none, **metadata)
930 930
931 931 def validate(self, obj, value):
932 932 if isinstance(value, self.klass):
933 933 return value
934 934 else:
935 935 self.error(obj, value)
936 936
937 937 def info(self):
938 938 if isinstance(self.klass, py3compat.string_types):
939 939 klass = self.klass
940 940 else:
941 941 klass = self.klass.__name__
942 942 result = class_of(klass)
943 943 if self.allow_none:
944 944 return result + ' or None'
945 945
946 946 return result
947 947
948 948 def instance_init(self, obj):
949 949 self._resolve_classes()
950 950 super(Instance, self).instance_init(obj)
951 951
952 952 def _resolve_classes(self):
953 953 if isinstance(self.klass, py3compat.string_types):
954 954 self.klass = import_item(self.klass)
955 955
956 956 def get_default_value(self):
957 957 """Instantiate a default value instance.
958 958
959 959 This is called when the containing HasTraits classes'
960 960 :meth:`__new__` method is called to ensure that a unique instance
961 961 is created for each HasTraits instance.
962 962 """
963 963 dv = self.default_value
964 964 if isinstance(dv, DefaultValueGenerator):
965 965 return dv.generate(self.klass)
966 966 else:
967 967 return dv
968 968
969 969
970 970 class This(ClassBasedTraitType):
971 971 """A trait for instances of the class containing this trait.
972 972
973 973 Because how how and when class bodies are executed, the ``This``
974 974 trait can only have a default value of None. This, and because we
975 975 always validate default values, ``allow_none`` is *always* true.
976 976 """
977 977
978 978 info_text = 'an instance of the same type as the receiver or None'
979 979
980 980 def __init__(self, **metadata):
981 981 super(This, self).__init__(None, **metadata)
982 982
983 983 def validate(self, obj, value):
984 984 # What if value is a superclass of obj.__class__? This is
985 985 # complicated if it was the superclass that defined the This
986 986 # trait.
987 987 if isinstance(value, self.this_class) or (value is None):
988 988 return value
989 989 else:
990 990 self.error(obj, value)
991 991
992 992
993 993 #-----------------------------------------------------------------------------
994 994 # Basic TraitTypes implementations/subclasses
995 995 #-----------------------------------------------------------------------------
996 996
997 997
998 998 class Any(TraitType):
999 999 default_value = None
1000 1000 info_text = 'any value'
1001 1001
1002 1002
1003 1003 class Int(TraitType):
1004 1004 """An int trait."""
1005 1005
1006 1006 default_value = 0
1007 1007 info_text = 'an int'
1008 1008
1009 1009 def validate(self, obj, value):
1010 1010 if isinstance(value, int):
1011 1011 return value
1012 1012 self.error(obj, value)
1013 1013
1014 1014 class CInt(Int):
1015 1015 """A casting version of the int trait."""
1016 1016
1017 1017 def validate(self, obj, value):
1018 1018 try:
1019 1019 return int(value)
1020 1020 except:
1021 1021 self.error(obj, value)
1022 1022
1023 1023 if py3compat.PY3:
1024 1024 Long, CLong = Int, CInt
1025 1025 Integer = Int
1026 1026 else:
1027 1027 class Long(TraitType):
1028 1028 """A long integer trait."""
1029 1029
1030 1030 default_value = 0
1031 1031 info_text = 'a long'
1032 1032
1033 1033 def validate(self, obj, value):
1034 1034 if isinstance(value, long):
1035 1035 return value
1036 1036 if isinstance(value, int):
1037 1037 return long(value)
1038 1038 self.error(obj, value)
1039 1039
1040 1040
1041 1041 class CLong(Long):
1042 1042 """A casting version of the long integer trait."""
1043 1043
1044 1044 def validate(self, obj, value):
1045 1045 try:
1046 1046 return long(value)
1047 1047 except:
1048 1048 self.error(obj, value)
1049 1049
1050 1050 class Integer(TraitType):
1051 1051 """An integer trait.
1052 1052
1053 1053 Longs that are unnecessary (<= sys.maxint) are cast to ints."""
1054 1054
1055 1055 default_value = 0
1056 1056 info_text = 'an integer'
1057 1057
1058 1058 def validate(self, obj, value):
1059 1059 if isinstance(value, int):
1060 1060 return value
1061 1061 if isinstance(value, long):
1062 1062 # downcast longs that fit in int:
1063 1063 # note that int(n > sys.maxint) returns a long, so
1064 1064 # we don't need a condition on this cast
1065 1065 return int(value)
1066 1066 if sys.platform == "cli":
1067 1067 from System import Int64
1068 1068 if isinstance(value, Int64):
1069 1069 return int(value)
1070 1070 self.error(obj, value)
1071 1071
1072 1072
1073 1073 class Float(TraitType):
1074 1074 """A float trait."""
1075 1075
1076 1076 default_value = 0.0
1077 1077 info_text = 'a float'
1078 1078
1079 1079 def validate(self, obj, value):
1080 1080 if isinstance(value, float):
1081 1081 return value
1082 1082 if isinstance(value, int):
1083 1083 return float(value)
1084 1084 self.error(obj, value)
1085 1085
1086 1086
1087 1087 class CFloat(Float):
1088 1088 """A casting version of the float trait."""
1089 1089
1090 1090 def validate(self, obj, value):
1091 1091 try:
1092 1092 return float(value)
1093 1093 except:
1094 1094 self.error(obj, value)
1095 1095
1096 1096 class Complex(TraitType):
1097 1097 """A trait for complex numbers."""
1098 1098
1099 1099 default_value = 0.0 + 0.0j
1100 1100 info_text = 'a complex number'
1101 1101
1102 1102 def validate(self, obj, value):
1103 1103 if isinstance(value, complex):
1104 1104 return value
1105 1105 if isinstance(value, (float, int)):
1106 1106 return complex(value)
1107 1107 self.error(obj, value)
1108 1108
1109 1109
1110 1110 class CComplex(Complex):
1111 1111 """A casting version of the complex number trait."""
1112 1112
1113 1113 def validate (self, obj, value):
1114 1114 try:
1115 1115 return complex(value)
1116 1116 except:
1117 1117 self.error(obj, value)
1118 1118
1119 1119 # We should always be explicit about whether we're using bytes or unicode, both
1120 1120 # for Python 3 conversion and for reliable unicode behaviour on Python 2. So
1121 1121 # we don't have a Str type.
1122 1122 class Bytes(TraitType):
1123 1123 """A trait for byte strings."""
1124 1124
1125 1125 default_value = b''
1126 1126 info_text = 'a bytes object'
1127 1127
1128 1128 def validate(self, obj, value):
1129 1129 if isinstance(value, bytes):
1130 1130 return value
1131 1131 self.error(obj, value)
1132 1132
1133 1133
1134 1134 class CBytes(Bytes):
1135 1135 """A casting version of the byte string trait."""
1136 1136
1137 1137 def validate(self, obj, value):
1138 1138 try:
1139 1139 return bytes(value)
1140 1140 except:
1141 1141 self.error(obj, value)
1142 1142
1143 1143
1144 1144 class Unicode(TraitType):
1145 1145 """A trait for unicode strings."""
1146 1146
1147 1147 default_value = u''
1148 1148 info_text = 'a unicode string'
1149 1149
1150 1150 def validate(self, obj, value):
1151 1151 if isinstance(value, py3compat.unicode_type):
1152 1152 return value
1153 1153 if isinstance(value, bytes):
1154 1154 try:
1155 1155 return value.decode('ascii', 'strict')
1156 1156 except UnicodeDecodeError:
1157 1157 msg = "Could not decode {!r} for unicode trait '{}' of {} instance."
1158 1158 raise TraitError(msg.format(value, self.name, class_of(obj)))
1159 1159 self.error(obj, value)
1160 1160
1161 1161
1162 1162 class CUnicode(Unicode):
1163 1163 """A casting version of the unicode trait."""
1164 1164
1165 1165 def validate(self, obj, value):
1166 1166 try:
1167 1167 return py3compat.unicode_type(value)
1168 1168 except:
1169 1169 self.error(obj, value)
1170 1170
1171 1171
1172 1172 class ObjectName(TraitType):
1173 1173 """A string holding a valid object name in this version of Python.
1174 1174
1175 1175 This does not check that the name exists in any scope."""
1176 1176 info_text = "a valid object identifier in Python"
1177 1177
1178 1178 if py3compat.PY3:
1179 1179 # Python 3:
1180 1180 coerce_str = staticmethod(lambda _,s: s)
1181 1181
1182 1182 else:
1183 1183 # Python 2:
1184 1184 def coerce_str(self, obj, value):
1185 1185 "In Python 2, coerce ascii-only unicode to str"
1186 1186 if isinstance(value, unicode):
1187 1187 try:
1188 1188 return str(value)
1189 1189 except UnicodeEncodeError:
1190 1190 self.error(obj, value)
1191 1191 return value
1192 1192
1193 1193 def validate(self, obj, value):
1194 1194 value = self.coerce_str(obj, value)
1195 1195
1196 1196 if isinstance(value, string_types) and py3compat.isidentifier(value):
1197 1197 return value
1198 1198 self.error(obj, value)
1199 1199
1200 1200 class DottedObjectName(ObjectName):
1201 1201 """A string holding a valid dotted object name in Python, such as A.b3._c"""
1202 1202 def validate(self, obj, value):
1203 1203 value = self.coerce_str(obj, value)
1204 1204
1205 1205 if isinstance(value, string_types) and py3compat.isidentifier(value, dotted=True):
1206 1206 return value
1207 1207 self.error(obj, value)
1208 1208
1209 1209
1210 1210 class Bool(TraitType):
1211 1211 """A boolean (True, False) trait."""
1212 1212
1213 1213 default_value = False
1214 1214 info_text = 'a boolean'
1215 1215
1216 1216 def validate(self, obj, value):
1217 1217 if isinstance(value, bool):
1218 1218 return value
1219 1219 self.error(obj, value)
1220 1220
1221 1221
1222 1222 class CBool(Bool):
1223 1223 """A casting version of the boolean trait."""
1224 1224
1225 1225 def validate(self, obj, value):
1226 1226 try:
1227 1227 return bool(value)
1228 1228 except:
1229 1229 self.error(obj, value)
1230 1230
1231 1231
1232 1232 class Enum(TraitType):
1233 1233 """An enum that whose value must be in a given sequence."""
1234 1234
1235 1235 def __init__(self, values, default_value=None, allow_none=True, **metadata):
1236 1236 self.values = values
1237 1237 super(Enum, self).__init__(default_value, allow_none=allow_none, **metadata)
1238 1238
1239 1239 def validate(self, obj, value):
1240 1240 if value in self.values:
1241 1241 return value
1242 1242 self.error(obj, value)
1243 1243
1244 1244 def info(self):
1245 1245 """ Returns a description of the trait."""
1246 1246 result = 'any of ' + repr(self.values)
1247 1247 if self.allow_none:
1248 1248 return result + ' or None'
1249 1249 return result
1250 1250
1251 1251 class CaselessStrEnum(Enum):
1252 1252 """An enum of strings that are caseless in validate."""
1253 1253
1254 1254 def validate(self, obj, value):
1255 1255 if not isinstance(value, py3compat.string_types):
1256 1256 self.error(obj, value)
1257 1257
1258 1258 for v in self.values:
1259 1259 if v.lower() == value.lower():
1260 1260 return v
1261 1261 self.error(obj, value)
1262 1262
1263 1263 class Container(Instance):
1264 1264 """An instance of a container (list, set, etc.)
1265 1265
1266 1266 To be subclassed by overriding klass.
1267 1267 """
1268 1268 klass = None
1269 1269 _cast_types = ()
1270 1270 _valid_defaults = SequenceTypes
1271 1271 _trait = None
1272 1272
1273 1273 def __init__(self, trait=None, default_value=None, allow_none=True,
1274 1274 **metadata):
1275 1275 """Create a container trait type from a list, set, or tuple.
1276 1276
1277 1277 The default value is created by doing ``List(default_value)``,
1278 1278 which creates a copy of the ``default_value``.
1279 1279
1280 1280 ``trait`` can be specified, which restricts the type of elements
1281 1281 in the container to that TraitType.
1282 1282
1283 1283 If only one arg is given and it is not a Trait, it is taken as
1284 1284 ``default_value``:
1285 1285
1286 1286 ``c = List([1,2,3])``
1287 1287
1288 1288 Parameters
1289 1289 ----------
1290 1290
1291 1291 trait : TraitType [ optional ]
1292 1292 the type for restricting the contents of the Container. If unspecified,
1293 1293 types are not checked.
1294 1294
1295 1295 default_value : SequenceType [ optional ]
1296 1296 The default value for the Trait. Must be list/tuple/set, and
1297 1297 will be cast to the container type.
1298 1298
1299 1299 allow_none : Bool [ default True ]
1300 1300 Whether to allow the value to be None
1301 1301
1302 1302 **metadata : any
1303 1303 further keys for extensions to the Trait (e.g. config)
1304 1304
1305 1305 """
1306 1306 # allow List([values]):
1307 1307 if default_value is None and not is_trait(trait):
1308 1308 default_value = trait
1309 1309 trait = None
1310 1310
1311 1311 if default_value is None:
1312 1312 args = ()
1313 1313 elif isinstance(default_value, self._valid_defaults):
1314 1314 args = (default_value,)
1315 1315 else:
1316 1316 raise TypeError('default value of %s was %s' %(self.__class__.__name__, default_value))
1317 1317
1318 1318 if is_trait(trait):
1319 1319 self._trait = trait() if isinstance(trait, type) else trait
1320 1320 self._trait.name = 'element'
1321 1321 elif trait is not None:
1322 1322 raise TypeError("`trait` must be a Trait or None, got %s"%repr_type(trait))
1323 1323
1324 1324 super(Container,self).__init__(klass=self.klass, args=args,
1325 1325 allow_none=allow_none, **metadata)
1326 1326
1327 1327 def element_error(self, obj, element, validator):
1328 1328 e = "Element of the '%s' trait of %s instance must be %s, but a value of %s was specified." \
1329 1329 % (self.name, class_of(obj), validator.info(), repr_type(element))
1330 1330 raise TraitError(e)
1331 1331
1332 1332 def validate(self, obj, value):
1333 1333 if isinstance(value, self._cast_types):
1334 1334 value = self.klass(value)
1335 1335 value = super(Container, self).validate(obj, value)
1336 1336 if value is None:
1337 1337 return value
1338 1338
1339 1339 value = self.validate_elements(obj, value)
1340 1340
1341 1341 return value
1342 1342
1343 1343 def validate_elements(self, obj, value):
1344 1344 validated = []
1345 1345 if self._trait is None or isinstance(self._trait, Any):
1346 1346 return value
1347 1347 for v in value:
1348 1348 try:
1349 1349 v = self._trait._validate(obj, v)
1350 1350 except TraitError:
1351 1351 self.element_error(obj, v, self._trait)
1352 1352 else:
1353 1353 validated.append(v)
1354 1354 return self.klass(validated)
1355 1355
1356 1356 def instance_init(self, obj):
1357 if isinstance(self._trait, TraitType):
1358 self._trait.this_class = self.this_class
1357 1359 if isinstance(self._trait, Instance):
1358 1360 self._trait._resolve_classes()
1359 1361 super(Container, self).instance_init(obj)
1360 1362
1361 1363
1362 1364 class List(Container):
1363 1365 """An instance of a Python list."""
1364 1366 klass = list
1365 1367 _cast_types = (tuple,)
1366 1368
1367 1369 def __init__(self, trait=None, default_value=None, minlen=0, maxlen=sys.maxsize,
1368 1370 allow_none=True, **metadata):
1369 1371 """Create a List trait type from a list, set, or tuple.
1370 1372
1371 1373 The default value is created by doing ``List(default_value)``,
1372 1374 which creates a copy of the ``default_value``.
1373 1375
1374 1376 ``trait`` can be specified, which restricts the type of elements
1375 1377 in the container to that TraitType.
1376 1378
1377 1379 If only one arg is given and it is not a Trait, it is taken as
1378 1380 ``default_value``:
1379 1381
1380 1382 ``c = List([1,2,3])``
1381 1383
1382 1384 Parameters
1383 1385 ----------
1384 1386
1385 1387 trait : TraitType [ optional ]
1386 1388 the type for restricting the contents of the Container. If unspecified,
1387 1389 types are not checked.
1388 1390
1389 1391 default_value : SequenceType [ optional ]
1390 1392 The default value for the Trait. Must be list/tuple/set, and
1391 1393 will be cast to the container type.
1392 1394
1393 1395 minlen : Int [ default 0 ]
1394 1396 The minimum length of the input list
1395 1397
1396 1398 maxlen : Int [ default sys.maxsize ]
1397 1399 The maximum length of the input list
1398 1400
1399 1401 allow_none : Bool [ default True ]
1400 1402 Whether to allow the value to be None
1401 1403
1402 1404 **metadata : any
1403 1405 further keys for extensions to the Trait (e.g. config)
1404 1406
1405 1407 """
1406 1408 self._minlen = minlen
1407 1409 self._maxlen = maxlen
1408 1410 super(List, self).__init__(trait=trait, default_value=default_value,
1409 1411 allow_none=allow_none, **metadata)
1410 1412
1411 1413 def length_error(self, obj, value):
1412 1414 e = "The '%s' trait of %s instance must be of length %i <= L <= %i, but a value of %s was specified." \
1413 1415 % (self.name, class_of(obj), self._minlen, self._maxlen, value)
1414 1416 raise TraitError(e)
1415 1417
1416 1418 def validate_elements(self, obj, value):
1417 1419 length = len(value)
1418 1420 if length < self._minlen or length > self._maxlen:
1419 1421 self.length_error(obj, value)
1420 1422
1421 1423 return super(List, self).validate_elements(obj, value)
1422 1424
1423 1425 def validate(self, obj, value):
1424 1426 value = super(List, self).validate(obj, value)
1425 1427
1426 1428 value = self.validate_elements(obj, value)
1427 1429
1428 1430 return value
1429 1431
1430 1432
1431 1433
1432 1434 class Set(List):
1433 1435 """An instance of a Python set."""
1434 1436 klass = set
1435 1437 _cast_types = (tuple, list)
1436 1438
1437 1439 class Tuple(Container):
1438 1440 """An instance of a Python tuple."""
1439 1441 klass = tuple
1440 1442 _cast_types = (list,)
1441 1443
1442 1444 def __init__(self, *traits, **metadata):
1443 1445 """Tuple(*traits, default_value=None, allow_none=True, **medatata)
1444 1446
1445 1447 Create a tuple from a list, set, or tuple.
1446 1448
1447 1449 Create a fixed-type tuple with Traits:
1448 1450
1449 1451 ``t = Tuple(Int, Str, CStr)``
1450 1452
1451 1453 would be length 3, with Int,Str,CStr for each element.
1452 1454
1453 1455 If only one arg is given and it is not a Trait, it is taken as
1454 1456 default_value:
1455 1457
1456 1458 ``t = Tuple((1,2,3))``
1457 1459
1458 1460 Otherwise, ``default_value`` *must* be specified by keyword.
1459 1461
1460 1462 Parameters
1461 1463 ----------
1462 1464
1463 1465 *traits : TraitTypes [ optional ]
1464 1466 the tsype for restricting the contents of the Tuple. If unspecified,
1465 1467 types are not checked. If specified, then each positional argument
1466 1468 corresponds to an element of the tuple. Tuples defined with traits
1467 1469 are of fixed length.
1468 1470
1469 1471 default_value : SequenceType [ optional ]
1470 1472 The default value for the Tuple. Must be list/tuple/set, and
1471 1473 will be cast to a tuple. If `traits` are specified, the
1472 1474 `default_value` must conform to the shape and type they specify.
1473 1475
1474 1476 allow_none : Bool [ default True ]
1475 1477 Whether to allow the value to be None
1476 1478
1477 1479 **metadata : any
1478 1480 further keys for extensions to the Trait (e.g. config)
1479 1481
1480 1482 """
1481 1483 default_value = metadata.pop('default_value', None)
1482 1484 allow_none = metadata.pop('allow_none', True)
1483 1485
1484 1486 # allow Tuple((values,)):
1485 1487 if len(traits) == 1 and default_value is None and not is_trait(traits[0]):
1486 1488 default_value = traits[0]
1487 1489 traits = ()
1488 1490
1489 1491 if default_value is None:
1490 1492 args = ()
1491 1493 elif isinstance(default_value, self._valid_defaults):
1492 1494 args = (default_value,)
1493 1495 else:
1494 1496 raise TypeError('default value of %s was %s' %(self.__class__.__name__, default_value))
1495 1497
1496 1498 self._traits = []
1497 1499 for trait in traits:
1498 1500 t = trait() if isinstance(trait, type) else trait
1499 1501 t.name = 'element'
1500 1502 self._traits.append(t)
1501 1503
1502 1504 if self._traits and default_value is None:
1503 1505 # don't allow default to be an empty container if length is specified
1504 1506 args = None
1505 1507 super(Container,self).__init__(klass=self.klass, args=args,
1506 1508 allow_none=allow_none, **metadata)
1507 1509
1508 1510 def validate_elements(self, obj, value):
1509 1511 if not self._traits:
1510 1512 # nothing to validate
1511 1513 return value
1512 1514 if len(value) != len(self._traits):
1513 1515 e = "The '%s' trait of %s instance requires %i elements, but a value of %s was specified." \
1514 1516 % (self.name, class_of(obj), len(self._traits), repr_type(value))
1515 1517 raise TraitError(e)
1516 1518
1517 1519 validated = []
1518 1520 for t,v in zip(self._traits, value):
1519 1521 try:
1520 1522 v = t._validate(obj, v)
1521 1523 except TraitError:
1522 1524 self.element_error(obj, v, t)
1523 1525 else:
1524 1526 validated.append(v)
1525 1527 return tuple(validated)
1526 1528
1527 1529
1528 1530 class Dict(Instance):
1529 1531 """An instance of a Python dict."""
1530 1532
1531 1533 def __init__(self, default_value=None, allow_none=True, **metadata):
1532 1534 """Create a dict trait type from a dict.
1533 1535
1534 1536 The default value is created by doing ``dict(default_value)``,
1535 1537 which creates a copy of the ``default_value``.
1536 1538 """
1537 1539 if default_value is None:
1538 1540 args = ((),)
1539 1541 elif isinstance(default_value, dict):
1540 1542 args = (default_value,)
1541 1543 elif isinstance(default_value, SequenceTypes):
1542 1544 args = (default_value,)
1543 1545 else:
1544 1546 raise TypeError('default value of Dict was %s' % default_value)
1545 1547
1546 1548 super(Dict,self).__init__(klass=dict, args=args,
1547 1549 allow_none=allow_none, **metadata)
1548 1550
1549 1551
1550 1552 class EventfulDict(Instance):
1551 1553 """An instance of an EventfulDict."""
1552 1554
1553 1555 def __init__(self, default_value=None, allow_none=True, **metadata):
1554 1556 """Create a EventfulDict trait type from a dict.
1555 1557
1556 1558 The default value is created by doing
1557 1559 ``eventful.EvenfulDict(default_value)``, which creates a copy of the
1558 1560 ``default_value``.
1559 1561 """
1560 1562 if default_value is None:
1561 1563 args = ((),)
1562 1564 elif isinstance(default_value, dict):
1563 1565 args = (default_value,)
1564 1566 elif isinstance(default_value, SequenceTypes):
1565 1567 args = (default_value,)
1566 1568 else:
1567 1569 raise TypeError('default value of EventfulDict was %s' % default_value)
1568 1570
1569 1571 super(EventfulDict, self).__init__(klass=eventful.EventfulDict, args=args,
1570 1572 allow_none=allow_none, **metadata)
1571 1573
1572 1574
1573 1575 class EventfulList(Instance):
1574 1576 """An instance of an EventfulList."""
1575 1577
1576 1578 def __init__(self, default_value=None, allow_none=True, **metadata):
1577 1579 """Create a EventfulList trait type from a dict.
1578 1580
1579 1581 The default value is created by doing
1580 1582 ``eventful.EvenfulList(default_value)``, which creates a copy of the
1581 1583 ``default_value``.
1582 1584 """
1583 1585 if default_value is None:
1584 1586 args = ((),)
1585 1587 else:
1586 1588 args = (default_value,)
1587 1589
1588 1590 super(EventfulList, self).__init__(klass=eventful.EventfulList, args=args,
1589 1591 allow_none=allow_none, **metadata)
1590 1592
1591 1593
1592 1594 class TCPAddress(TraitType):
1593 1595 """A trait for an (ip, port) tuple.
1594 1596
1595 1597 This allows for both IPv4 IP addresses as well as hostnames.
1596 1598 """
1597 1599
1598 1600 default_value = ('127.0.0.1', 0)
1599 1601 info_text = 'an (ip, port) tuple'
1600 1602
1601 1603 def validate(self, obj, value):
1602 1604 if isinstance(value, tuple):
1603 1605 if len(value) == 2:
1604 1606 if isinstance(value[0], py3compat.string_types) and isinstance(value[1], int):
1605 1607 port = value[1]
1606 1608 if port >= 0 and port <= 65535:
1607 1609 return value
1608 1610 self.error(obj, value)
1609 1611
1610 1612 class CRegExp(TraitType):
1611 1613 """A casting compiled regular expression trait.
1612 1614
1613 1615 Accepts both strings and compiled regular expressions. The resulting
1614 1616 attribute will be a compiled regular expression."""
1615 1617
1616 1618 info_text = 'a regular expression'
1617 1619
1618 1620 def validate(self, obj, value):
1619 1621 try:
1620 1622 return re.compile(value)
1621 1623 except:
1622 1624 self.error(obj, value)
General Comments 0
You need to be logged in to leave comments. Login now