From 84ef4a9b1decce8e319359a018eef46a9556b630 Mon Sep 17 00:00:00 2001 From: James Bennett Date: Sun, 31 Aug 2008 10:37:44 +0000 Subject: [PATCH] Fixed #8641: Documented the fact that file-saving methods must receive a File instance git-svn-id: http://code.djangoproject.com/svn/django/trunk@8759 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/files/file.txt | 3 +++ docs/ref/files/storage.txt | 4 ++++ docs/topics/files.txt | 3 ++- 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/ref/files/file.txt b/docs/ref/files/file.txt index bc59311792..aa037f7c2a 100644 --- a/docs/ref/files/file.txt +++ b/docs/ref/files/file.txt @@ -110,6 +110,9 @@ 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`. + ``File.delete(save=True)`` ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/ref/files/storage.txt b/docs/ref/files/storage.txt index a09cd2f86d..0ca577059e 100644 --- a/docs/ref/files/storage.txt +++ b/docs/ref/files/storage.txt @@ -42,6 +42,10 @@ If there already exists a file with this name ``name``, the storage system may modify the filename as necessary to get a unique name. The actual name of the stored file will be returned. +The ``content`` argument must be an instance of +:class:`django.db.files.File` or of a subclass of +:class:`~django.db.files.File`. + ``Storage.delete(name)`` ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/topics/files.txt b/docs/topics/files.txt index dabee7dacb..d17af99c48 100644 --- a/docs/topics/files.txt +++ b/docs/topics/files.txt @@ -96,8 +96,9 @@ You can create an instance of some custom file storage class, or -- often more useful -- you can use the global default storage system:: >>> from django.core.files.storage import default_storage + >>> from django.core.files.base import ContentFile - >>> path = default_storage.save('/path/to/file', 'new content') + >>> path = default_storage.save('/path/to/file', ContentFile('new content')) >>> path u'/path/to/file'