summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdrian Holovaty <adrian@holovaty.com>2008-04-30 00:03:45 +0000
committerAdrian Holovaty <adrian@holovaty.com>2008-04-30 00:03:45 +0000
commit1dee30919855790484d0e5ecbce9bafe4ea0b355 (patch)
treefb6e1dba935cf1979c09dcbb282befab5178c9bf /docs
parentdb6bab5cb385e53570ec768892d6882708d8feb4 (diff)
Added 'Setting headers' and 'Telling the browser to treat the response as a file attachment' sections to docs/request_response.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7510 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/request_response.txt23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/request_response.txt b/docs/request_response.txt
index a4f03b9185..866a697e31 100644
--- a/docs/request_response.txt
+++ b/docs/request_response.txt
@@ -402,6 +402,27 @@ hard-coded strings. If you use this technique, follow these guidelines:
content, you can't use the ``HttpResponse`` instance as a file-like
object. Doing so will raise ``Exception``.
+Setting headers
+~~~~~~~~~~~~~~~
+
+To set a header in your response, just treat it like a dictionary::
+
+ >>> response = HttpResponse()
+ >>> response['Pragma'] = 'no-cache'
+
+Telling the browser to treat the response as a file attachment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To tell the browser to treat the response as a file attachment, use the
+``mimetype`` argument and set the ``Content-Disposition`` header. For example,
+this is how you might return a Microsoft Excel spreadsheet::
+
+ >>> response = HttpResponse(my_data, mimetype='application/vnd.ms-excel')
+ >>> response['Content-Disposition'] = 'attachment; filename=foo.xls'
+
+There's nothing Django-specific about the ``Content-Disposition`` header, but
+it's easy to forget the syntax, so we've included it here.
+
Methods
-------
@@ -420,7 +441,7 @@ Methods
but since this is actually the value included in the HTTP ``Content-Type``
header, it can also include the character set encoding, which makes it
more than just a MIME type specification. If ``mimetype`` is specified
- (not None), that value is used. Otherwise, ``content_type`` is used. If
+ (not ``None``), that value is used. Otherwise, ``content_type`` is used. If
neither is given, the ``DEFAULT_CONTENT_TYPE`` setting is used.
``__setitem__(header, value)``