Changeset 6312 for main/waeup.sirp/trunk/src/waeup/sirp/image/image.py

Timestamp:

9 Jun 2011, 23:02:36 (13 years ago)

Author:

uli

Message:

• Add a destructor that removes the bound file of the bound Blob when a WAeUPImageFile gets deleted. Otherwise for each once created WAeUPImageFile that was not stored into ZODB we would get a lingering copy of the file contents in the system temporary dir.

• Update docs.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/image/image.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/image/image.py

@@ -32 +32 @@
     """A file prepared for storing image files.
 
-    This file type is built upon :class:`hurry.file.HurryFile`.
+    This file type is built upon :class:`hurry.file.HurryFile`. It
+    stores the file contents given by `data` in a ZODB Blob.
+
+    The `filename` passed can be retrieved later as the `filename`
+    attribute although the contents of this parameter makes no
+    difference for us.
     """
     implements(IWAeUPImageFile)
@@ -41 +46 @@
         self.headers = {}
 
+    def __del__(self):
+        """Remove the real filesystem file bound to the blob.
+
+        Blob content is initially written to some real filesystem
+        file. This file might linger around in temporary dirs when
+        :class:`WAeUPImageFile` instances are created without storing
+        them in ZODB afterwards. This often happens in tests.
+
+        We remove that file too when we are about to be deleted.
+        """
+        if self._p_oid is not None or self._file._p_oid is not None:
+            # Don't mess up internal ZODB structure
+            return
+        f = self._file.open('r')
+        name = getattr(f, 'name', None)
+        f.close()
+        if name is not None and os.path.exists(name) and os.path.isfile(name):
+            os.unlink(name)
+        return
+
     def _getFile(self):
         return self._file.open('r')
 
+    #: A Python file-object already openend for reading containing the
+    #: stored file.
     file = property(_getFile)
 
     @property
     def size(self):
+        """The size of the stored file in bytes.
+        """
         f = self._file.open('r')
         size = int(os.fstat(f.fileno()).st_size)
@@ -55 +84 @@
     @property
     def data(self):
+        """The contents of the stored file.
+        """
         f = self._file.open('r')
         result = f.read()