/usr/share/pyshared/traits/tests/protocols_usage_test_case.py is in python-traits 4.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | #-------------------------------------------------------------------------------
#
# Copyright (c) 2007, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in /LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
#
#-------------------------------------------------------------------------------
""" Tests for protocols usage. """
from __future__ import absolute_import
# Standard library imports.
import pickle, unittest, os
# Enthought library imports.
from ..api import (Bool, HasTraits, Int, Interface, Str, Adapter, adapts,
Property)
# NOTE: There is a File class in apptools.io module, but since we want to
# eliminate dependencies of Traits on other modules, we create another
# minimal File class here to test the adapter implementation.
# Test class
class File(HasTraits):
# The path name of this file/folder.
path = Str
# Is this an existing file?
is_file = Property(Bool)
# Is this an existing folder?
is_folder = Property(Bool)
def _get_is_file(self):
""" Returns True if the path exists and is a file. """
return os.path.exists(self.path) and os.path.isfile(self.path)
def _get_is_folder(self):
""" Returns True if the path exists and is a folder. """
return os.path.exists(self.path) and os.path.isdir(self.path)
# Test class.
class Person(HasTraits):
""" A person! """
name = Str
age = Int
class ProtocolsUsageTestCase(unittest.TestCase):
""" Tests for protocols usage. """
def test_adapts(self):
""" adapts """
class IFoo(Interface):
""" A simple interface. """
def foo(self):
""" The only method for the IFoo interface. """
class Bar(HasTraits):
""" A type that *doesn't* implement 'IFoo'. """
class BarToIFooAdapter(Adapter):
""" Adapts from Bar to IFoo. """
adapts(Bar, to=IFoo)
def foo(self):
""" An implementation of the single method in the interface."""
return 'foo'
b = Bar()
# Make sure that the Bar instance can be adapted to 'IFoo'.
self.assertNotEqual(None, IFoo(b))
self.assertEqual('foo', IFoo(b).foo())
def test_factory(self):
""" factory """
class IInputStream(Interface):
""" Fake interface for input stream. """
def get_input_stream(self):
""" Get an input stream. """
def factory(obj):
""" A factory for File to IInputStream adapters. """
if not obj.is_folder:
adapter = FileToIInputStreamAdapter(adaptee=obj)
else:
adapter = None
return adapter
class FileToIInputStreamAdapter(Adapter):
""" An adapter from 'File' to 'IInputStream'. """
adapts(File, to=IInputStream, factory=factory)
###################################################################
# 'IInputStream' interface.
###################################################################
def get_input_stream(self):
""" Get an input stream. """
return file(self.adaptee.path, 'r')
# Create a reference to this file
cwd = os.path.dirname(os.path.abspath(__file__))
f = File(path=os.path.join(cwd, 'protocols_usage_test_case.py'))
self.assert_(f.is_file)
# A reference to the parent folder
g = File(path='..')
self.assert_(g.is_folder)
# We should be able to adapt the file to an input stream...
self.assertNotEqual(None, IInputStream(f, None))
# ... but not the folder.
self.assertEqual(None, IInputStream(g, None))
# Make sure we can use the stream (this reads this module and makes
# sure that it contains the right doc string).
stream = IInputStream(f).get_input_stream()
self.assert_('"""' + __doc__ in stream.read())
return
def test_when_expression(self):
""" when expression """
class IInputStream(Interface):
""" Fake interface for input stream. """
def get_input_stream(self):
""" Get an input stream. """
class FileToIInputStreamAdapter(Adapter):
""" An adapter from 'File' to 'IInputStream'. """
adapts(File, to=IInputStream, when='not adaptee.is_folder')
###################################################################
# 'IInputStream' interface.
###################################################################
def get_input_stream(self):
""" Get an input stream. """
return file(self.adaptee.path, 'r')
# Create a reference to this file
cwd = os.path.dirname(os.path.abspath(__file__))
f = File(path=os.path.join(cwd, 'protocols_usage_test_case.py'))
self.assert_(f.is_file)
# A reference to the parent folder
g = File(path='..')
self.assert_(g.is_folder)
# We should be able to adapt the file to an input stream...
self.assertNotEqual(None, IInputStream(f, None))
# ... but not the folder.
self.assertEqual(None, IInputStream(g, None))
# Make sure we can use the stream (this reads this module and makes
# sure that it contains the right doc string).
stream = IInputStream(f).get_input_stream()
self.assert_('"""' + __doc__ in stream.read())
return
def test_cached(self):
""" cached """
class ISaveable(Interface):
""" Fake interface for saveable. """
# Is the object 'dirty'?
dirty = Bool(False)
def save(self, output_stream):
""" Save the object to an output stream. """
class HasTraitsToISaveableAdapter(Adapter):
""" An adapter from 'HasTraits' to 'ISaveable'. """
adapts(HasTraits, to=ISaveable, cached=True)
#### 'ISaveable' interface ########################################
# Is the object 'dirty'?
dirty = Bool(False)
def save(self, output_stream):
""" Save the object to an output stream. """
pickle.dump(self.adaptee, output_stream)
self.dirty = False
return
#### Private interface ############################################
def _adaptee_changed(self, old, new):
""" Static trait change handler. """
if old is not None:
old.on_trait_change(self._set_dirty, remove=True)
if new is not None:
new.on_trait_change(self._set_dirty)
self._set_dirty()
return
def _set_dirty(self):
""" Sets the dirty flag to True. """
self.dirty = True
return
# Create some people!
fred = Person(name='fred', age=42)
wilma = Person(name='wilma', age=35)
fred_saveable = ISaveable(fred)
self.assertEqual(True, fred_saveable.dirty)
wilma_saveable = ISaveable(wilma)
self.assertEqual(True, wilma_saveable.dirty)
# Make sure that Fred and Wilma have got their own saveable.
self.assertNotEqual(id(fred_saveable), id(wilma_saveable))
# But make sure that their saveable's are cached.
self.assertEqual(id(ISaveable(fred)), id(fred_saveable))
self.assertEqual(id(ISaveable(wilma)), id(wilma_saveable))
# Save Fred and Wilma and make sure that the dirty flag is cleared.
fred_saveable.save(file('fred.pickle', 'w'))
self.assertEqual(False, ISaveable(fred).dirty)
wilma_saveable.save(file('wilma.pickle', 'w'))
self.assertEqual(False, ISaveable(wilma).dirty)
# Clean up.
for path in ['fred.pickle', 'wilma.pickle']:
if os.access(path, os.W_OK):
os.remove(path)
return
def test_multiple_factories_for_type(self):
""" multiple factories for type """
# There was a bug that prevented more than one adapter factory being
# registered for the same class.
class IFoo(Interface):
pass
class HasTraitsToIFooAdapter(Adapter):
adapts(HasTraits, to=IFoo, cached=True)
class IBar(Interface):
pass
class HasTraitsToIBarAdapter(Adapter):
adapts(HasTraits, to=IBar, cached=True)
return
def test_multiple_factories_for_interface(self):
""" multiple factories for interfaces """
# There was a bug that prevented more than one adapter factory being
# registered for the same class. This test just makes sure that it
# still works for interfaces too!
class IBaz(Interface):
pass
class IFoo(Interface):
pass
class IBazToIFooAdapter(Adapter):
adapts(IBaz, to=IFoo, cached=True)
class IBar(Interface):
pass
class IBazToIBarAdapter(Adapter):
adapts(IBaz, to=IBar, cached=True)
return
# Run the unit tests (if invoked from the command line):
if __name__ == '__main__':
unittest.main()
|