Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[1.2.X] Fixed #14777 -- Added docs on working around the Python CSV m…

…odule's lack of Unicode support. Thanks to adamv for the report and draft patch.

Backport of [14749] from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14750 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 3d07bb71c6ffc225e6d3a32975f6855b2561e85a 1 parent 3c951d9
Gabriel Hurley authored
Showing with 25 additions and 2 deletions.
  1. +25 −2 docs/howto/outputting-csv.txt
View
27 docs/howto/outputting-csv.txt
@@ -56,12 +56,35 @@ mention:
about escaping strings with quotes or commas in them. Just pass
``writerow()`` your raw strings, and it'll do the right thing.
+Handling Unicode
+~~~~~~~~~~~~~~~~
+
+Python's ``csv`` module does not support Unicode input. Since Django uses
+Unicode internally this means strings read from sources such as
+:class:`~django.http.HttpRequest` are potentially problematic. There are a few
+options for handling this:
+
+ * Manually encode all Unicode objects to a compatible encoding.
+
+ * Use the ``UnicodeWriter`` class provided in the `csv module's examples
+ section`_.
+
+ * Use the `python-unicodecsv module`_, which aims to be a drop-in
+ replacement for ``csv`` that gracefully handles Unicode.
+
+For more information, see the Python `CSV File Reading and Writing`_
+documentation.
+
+.. _`csv module's examples section`: http://docs.python.org/library/csv.html#examples
+.. _`python-unicodecsv module`: https://github.com/jdunck/python-unicodecsv
+.. _`CSV File Reading and Writing`: http://docs.python.org/library/csv.html
+
Using the template system
=========================
Alternatively, you can use the :doc:`Django template system </topics/templates>`
-to generate CSV. This is lower-level than using the convenient CSV, but the
-solution is presented here for completeness.
+to generate CSV. This is lower-level than using the convenient Python ``csv``
+module, but the solution is presented here for completeness.
The idea here is to pass a list of items to your template, and have the
template output the commas in a :ttag:`for` loop.
Please sign in to comment.
Something went wrong with that request. Please try again.