Browse files

[1.0.X] Fixed #8768 -- Clarified that ugettext_lazy() results are uni…


proxies and can't be used as bytestrings.

Still a number of markup changes to be made in this file (and in this
changeset). That's intentional for now, since I'm going to rewrite the file
later this week.

Backport of r9168 from trunk.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
malcolmt committed Oct 6, 2008
1 parent 82a01a6 commit f4a57bedd8c833b3fb12e646a031639db0d9e423
Showing with 20 additions and 1 deletion.
  1. +20 −1 docs/topics/i18n.txt
@@ -174,7 +174,26 @@ For example, to translate a model's ``help_text``, do the following::
In this example, ``ugettext_lazy()`` stores a lazy reference to the string --
not the actual translation. The translation itself will be done when the string
-is used in a string context, such as template rendering on the Django admin site.
+is used in a string context, such as template rendering on the Django admin
+The result of a ``ugettext_lazy()`` call can be used wherever you would use a
+unicode string (an object with type ``unicode``) in Python. If you try to use
+it where a bytestring (a ``str`` object) is expected, things will not work as
+expected, since a ``ugettext_lazy()`` object doesn't know how to convert
+itself to a bytestring. You can't use a unicode string inside a bytestring,
+either, so this is consistent with normal Python behavior. For example::
+ # This is fine: putting a unicode proxy into a unicode string.
+ u"Hello %s" % ugettext_lazy("people")
+ # This will not work, since you cannot insert a unicode object
+ # into a bytestring (nor can you insert our unicode proxy there)
+ "Hello %s" % ugettext_lazy("people")
+If you ever see output that looks like ``"hello
+<django.utils.functional...>"``, you have tried to insert the result of
+``ugettext_lazy()`` into a bytestring. That's a bug in your code.
If you don't like the verbose name ``ugettext_lazy``, you can just alias it as
``_`` (underscore), like so::

0 comments on commit f4a57be

Please sign in to comment.