Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.2.X] Fixed #14762 - Add documention for ContentFile. Thanks jesh f…

…or the suggestion and adamv for the patch.

Backport of r14742 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14743 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 57c55c69f8c16258f927c79415a4b8f7918679a3 1 parent 1dd9c9c
@timgraham timgraham authored
Showing with 21 additions and 8 deletions.
  1. +21 −8 docs/ref/files/file.txt
View
29 docs/ref/files/file.txt
@@ -29,7 +29,7 @@ methods:
The URL where the file can be retrieved. This is often useful in
:doc:`templates </topics/templates>`; for example, a bit of a template for
displaying a ``Car`` (see above) might look like:
-
+
.. code-block:: html+django
<img src='{{ car.photo.url }}' alt='{{ car.name }}' />
@@ -81,13 +81,13 @@ methods:
.. currentmodule:: django.core.files.images
-Additional ``ImageField`` attributes
+Additional ``ImageFile`` attributes
------------------------------------
.. class:: ImageFile(file_object)
.. attribute:: width
-
+
Width of the image.
.. attribute:: height
@@ -108,18 +108,31 @@ above) will also have a couple of extra methods:
replace the existing file, but will create a new file and update the object
to point to it. If ``save`` is ``True``, the model's ``save()`` method will
be called once the file is saved. That is, these two lines::
-
+
>>> car.photo.save('myphoto.jpg', contents, save=False)
>>> car.save()
-
+
are the same as this one line::
-
+
>>> car.photo.save('myphoto.jpg', contents, save=True)
-
+
Note that the ``content`` argument must be an instance of
- :class:`File` or of a subclass of :class:`File`.
+ :class:`File` or of a subclass of :class:`File` such as :class:`ContentFile`.
.. method:: File.delete([save=True])
Remove the file from the model instance and delete the underlying file. The
``save`` argument works as above.
+
+``ContentFile`` objects
+-----------------------
+
+.. class:: ContentFile(File)
+
+A ``ContentFile`` is a File-like object that takes string content, rather
+than an actual file::
+
+ from django.core.files.base import ContentFile
+
+ f1 = ContentFile("my string content")
+ f2 = ContentFile(u"my unicode content encoded as UTF-8".encode('UTF-8'))
Please sign in to comment.
Something went wrong with that request. Please try again.