Add reprs for OpenSlide, ImageSlide, DeepZoomGenerator

Author: bgilbert

openslide/__init__.py

@@ -150,8 +150,12 @@ class OpenSlide(AbstractSlide):
     def __init__(self, filename):
         """Open a whole-slide image."""
         AbstractSlide.__init__(self)
+        self._filename = filename
         self._osr = lowlevel.open(filename)
 
+    def __repr__(self):
+        return '%s(%r)' % (self.__class__.__name__, self._filename)
+
     @classmethod
     def detect_format(cls, filename):
         """Return a string describing the format vendor of the specified file.
@@ -266,13 +270,17 @@ def __init__(self, file):
 
         file can be a filename or a PIL.Image."""
         AbstractSlide.__init__(self)
+        self._file_arg = file
         if isinstance(file, Image.Image):
             self._close = False
             self._image = file
         else:
             self._close = True
             self._image = Image.open(file)
 
+    def __repr__(self):
+        return '%s(%r)' % (self.__class__.__name__, self._file_arg)
+
     @classmethod
     def detect_format(cls, filename):
         """Return a string describing the format of the specified file.

openslide/deepzoom.py

@@ -58,6 +58,7 @@ def __init__(self, osr, tile_size=254, overlap=1, limit_bounds=False):
         self._osr = osr
         self._z_t_downsample = tile_size
         self._z_overlap = overlap
+        self._limit_bounds = limit_bounds
 
         # Precompute dimensions
         # Slide level and offset
@@ -112,6 +113,11 @@ def __init__(self, osr, tile_size=254, overlap=1, limit_bounds=False):
         self._bg_color = '#' + self._osr.properties.get(
                         openslide.PROPERTY_NAME_BACKGROUND_COLOR, 'ffffff')
 
+    def __repr__(self):
+        return '%s(%r, tile_size=%r, overlap=%r, limit_bounds=%r)' % (
+                self.__class__.__name__, self._osr, self._z_t_downsample,
+                self._z_overlap, self._limit_bounds)
+
     @property
     def level_count(self):
         """The number of Deep Zoom levels in the image."""

tests/test_deepzoom.py

@@ -33,6 +33,11 @@ def setUp(self):
     def tearDown(self):
         self.osr.close()
 
+    def test_repr(self):
+        self.assertEqual(repr(self.dz),
+                ('DeepZoomGenerator(%r, tile_size=254, overlap=1, ' +
+                'limit_bounds=False)') % self.osr)
+
     def test_metadata(self):
         self.assertEqual(self.dz.level_count, 10)
         self.assertEqual(self.dz.tile_count, 11)

tests/test_imageslide.py

@@ -52,10 +52,12 @@ def test_open(self):
         self.assertRaises(IOError,
                 lambda: ImageSlide(file_path('../setup.py')))
 
+    def test_open_image(self):
         # passing PIL.Image to ImageSlide
         with image_open(file_path('boxes.png')) as img:
             with ImageSlide(img) as osr:
                 self.assertEqual(osr.dimensions, (300, 250))
+                self.assertEqual(repr(osr), 'ImageSlide(%r)' % img)
 
     def test_operations_on_closed_handle(self):
         with image_open(file_path('boxes.png')) as img:
@@ -82,6 +84,10 @@ def setUp(self):
     def tearDown(self):
         self.osr.close()
 
+    def test_repr(self):
+        self.assertEqual(repr(self.osr),
+                'ImageSlide(%r)' % file_path('boxes.png'))
+
     def test_metadata(self):
         self.assertEqual(self.osr.level_count, 1)
         self.assertEqual(self.osr.level_dimensions, ((300, 250),))

tests/test_openslide.py

@@ -73,6 +73,10 @@ def tearDown(self):
 class TestSlide(_SlideTest, unittest.TestCase):
     FILENAME = 'boxes.tiff'
 
+    def test_repr(self):
+        self.assertEqual(repr(self.osr),
+                'OpenSlide(%r)' % file_path('boxes.tiff'))
+
     def test_basic_metadata(self):
         self.assertEqual(self.osr.level_count, 4)
         self.assertEqual(self.osr.level_dimensions,