p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #19310 -- changed method docs formatting for custom file storage docs

This commit is contained in:
Preston Holmes 2012-11-17 07:05:34 -08:00
parent f79013843d
commit 7a38e86bde
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/howto/custom-file-storage.txt
View File

@ -27,9 +27,9 @@ You'll need to follow these steps:
option = settings.CUSTOM_STORAGE_OPTIONS option = settings.CUSTOM_STORAGE_OPTIONS
... ...
#. Your storage class must implement the ``_open()`` and ``_save()`` methods, #. Your storage class must implement the :meth:`_open()` and :meth:`_save()
along with any other methods appropriate to your storage class. See below for methods, along with any other methods appropriate to your storage class. See
more on these methods. below for more on these methods.
In addition, if your class provides local file storage, it must override In addition, if your class provides local file storage, it must override
the ``path()`` method. the ``path()`` method.
@ -46,8 +46,7 @@ Your custom storage system may override any of the storage methods explained in
You'll also usually want to use hooks specifically designed for custom storage You'll also usually want to use hooks specifically designed for custom storage
objects. These are: objects. These are:
``_open(name, mode='rb')`` .. method:: _open(name, mode='rb')
~~~~~~~~~~~~~~~~~~~~~~~~~~
**Required**. **Required**.
@ -56,8 +55,7 @@ uses to open the file. This must return a ``File`` object, though in most cases,
you'll want to return some subclass here that implements logic specific to the you'll want to return some subclass here that implements logic specific to the
backend storage system. backend storage system.
``_save(name, content)`` .. method:: _save(name, content)
~~~~~~~~~~~~~~~~~~~~~~~~
Called by ``Storage.save()``. The ``name`` will already have gone through Called by ``Storage.save()``. The ``name`` will already have gone through
``get_valid_name()`` and ``get_available_name()``, and the ``content`` will be a ``get_valid_name()`` and ``get_available_name()``, and the ``content`` will be a
@ -67,8 +65,8 @@ Should return the actual name of name of the file saved (usually the ``name``
passed in, but if the storage needs to change the file name return the new name passed in, but if the storage needs to change the file name return the new name
instead). instead).
``get_valid_name(name)`` .. method:: get_valid_name(name)
~~~~~~~~~~~~~~~~~~~~~~~~
Returns a filename suitable for use with the underlying storage system. The Returns a filename suitable for use with the underlying storage system. The
``name`` argument passed to this method is the original filename sent to the ``name`` argument passed to this method is the original filename sent to the
@ -78,8 +76,7 @@ how non-standard characters are converted to safe filenames.
The code provided on ``Storage`` retains only alpha-numeric characters, periods The code provided on ``Storage`` retains only alpha-numeric characters, periods
and underscores from the original filename, removing everything else. and underscores from the original filename, removing everything else.
``get_available_name(name)`` .. method:: get_available_name(name)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Returns a filename that is available in the storage mechanism, possibly taking Returns a filename that is available in the storage mechanism, possibly taking
the provided filename into account. The ``name`` argument passed to this method the provided filename into account. The ``name`` argument passed to this method