Changeset 7053 for main/waeup.sirp/branches/ulif-extimgstore

Timestamp:

9 Nov 2011, 05:50:45 (13 years ago)

Author:

uli

Message:

Extend docs.
Add new convenience method to get external files by context.

File:

• main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/imagestorage.py (modified) (2 diffs)

main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/imagestorage.py

@@ -319 +319 @@
         This methods takes into account registered handlers for any
         marker put into the file_id.
+
+        .. seealso:: :class:`DefaultFileStoreHandler`
         """
         marker, filename, base, ext = self.extractMarker(file_id)
@@ -328 +330 @@
         fd = open(path, 'rb')
         return fd
+
+    def getFileByContext(self, context):
+        """Get a file for given context.
+
+        Returns a file already opened for reading.
+
+        If the file cannot be found ``None`` is returned.
+
+        This method takes into account registered handlers and file
+        name choosers for context types.
+
+        This is a convenience method that internally calls
+        :meth:`getFile`.
+
+        .. seealso:: :class:`FileStoreNameChooser`,
+                     :class:`DefaultFileStoreHandler`.
+        """
+        file_id = IFileStoreNameChooser(context).chooseName()
+        return self.getFile(file_id)
 
     def createFile(self, filename, f):