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