From e942636fbef8c8a7f799ac798597b99f003a038d Mon Sep 17 00:00:00 2001 From: Malcolm Tredinnick Date: Sat, 19 Jul 2008 22:26:46 +0000 Subject: [PATCH] Added a cavaet to the use of get_FOO_filename() and get_FOO_url(). This constraint has always existed, but it's very hard to fix in the current code, so better to work around it for now. Refs #5619 git-svn-id: http://code.djangoproject.com/svn/django/trunk@7999 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/db-api.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/db-api.txt b/docs/db-api.txt index 5fdcd946bdc..9d167a69dab 100644 --- a/docs/db-api.txt +++ b/docs/db-api.txt @@ -2280,6 +2280,12 @@ For every ``FileField``, the object will have a ``get_FOO_filename()`` method, where ``FOO`` is the name of the field. This returns the full filesystem path to the file, according to your ``MEDIA_ROOT`` setting. +.. note:: + If you are using the ``upload_to`` parameter in your ``FileField``, it is + only valid to call this method **after** saving the model when the field + has been set. Prior to saving, the value returned will not contain the + upload directory in the path. + Note that ``ImageField`` is technically a subclass of ``FileField``, so every model with an ``ImageField`` will also get this method. @@ -2291,6 +2297,12 @@ where ``FOO`` is the name of the field. This returns the full URL to the file, according to your ``MEDIA_URL`` setting. If the value is blank, this method returns an empty string. +.. note:: + As with ``get_FOO_filename()``, if you are using the ``upload_to`` + parameter on your ``FileField``, it is only valid to call this method + **after** saving the model, otherwise an incorrect result will be + returned. + get_FOO_size() --------------