Sample use of lazy in delayed translations is not valid in Django 4.1 and 4.2.

[Stefan Hammer]

The sample code to mark a lazy translation as "safe" in the docs ​here seems to be invalid since Django 4.1 (#20296).

We're in the process of upgrading a Django 3.2 installation to Django 4.2 and we've used this utility mark_safe_lazy from the sample in our code. This code now produces the error __str__ returned non-string (type __proxy__) when rendering such a value in the templates.

The fix seems to simply use Django's mark_safe(gettext_lazy(...)) instead of this custom helper.

[Mariusz Felisiak]

It was fixed in Django 5.0 (check out 066aabcb77579cf8d549119c860d11cd15e3eef1). Would you like to prepare a patch? (targeted to the stable/4.2.x).

[Stefan Hammer]

Thanks for the information. I'm also happy that someone assigned itself to this, because this would be my first contribution and that would take some time...

But just to be sure: the sample would work in Django 5.0 due to the fix you've mentioned, but this whole ​docs block could actually be removed for Django >=4.1, because since then mark_safe() preserves lazy objects and therefore a custom helper like that mark_safe_lazy() isn't required anymore. Right?

[Mariusz Felisiak]

Replying to Stefan Hammer:

But just to be sure: the sample would work in Django 5.0 due to the fix you've mentioned, but this whole ​docs block could actually be removed for Django >=4.1, because since then mark_safe() preserves lazy objects and therefore a custom helper like that mark_safe_lazy() isn't required anymore. Right?

This example could stay but with a different function, or maybe it's not worth keeping 🤷 Originally it was reported for mark_safe(). What do you think, Claude?

[Claude Paroz]

I think we might keep the section by using any string-related method of the standard lib, like isascii() for example.

[Lufafa Joshua]

​PR

[Sarah Boyce <42296566+sarahboyce@…>]

In 136a5f94:

Fixed #34886 -- Modified sample use of lazy in delayed translations.

Modified example to use python standard library function
to lower the case of the string.

[Sarah Boyce <42296566+sarahboyce@…>]

In c833cb3:

[5.1.x] Fixed #34886 -- Modified sample use of lazy in delayed translations.

Modified example to use python standard library function
to lower the case of the string.

Backport of 136a5f94099e428dd57572ebd16905fb25ef227e from main.

[Sarah Boyce <42296566+sarahboyce@…>]

In 3a4a4497:

[5.0.x] Fixed #34886 -- Modified sample use of lazy in delayed translations.

Modified example to use python standard library function
to lower the case of the string.

Backport of 136a5f94099e428dd57572ebd16905fb25ef227e from main.