1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
from django.utils import translation
from parler.models import TranslationDoesNotExist
from .testapp.models import AnyLanguageModel, EmptyModel, NotRequiredModel, SimpleModel
from .utils import AppTestCase
class ModelAttributeTests(AppTestCase):
"""
Test model construction
"""
def test_untranslated_get(self):
"""
Test the metaclass of the model.
"""
try:
value = SimpleModel().tr_title
except Exception as e:
self.assertIsInstance(e, TranslationDoesNotExist)
self.assertIsInstance(e, AttributeError)
else:
self.fail(f"Expected exception from reading untranslated title, got {repr(value)}.")
# Raising attribute error gives some additional benefits:
self.assertEqual(getattr(SimpleModel(), "tr_title", "FOO"), "FOO")
self.assertFalse(hasattr(SimpleModel(), "tr_title"))
def test_default_language(self):
"""
Test whether simple language assignments work.
"""
with translation.override("ca-fr"):
x = SimpleModel(
id=99
) # uses get_language(), ID is to avoid reading cached items for 'en'
self.assertEqual(x.get_current_language(), translation.get_language())
self.assertEqual(translation.get_language(), "ca-fr")
x.shared = "SHARED"
x.tr_title = "TRANS_CA"
x.save()
# Refetch
with translation.override("en"):
x = SimpleModel.objects.get(pk=x.pk)
self.assertRaises(TranslationDoesNotExist, lambda: x.tr_title)
# Switch context
x.set_current_language("ca-fr")
self.assertEqual(x.tr_title, "TRANS_CA")
def test_get_language(self):
"""
See how ``.language().get()`` works.
"""
with translation.override("fr"):
# Despite being
# Initialize form in other language.
x = SimpleModel(shared="SHARED", tr_title="TRANS", _current_language="nl")
self.assertEqual(x.get_current_language(), "nl")
x.save()
x2 = SimpleModel.objects.language("nl").get(pk=x.pk)
self.assertEqual(x2.get_current_language(), "nl")
self.assertEqual(x2.shared, "SHARED")
self.assertEqual(x2.tr_title, "TRANS")
def test_init_args(self):
"""
Test whether passing translated attributes to __init__() works.
"""
x = SimpleModel(tr_title="TRANS_TITLE")
self.assertEqual(x.tr_title, "TRANS_TITLE")
y = SimpleModel(tr_title="TRANS_TITLE", _current_language="nl")
self.assertEqual(y.get_current_language(), "nl")
self.assertEqual(y.tr_title, "TRANS_TITLE")
def test_create_args(self):
y = SimpleModel.objects.language("nl").create(tr_title="TRANS_TITLE")
self.assertEqual(y.get_current_language(), "nl")
self.assertEqual(y.tr_title, "TRANS_TITLE")
def test_save_multiple(self):
"""
Test the save_translations() function to store multiple languages.
"""
x = SimpleModel()
x.set_current_language("en")
x.tr_title = "TITLE_EN"
x.set_current_language("fr")
x.tr_title = "TITLE_FR"
x.set_current_language("es")
x.tr_title = "TITLE_ES"
x.set_current_language("nl")
x.tr_title = "TITLE_NL"
x.save()
# Check if all translations are saved.
self.assertEqual(
sorted(x.translations.values_list("tr_title", flat=True)),
["TITLE_EN", "TITLE_ES", "TITLE_FR", "TITLE_NL"],
)
self.assertEqual(sorted(x.get_available_languages()), ["en", "es", "fr", "nl"])
self.assertTrue(x.has_translation("en"))
self.assertTrue(x.has_translation("es"))
self.assertFalse(x.has_translation("fi"))
# Update 2 translations.
# Only those should be updated in the database.
x.set_current_language("es")
x.tr_title = "TITLE_ES2"
x.set_current_language("nl")
x.tr_title = "TITLE_NL2"
self.assertNumQueries(2, x.save_translations())
# Even unmodified language is automatically saved.
x.set_current_language("it", initialize=True)
self.assertTrue(x.has_translation("it")) # does return true for this object.
self.assertNumQueries(1, lambda: x.save_translations())
self.assertEqual(sorted(x.get_available_languages()), ["en", "es", "fr", "it", "nl"])
def test_empty_model(self):
"""
Test whether a translated model without any fields still works.
"""
x = EmptyModel()
x.set_current_language("en", initialize=True)
x.set_current_language("fr", initialize=True)
x.set_current_language("es")
x.set_current_language("nl", initialize=True)
x.save()
self.assertEqual(sorted(x.get_available_languages()), ["en", "fr", "nl"])
def test_create_translation(self):
x = SimpleModel.objects.create()
x.create_translation("en", tr_title="TITLE_EN")
x.create_translation("fr", tr_title="TITLE_FR")
self.assertEqual(sorted(x.get_available_languages()), ["en", "fr"])
def test_delete_translation(self):
x = SimpleModel.objects.create(pk=1000)
x.create_translation("en", tr_title="TITLE_EN")
x.create_translation("fr", tr_title="TITLE_FR")
self.assertEqual(sorted(x.get_available_languages()), ["en", "fr"])
num_deleted = x.delete_translation("fr")
self.assertEqual(num_deleted, 1)
self.assertEqual(sorted(x.get_available_languages()), ["en"])
def test_delete_return(self):
x = SimpleModel.objects.create()
x.create_translation("en", tr_title="TITLE_EN")
expect = (2, {"testapp.SimpleModelTranslation": 1, "testapp.SimpleModel": 1})
self.assertEqual(x.delete(), expect)
def test_fallback_language(self):
"""
Test whether the fallback language will be returned.
"""
x = SimpleModel()
x.set_current_language(self.conf_fallback)
x.tr_title = "TITLE_FALLBACK"
x.set_current_language(self.other_lang1)
x.tr_title = "TITLE_XX"
x.save()
with translation.override(self.other_lang2):
x = SimpleModel.objects.get(pk=x.pk)
self.assertEqual(x.tr_title, "TITLE_FALLBACK")
def test_fallback_variant(self):
"""Test de-us falls back to de"""
x = SimpleModel()
x.set_current_language("de")
x.tr_title = "Hallo-de"
x.set_current_language("en")
x.tr_title = "Hello-en"
x.save()
with translation.override("de-ch"):
x = SimpleModel.objects.get(pk=x.pk)
self.assertEqual(x.tr_title, "Hallo-de")
def test_fallback_language_no_current(self):
"""
Test whether the fallback language will be returned,
even when the current language does not have a translation.
"""
x = SimpleModel()
x.set_current_language(self.conf_fallback)
x.tr_title = "TITLE_FALLBACK"
self.assertEqual(
x.safe_translation_getter("tr_title", language_code=self.other_lang1), "TITLE_FALLBACK"
)
def test_any_fallback_model(self):
"""
Test whether a failure in the fallback language can return any saved language (if configured for it).
"""
x = AnyLanguageModel()
x.set_current_language(self.other_lang1)
x.tr_title = "TITLE_XX"
x.save()
with translation.override(self.other_lang2):
x = AnyLanguageModel.objects.get(pk=x.pk)
self.assertRaises(
TranslationDoesNotExist, lambda: x._get_translated_model(use_fallback=True)
)
self.assertEqual(
x.tr_title, "TITLE_XX"
) # Even though there is no current language, there is a value.
self.assertNumQueries(
0, lambda: x._get_any_translated_model()
) # Can fetch from cache next time.
self.assertEqual(x._get_any_translated_model().language_code, self.other_lang1)
def test_any_fallback_function(self):
x = SimpleModel()
x.set_current_language(self.other_lang1)
x.tr_title = "TITLE_XX"
x.save()
with translation.override(self.other_lang2):
x = SimpleModel.objects.get(pk=x.pk)
self.assertRaises(
TranslationDoesNotExist, lambda: x._get_translated_model(use_fallback=True)
)
self.assertIs(
x.safe_translation_getter("tr_title", "DEFAULT"), "DEFAULT"
) # No lanuage, gives default
self.assertEqual(
x.safe_translation_getter("tr_title", any_language=True), "TITLE_XX"
) # Even though there is no current language, there is a value.
self.assertNumQueries(
0, lambda: x._get_any_translated_model()
) # Can fetch from cache next time.
self.assertEqual(x._get_any_translated_model().language_code, self.other_lang1)
def test_create_without_translation(self):
"""
Test whether master object is created without translation, in case that no translation attribute is set
"""
x = NotRequiredModel()
self.assertNumQueries(1, lambda: x.save()) # only master object created
self.assertEqual(sorted(x.get_available_languages()), [])
def test_create_with_default_attributes(self):
"""
Test whether translation model is created even attribute has default value
"""
x = NotRequiredModel()
x.tr_title = "DEFAULT_TRANS_TITLE"
self.assertNumQueries(2, lambda: x.save()) # master and translation object created
self.assertEqual(sorted(x.get_available_languages()), [self.conf_fallback])
def test_save_ignore_fallback_marker(self):
"""
Test whether the ``save_translations()`` method skips fallback languages
"""
x = SimpleModel()
x.set_current_language(self.other_lang1)
x.tr_title = "TITLE_XX"
x.set_current_language(self.other_lang2)
# try fetching, causing an fallback marker
x.safe_translation_getter("tr_title", any_language=True)
# Now save. This should not raise errors
x.save()
def test_model_with_zero_pk(self):
"""
tests that the translated model is returned also when the pk is 0
"""
x = SimpleModel()
x.set_current_language(self.other_lang1)
x.pk = 0
x.tr_title = "EMPTY_PK"
x.save()
# now fetch it from db
try:
SimpleModel.objects.get(pk=x.pk)
except TranslationDoesNotExist:
self.fail("zero pk is not supported!")
def test_translatedfieldsmodel_str(self):
"""Test converting TranslatedFieldsModel to string"""
missing_language_code = "xx"
obj = SimpleModel.objects.create(tr_title="Something")
# Adjust translation object to use language_code that is not
# configured. It is easier because various Django version behave
# differently if we try to use not configured language.
translation = obj.translations.get()
translation.language_code = missing_language_code
translation.save()
# Try to get str() of the TranslatedFieldsModel instance.
try:
translation_as_str = str(obj.translations.get())
except KeyError:
self.fail("Converting translation to string raises KeyError")
# Check that we get language code as a fallback, when language is
# not configured.
self.assertEqual(translation_as_str, missing_language_code)
def test_get_or_create_no_defaults(self):
y, created = SimpleModel.objects.language("nl").get_or_create(shared="XYZ")
self.assertTrue(created)
self.assertEqual(y.get_current_language(), "nl")
self.assertRaises(TranslationDoesNotExist, lambda: y.tr_title)
def test_get_or_create_defaults(self):
y, created = SimpleModel.objects.language("nl").get_or_create(
shared="XXX", defaults={"tr_title": "TRANS_TITLE"}
)
self.assertTrue(created)
self.assertEqual(y.get_current_language(), "nl")
self.assertEqual(y.tr_title, "TRANS_TITLE")
|
