Browse files

Fixed #8848: clarified custom file storage backend docs in light of …

…the more clear code comments.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
jacobian committed Sep 3, 2008
1 parent 5697f87 commit 62fc1553433b6b962ebf40d08f85a252de728af9
Showing with 12 additions and 2 deletions.
  1. +12 −2 docs/howto/custom-file-storage.txt
@@ -3,6 +3,8 @@
Writing a custom storage system
+.. currentmodule::
If you need to provide custom file storage -- a common example is storing files
on some remote system -- you can do so by defining a custom storage class.
You'll need to follow these steps:
@@ -35,8 +37,16 @@ You'll need to follow these steps:
the ``path()`` method.
Your custom storage system may override any of the storage methods explained in
-:ref:`ref-files-storage`. However, it's usually better to use the hooks
-specifically designed for custom storage objects. These are:
+:ref:`ref-files-storage`, but you **must** implement the following methods:
+ * :meth:`Storage.delete`
+ * :meth:`Storage.exists`
+ * :meth:`Storage.listdir`
+ * :meth:`Storage.size`
+ * :meth:`Storage.url`
+You'all also usually want to use hooks specifically designed for custom storage
+objects. These are:
``_open(name, mode='rb')``

0 comments on commit 62fc155

Please sign in to comment.