Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Admin translations #21

Merged
merged 10 commits into from
Nov 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ Alphabetical list of contributors:
* Клёцкина Антонина(@SPELLGIRL)
* Ракитин Алексей ()
* Stolpasov Maksim (MaxST)

With support from:
* Maxim Danilov (Danilovmy)
Binary file modified docs/diagrams/struct.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 3 additions & 6 deletions docs/diagrams/struct.uml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,8 @@ package models.py <<Database>> {
}

abstract class TranslationsFieldsMixin {
# _field_tof : Dict
+ {field} _translations : GenericRelation('Translations')
+ __init__()
+ __getattribute__(attr)
+ __setattr__(name, value)
# {method} _all_translations : cached_property Dict
+ save()
+ _add_deferred_translated_field(name) : classmethod
Expand Down Expand Up @@ -51,15 +48,15 @@ package query_utils.py <<Rectangle>>{
class DeferredTranslatedAttribute {
field
__init__(field)
get(instance)
__get__(instance)
get_translation(instance=None, field_name=None, language=None)
get_fallback_languages(lang) : lru_cache(maxsize=32)
get_lang(is_obj=False)
get_field_name(ct=None)
get_trans_field_name()
set_val(instance, value)
__set__(instance, value)
save(instance)

__delete__(instance)
}
}

Expand Down
5 changes: 4 additions & 1 deletion example_project/example/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@

from main.views import Index

urlpatterns = i18n_patterns(path('admin/', admin.site.urls), path('', Index.as_view()))
urlpatterns = i18n_patterns(
path('admin/', admin.site.urls),
path('', Index.as_view()),
)

if settings.DEBUG:
if 'debug_toolbar' in settings.INSTALLED_APPS:
Expand Down
4 changes: 3 additions & 1 deletion example_project/main/admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
# @Author: MaxST
# @Date: 2019-10-28 20:30:42
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-05 13:37:33
# @Last Modified time: 2019-11-11 18:28:30
from django.contrib import admin

from .models import Wine


@admin.register(Wine)
class WineAdmin(admin.ModelAdmin):
list_display = ('title', 'description', 'active', 'sort')
search_fields = ('title', )
6 changes: 4 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# @Author: MaxST
# @Date: 2019-10-28 20:17:20
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-07 14:28:57
# @Last Modified time: 2019-11-12 22:07:50
from setuptools import find_packages, setup

import tof
Expand All @@ -27,12 +27,14 @@
# 'Django==3.0b1',
# ],
classifiers=[
'Development Status :: 1 - Planning',
'Development Status :: 2 - Pre-Alpha',
'Framework :: Django',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Topic :: Database',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
'Topic :: Text Processing :: Linguistic',
Expand Down
57 changes: 55 additions & 2 deletions tof/admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,62 @@
# @Author: MaxST
# @Date: 2019-10-28 12:30:45
# @Last Modified by: MaxST
# @Last Modified time: 2019-10-29 16:49:25
# @Last Modified time: 2019-11-12 21:15:47
from django.contrib import admin
from django.http import Http404, JsonResponse
from django.urls import reverse

from .forms import TranslationsForm
from .models import Language, TranslatableFields, Translations

admin.site.register((Language, Translations, TranslatableFields))

@admin.register(Language)
class AdminLanguage(admin.ModelAdmin):
search_fields = ('iso_639_1', )


@admin.register(TranslatableFields)
class AdminTranslatableFields(admin.ModelAdmin):
search_fields = ('name', 'title')

def delete_queryset(self, request, queryset):
for obj in queryset:
obj.delete()


@admin.register(Translations)
class AdminTranslations(admin.ModelAdmin):
form = TranslationsForm
list_display = ('content_object', 'lang', 'field', 'value')
list_filter = ('content_type', )
fieldsets = ((None, {
'fields': (
('field', 'lang'),
'object_id',
'value',
),
}), (
'hidden',
{
'classes': ('hidden', ),
'fields': ('content_type', ),
},
))
autocomplete_fields = ('field', 'lang')
url_name = '%s:%s_%s_autocomplete'

def _changeform_view(self, request, object_id, form_url, extra_context):
fld_id = request.GET.get('field_id')
id_obj = request.GET.get('id_obj')
if fld_id:
try:
ct = TranslatableFields.objects.get(id=fld_id).content_type
model = ct.model_class()
return JsonResponse({
'pk': ct.pk,
'url': reverse(self.url_name % (self.admin_site.name, model._meta.app_label, model._meta.model_name)),
'text': str(model.objects.get(pk=id_obj)) if id_obj else '',
})
except Exception:
return Http404('Error get content type')
return super()._changeform_view(request, object_id, form_url, extra_context)
10 changes: 3 additions & 7 deletions tof/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# @Author: MaxST
# @Date: 2019-10-29 10:05:01
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-07 17:28:26
# @Last Modified time: 2019-11-12 13:54:19
from django.apps import AppConfig
from django.db import connection
from django.db.models import F
Expand All @@ -29,12 +29,8 @@ def ready(self):
except Exception:
return

prev = None
for ct in ContentType.objects.filter(translatablefields__isnull=False).annotate(attr=F('translatablefields__name')):
if prev != ct:
prev = ct
cls = ct.model_class()
if issubclass(cls, TranslationsFieldsMixin):
continue
cls = ct.model_class()
if not issubclass(cls, TranslationsFieldsMixin):
cls.__bases__ = (TranslationsFieldsMixin, ) + cls.__bases__
cls._add_deferred_translated_field(ct.attr)
11 changes: 11 additions & 0 deletions tof/forms.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# @Author: MaxST
# @Date: 2019-11-09 13:47:17
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-09 13:58:42
from django import forms


class TranslationsForm(forms.ModelForm):
class Media:
js = ('tof/js/translation_form.js', )
35 changes: 16 additions & 19 deletions tof/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
# @Author: MaxST
# @Date: 2019-10-23 17:24:33
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-07 17:47:00
# @Last Modified time: 2019-11-11 16:16:26
from django.contrib.contenttypes.fields import (
GenericForeignKey, GenericRelation,
)
from django.contrib.contenttypes.models import ContentType
from django.db import models
from django.db.models import Q
from django.utils.functional import cached_property
from django.utils.translation import gettext_lazy as _

Expand All @@ -23,8 +24,8 @@ class Meta:
verbose_name_plural = _('Translations')
unique_together = ('content_type', 'object_id', 'field', 'lang')

content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
object_id = models.PositiveIntegerField()
content_type = models.ForeignKey(ContentType, limit_choices_to=~Q(app_label='tof'), on_delete=models.CASCADE)
object_id = models.PositiveIntegerField(help_text=_('First set the field'))
content_object = GenericForeignKey()

field = models.ForeignKey('TranslatableFields', related_name='translations', on_delete=models.CASCADE)
Expand All @@ -40,33 +41,21 @@ def __str__(self):
Returns:
str
"""
return f'Translations(content_object={self.content_object}, name={self.field.name}, value={self.value}, lang={self.lang})'
return f'{self.content_object}: lang={self.lang}, field={self.field.name}, value={self.value})'


class TranslationsFieldsMixin(models.Model):
class Meta:
abstract = True

_field_tof = {}
_end_init = False
_field_tof = {}
_translations = GenericRelation(Translations, verbose_name=_('Translations'))

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._end_init = True

def __getattribute__(self, attr):
val = self._field_tof.get(attr) if not attr.startswith('_') and self._end_init else None
if val:
return val.get(self) or super().__getattribute__(attr)
return super().__getattribute__(attr)

def __setattr__(self, name, value):
val = self._field_tof.get(name) if self._end_init else None
if val:
return val.set_val(self, value)
super().__setattr__(name, value)

@cached_property
def _all_translations(self, **kwargs):
translations = self._translations.all()
Expand All @@ -84,12 +73,20 @@ def save(self, *args, **kwargs):
@classmethod
def _add_deferred_translated_field(cls, name):
from .query_utils import DeferredTranslatedAttribute
cls._field_tof[name] = DeferredTranslatedAttribute(getattr(getattr(cls, name), 'field', None))
translator = cls._field_tof[name] = DeferredTranslatedAttribute(cls._meta.get_field(name))
setattr(
cls, name,
property(
fget=translator.__get__,
fset=translator.__set__,
fdel=translator.__delete__,
doc=translator.__repr__(),
))

@classmethod
def _del_deferred_translated_field(cls, name):
try:
del cls._field_tof[name]
delattr(cls, name)
except Exception:
pass

Expand Down
34 changes: 22 additions & 12 deletions tof/query_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# @Author: MaxST
# @Date: 2019-10-30 14:19:55
# @Last Modified by: MaxST
# @Last Modified time: 2019-11-07 17:27:46
# @Last Modified time: 2019-11-12 21:54:25
from functools import lru_cache

from django.contrib.contenttypes.models import ContentType
Expand All @@ -13,21 +13,23 @@


class DeferredTranslatedAttribute:
def __init__(self, field):
self.field = field

def get(self, instance):
"""Получит значение перевода поля для инстанса.
"""Получит значение перевода поля для инстанса.

Args:
instance: current instance
field: Поле модели
"""
__slots__ = ('field', )

def __init__(self, field):
self.field = field

Returns:
the cached value.
"""
def __get__(self, instance):
if instance is None:
return self

if not getattr(instance, '_end_init', False):
return

field_name = self.get_field_name()
trans_field_name = self.get_trans_field_name()
data = instance.__dict__
Expand All @@ -54,6 +56,7 @@ def get_translation(self, instance=None, field_name=None, language=None):
translation = instance._all_translations.get(f'{fld_name}_{val_lang}')
if translation:
return translation
return vars(instance).get(f'{self.get_field_name()}_origin')

@lru_cache(maxsize=32)
def get_fallback_languages(self, lang):
Expand All @@ -68,9 +71,12 @@ def get_fallback_languages(self, lang):

if not isinstance(fallback_languages, (list, tuple)):
fallback_languages = (fallback_languages, )
return (lang, ) + tuple(fallback_languages)
return (lang, ) + tuple(fl for fl in fallback_languages if fl != lang) + def_val

def set_val(self, instance, value):
def __set__(self, instance, value):
if not getattr(instance, '_end_init', False):
instance.__dict__[f'{self.get_field_name()}_origin'] = value
return
instance.__dict__[self.get_trans_field_name()] = value

def save(self, instance):
Expand All @@ -80,3 +86,7 @@ def save(self, instance):
translation, _ = instance._translations.get_or_create(field=self.get_field_name(ct), lang=self.get_lang(True))
translation.value = val
translation.save()

def __delete__(self, instance):
del instance.__dict__[self.get_field_name()]
del instance._field_tof[self.get_field_name()]
Loading