Translation management models
These models are responsible for managing the translation of objects.
graph TD
A[TranslationSource] --> B[TranslatableObject]
C[Translation] --> A
D[TranslationLog] --> A
C --> E[wagtail.Locale]
A --> E
D --> E
A --> F[django.ContentType]
B --> F
style E stroke-dasharray: 5 5
style F stroke-dasharray: 5 5
TranslatableObject
Bases: models.Model
A TranslatableObject represents a set of instances of a translatable model that are all translations of each another.
In Wagtail, objects are considered translations of each other when they are
of the same content type and have the same translation_key
value.
Attributes:
Name | Type | Description |
---|---|---|
translation_key |
UUIDField
|
The translation_key that value that is used by the instances. |
content_type |
ForeignKey to ContentType
|
Link to the base Django content type representing the model that the
instances use. Note that this field refers to the model that has the |
Source code in wagtail_localize/models.py
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 |
|
get_instance(locale)
Returns a model instance for this object in the given locale.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale | int
|
Either a Locale object or an ID of a Locale. |
required |
Returns:
Name | Type | Description |
---|---|---|
Model |
The model instance. |
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
If there is not an instance of this object in the given locale. |
Source code in wagtail_localize/models.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
get_instance_or_none(locale)
Returns a model instance for this object in the given locale.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale | int
|
Either a Locale object or an ID of a Locale. |
required |
Returns:
Name | Type | Description |
---|---|---|
Model |
The model instance if one exists. |
|
None |
If the model doesn't exist. |
Source code in wagtail_localize/models.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
|
has_translation(locale)
Returns True if there is an instance of this object in the given Locale.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale | int
|
Either a Locale object or an ID of a Locale. |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
True if there is an instance of this object in the given locale. |
Source code in wagtail_localize/models.py
182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
TranslationSource
Bases: models.Model
Frozen source content that is to be translated.
This is like a page revision, except it can be created for any model and it's only created/updated when a user submits something for translation.
Attributes:
Name | Type | Description |
---|---|---|
object |
ForeignKey to TranslatableObject
|
The object that this is a source for |
specific_content_type |
ForeignKey to ContentType
|
The specific content type that this was extracted from.
Note that |
locale |
ForeignKey to Locale
|
The Locale of the instance that this source content was extracted from. |
object_repr |
TextField
|
A string representing the name of the source object. Used in the UI. |
content_json |
TextField with JSON contents
|
The serialized source content. Note that this is serialzed in the same way that Wagtail serializes page revisions. |
created_at |
DateTimeField
|
The date/time at which the content was first extracted from this source. |
last_updated_at |
DateTimeField
|
The date/time at which the content was last extracted from this source. |
Source code in wagtail_localize/models.py
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 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
|
_get_segments_for_translation(locale, fallback = False)
Returns a list of segments that can be passed into "ingest_segments" to translate an object.
Source code in wagtail_localize/models.py
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 |
|
as_instance()
Builds an instance of the object with the content of this source.
Returns:
Name | Type | Description |
---|---|---|
Model |
A model instance that has the content of this TranslationSource. |
Raises:
Type | Description |
---|---|
SourceDeletedError
|
if the source instance has been deleted. |
Source code in wagtail_localize/models.py
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
|
create_or_update_translation(locale, user = None, publish = True, copy_parent_pages = False, fallback = False)
Creates/updates a translation of the object into the specified locale based on the content of this source and the translated strings currently in translation memory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale
|
The target locale to generate the translation for. |
required |
user |
User
|
The user who is carrying out this operation. For logging purposes |
None
|
publish |
boolean
|
Set this to False to save a draft of the translation. Pages only. |
True
|
copy_parent_pages |
boolean
|
Set this to True to make copies of the parent pages if they are not yet translated. |
False
|
fallback |
boolean
|
Set this to True to fallback to source strings/related objects if they are not yet translated. By default, this will raise an error if anything is missing. |
False
|
Raises:
Type | Description |
---|---|
SourceDeletedError
|
if the source object has been deleted. |
CannotSaveDraftError
|
if the |
MissingTranslationError
|
if a translation is missing and |
MissingRelatedObjectError
|
if a related object is not translated and |
Returns:
Name | Type | Description |
---|---|---|
Model |
The translated instance. |
Source code in wagtail_localize/models.py
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 |
|
export_po()
Exports all translatable strings from this source.
Note that because there is no target locale, all msgstr
fields will be blank.
Returns:
Type | Description |
---|---|
polib.POFile: A POFile object containing the source translatable strings. |
Source code in wagtail_localize/models.py
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
|
get_ephemeral_translated_instance(locale, fallback = False)
Returns an instance with the translations added which is not intended to be saved.
This is used for previewing pages with draft translations applied.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale
|
The target locale to generate the ephemeral translation for. |
required |
fallback |
boolean
|
Set this to True to fallback to source strings/related objects if they are not yet translated. By default, this will raise an error if anything is missing. |
False
|
Raises:
Type | Description |
---|---|
SourceDeletedError
|
if the source object has been deleted. |
MissingTranslationError
|
if a translation is missing and |
MissingRelatedObjectError
|
if a related object is not translated and |
Returns:
Name | Type | Description |
---|---|---|
Model |
The translated instance with unsaved changes. |
Source code in wagtail_localize/models.py
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 |
|
get_or_create_from_instance(instance)
classmethod
Creates or gets a TranslationSource for the given instance.
This extracts the content from the given instance. Then stores it in a new TranslationSource instance if one doesn't already exist. If one does already exist, it returns the existing TranslationSource without changing it.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
instance |
Model that inherits TranslatableMixin
|
A Translatable model instance to find a TranslationSource instance for. |
required |
Returns:
Type | Description |
---|---|
tuple[TranslationSource, boolean]: A two-tuple, the first component is the TranslationSource object, and the second component is a boolean that is True if the TranslationSource was created. |
Source code in wagtail_localize/models.py
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
|
get_source_instance()
This gets the live version of instance that the source data was extracted from.
This is different to source.object.get_instance(source.locale) as the instance
returned by this methid will have the same model that the content was extracted
from. The model returned by object.get_instance
might be more generic since
that model only records the model that the TranslatableMixin was applied to but
that model might have child models.
Returns:
Name | Type | Description |
---|---|---|
Model |
The model instance that this TranslationSource was created from. |
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
If the source instance has been deleted. |
Source code in wagtail_localize/models.py
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
|
get_source_instance_edit_url()
Returns the URL to edit the source instance.
Source code in wagtail_localize/models.py
497 498 499 500 501 |
|
refresh_segments()
Updates the *Segment models to reflect the latest version of the source.
This is called by from_instance
so you don't usually need to call this manually.
Source code in wagtail_localize/models.py
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 |
|
schema_out_of_date()
Returns True if the app that contains the model this source was generated from has been updated since the source was last updated.
Source code in wagtail_localize/models.py
887 888 889 890 891 892 893 894 895 896 897 898 |
|
sync_view_restrictions(original, translation_page)
Synchronizes view restriction object for the translated page
Parameters:
Name | Type | Description | Default |
---|---|---|---|
original |
Page | Snippet
|
The original instance. |
required |
translation_page |
Page | Snippet
|
The translated instance. |
required |
Source code in wagtail_localize/models.py
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 |
|
update_from_db()
Retrieves the source instance from the database and updates this TranslationSource with its current contents.
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
If the source instance has been deleted. |
Source code in wagtail_localize/models.py
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
|
update_or_create_from_instance(instance)
classmethod
Creates or updates a TranslationSource for the given instance.
This extracts the content from the given instance. Then stores it in a new TranslationSource instance if one doesn't already exist. If one does already exist, it updates the existing TranslationSource.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
instance |
Model that inherits TranslatableMixin
|
A Translatable model instance to extract source content from. |
required |
Returns:
Type | Description |
---|---|
tuple[TranslationSource, boolean]: A two-tuple, the first component is the TranslationSource object, and the second component is a boolean that is True if the TranslationSource was created. |
Source code in wagtail_localize/models.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
|
update_target_view_restrictions(locale)
Creates a corresponding view restriction object for the translated page for the given locale
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale |
Locale
|
The target locale |
required |
Source code in wagtail_localize/models.py
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
|
Translation
Bases: models.Model
Manages the translation of an object into a locale.
An instance of this model is created whenever an object is submitted for translation into a new language.
They can be disabled at any time, and are deleted or disabled automatically if either the source or destination object is deleted.
If the translation of a page is disabled, the page editor of the translation would return to the normal Wagtail editor.
Attributes:
Name | Type | Description |
---|---|---|
uuid |
UUIDField
|
A unique ID for this translation used for referencing it from external systems. |
source |
ForeignKey to TranslationSource
|
The source that is being translated. |
target_locale |
ForeignKey to Locale
|
The Locale that the source is being translated into. |
created_at |
DateTimeField
|
The date/time the translation was started. |
translations_last_updated_at |
DateTimeField
|
The date/time of when a translated string was last updated. |
destination_last_updated_at |
DateTimeField
|
The date/time of when the destination object was last updated. |
enabled |
boolean
|
Whether this translation is enabled or not. |
Source code in wagtail_localize/models.py
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 |
|
export_po()
Exports all translatable strings with any translations that have already been made.
Returns:
Type | Description |
---|---|
polib.POFile: A POFile object containing the source translatable strings and any translations. |
Source code in wagtail_localize/models.py
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 |
|
get_progress()
Gets the current translation progress.
Returns tuple[int, int]: A two-tuple of integers. First integer is the total number of string segments to be translated. The second integer is the number of string segments that have been translated so far.
Source code in wagtail_localize/models.py
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 |
|
get_status_display()
Returns a string to describe the current status of this translation to a user.
Returns:
Name | Type | Description |
---|---|---|
str |
The status of this translation |
Source code in wagtail_localize/models.py
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 |
|
get_target_instance()
Fetches the translated instance from the database.
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
if the translation does not exist. |
Returns:
Name | Type | Description |
---|---|---|
Model |
The translated instance. |
Source code in wagtail_localize/models.py
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
|
get_target_instance_edit_url()
Returns the URL to edit the target instance.
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
if the translation does not exist. |
Returns:
Name | Type | Description |
---|---|---|
str |
The URL of the edit view of the target instance. |
Source code in wagtail_localize/models.py
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 |
|
import_po(po, delete = False, user = None, translation_type = 'manual', tool_name = '')
Imports all translatable strings with any translations that have already been made.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
po |
polib.POFile
|
A POFile object containing the source translatable strings and any translations. |
required |
delete |
boolean
|
Set to True to delete any translations that do not appear in the PO file. |
False
|
user |
User
|
The user who is performing this operation. Used for logging purposes. |
None
|
translation_type |
manual or machine
|
Whether the translationw as performed by a human or machine. Defaults to 'manual'. |
'manual'
|
tool_name |
string
|
The name of the tool that was used to perform the translation. Defaults to ''. |
''
|
Returns:
Type | Description |
---|---|
list[POImportWarning]: A list of POImportWarning objects representing any non-fatal issues that were |
|
encountered while importing the PO file. |
Source code in wagtail_localize/models.py
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 |
|
save_target(user = None, publish = True)
Saves the target page/snippet using the current translations.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user |
User
|
The user that is performing this action. Used for logging purposes. |
None
|
publish |
boolean
|
Set this to False to save a draft of the translation. Pages only. |
True
|
Raises:
Type | Description |
---|---|
SourceDeletedError
|
if the source object has been deleted. |
CannotSaveDraftError
|
if the |
MissingTranslationError
|
if a translation is missing and |
MissingRelatedObjectError
|
if a related object is not translated and |
Returns:
Name | Type | Description |
---|---|---|
Model |
The translated instance. |
Source code in wagtail_localize/models.py
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 |
|
TranslationLog
Bases: models.Model
Keeps Track of when translations are created/updated.
Attributes:
Name | Type | Description |
---|---|---|
source |
ForeignKey to TranslationSource
|
The source that was used for translation. |
locale |
ForeignKey to Locale
|
The Locale that the source was translated into. |
created_at |
DateTimeField
|
The date/time the translation was done. |
page_revision |
ForeignKey to PageRevision
|
If the translation was of a page, this links to the PageRevision that was created |
Source code in wagtail_localize/models.py
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
|
get_instance()
Gets the instance of the translated object, if it still exists.
Raises:
Type | Description |
---|---|
Model.DoesNotExist
|
if the translated object no longer exists. |
Returns:
Type | Description |
---|---|
The translated object. |
Source code in wagtail_localize/models.py
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
|