Django-TOC Library API

class tof.admin.ContentTypeAdmin(model, admin_site)

Bases: ModelAdmin

get_search_results(request, queryset, search_term)

Return a tuple containing a queryset to implement the search and a boolean indicating if the results may contain duplicates.

has_add_permission(*args, **kwargs)

Return True if the given request has permission to add an object. Can be overridden by the user in subclasses.

has_change_permission(*args, **kwargs)

Return True if the given request has permission to change the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to change the obj model instance. If obj is None, this should return True if the given request has permission to change any object of the given type.

has_delete_permission(*args, **kwargs)

Return True if the given request has permission to delete the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to delete the obj model instance. If obj is None, this should return True if the given request has permission to delete any object of the given type.

property media

search_fields = ('app_label', 'model')

class tof.admin.LanguageAdmin(model, admin_site)

Bases: ModelAdmin

get_search_results(request, queryset, search_term)

Return a tuple containing a queryset to implement the search and a boolean indicating if the results may contain duplicates.

has_view_permission(request, obj=None)

Return True if the given request has permission to view the given Django model instance. The default implementation doesn’t examine the obj parameter.

If overridden by the user in subclasses, it should return True if the given request has permission to view the obj model instance. If obj is None, it should return True if the request has permission to view any object of the given type.

list_display = ('iso', 'is_active')

list_editable = ('is_active',)

property media

search_fields = ('iso',)

class tof.admin.ModelFieldIterator(field)

Bases: object

property id

property name

class tof.admin.StaticMessageTranslationAdmin(model, admin_site)

Bases: ActionViewsMixin, ModelAdmin

actions = (<function View.as_view.<locals>.view>, <function View.as_view.<locals>.view>)

fields = ('message', 'translation')

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

has_add_permission(request)

Return True if the given request has permission to add an object. Can be overridden by the user in subclasses.

has_change_permission(request, obj=None)

Return True if the given request has permission to change the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to change the obj model instance. If obj is None, this should return True if the given request has permission to change any object of the given type.

has_delete_permission(request, obj=None)

Return True if the given request has permission to delete the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to delete the obj model instance. If obj is None, this should return True if the given request has permission to delete any object of the given type.

list_display = ('__str__', 'languages')

property media

readonly_fields = ('message', 'languages')

search_fields = ('message', 'translation')

class tof.admin.TranslatableFieldAdmin(model, admin_site)

Bases: ModelAdmin

class Media

Bases: object

css = {'screen': ('admin/css/empty_containers.css',)}

js = ('tof/js/autocomplete_utils.js',)

autocomplete_fields = ('content_type',)

delete_queryset(request, queryset)

Given a queryset, delete it from the database.

fieldsets = ((None, {'fields': ['content_type', 'name']}),)

formfield_for_dbfield(db_field, request, **kwargs)

Hook for specifying the form Field instance for a given database Field instance.

If kwargs are given, they’re passed to the form Field’s constructor.

get_changeform_initial_data(request)

Get the initial form data from the request’s GET params.

get_queryset(request)

Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

get_search_results(request, queryset, search_term)

Return a tuple containing a queryset to implement the search and a boolean indicating if the results may contain duplicates.

get_search_results_for_ajax(request, queryset, *__, **___)

has_change_permission(*args, **kwargs)

Return True if the given request has permission to change the given Django model instance, the default implementation doesn’t examine the obj parameter.

Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to change the obj model instance. If obj is None, this should return True if the given request has permission to change any object of the given type.

list_display = ('content_type', 'name')

property media

search_fields = ('content_type__model', 'name')

class tof.admin.TranslationAdmin(model, admin_site)

Bases: ModelAdmin

autocomplete_fields = ('field', 'lang')

fieldsets = ((None, {'fields': (('field', 'lang'), 'object_id', 'value')}), ('hidden', {'classes': ['hidden'], 'fields': ['content_type']}))

form

alias of TranslationsForm

get_readonly_fields(request, obj)

Hook for specifying custom readonly fields.

list_display = ('content_object', 'lang', 'field', 'value')

list_filter = ('content_type',)

property media

url_name = '%s:%s_%s_autocomplete'

class tof.admin.TranslationFormSet(data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None, **kwargs)

Bases: BaseGenericInlineFormSet

get_form_kwargs(index)

Return additional keyword arguments for each individual formset form.

index will be None if the form being constructed is a new empty form.

class tof.admin.TranslationInline(parent_model, admin_site)

Bases: TranslationInlineMixin, GenericInlineModelAdmin

property media

class tof.admin.TranslationInlineMixin

Bases: object

autocomplete_fields = ('field', 'lang')

extra = 0

fields = ('field', 'lang', 'value')

form

alias of TranslationsInLineForm

formset

alias of TranslationFormSet

property media

model

alias of Translation

class tof.admin.TranslationStackedInline(parent_model, admin_site)

Bases: TranslationInline, GenericStackedInline

property media

class tof.admin.TranslationTabularInline(parent_model, admin_site)

Bases: TranslationInline, GenericTabularInline

property media

class tof.actions.GenerateTranslationJSONFileAction(**kwargs)

Bases: ActionView

allow_empty = True

description = 'Generate translation JSON file for front'

finished_message = 'Success'

processing(*args, **kwargs)

short_description = 'Generate translation JSON file for front'

class tof.actions.VueI18NExtractAction(**kwargs)

Bases: ActionView

allow_empty = True

description = 'Extract translation from front'

finished_message = 'Success'

processing(*args, **kwargs)

short_description = 'Extract translation from front'

class tof.apps.TofConfig(app_name, app_module)

Bases: AppConfig

default_auto_field = 'django.db.models.BigAutoField'

name = 'tof'

ready()

Override this method in subclasses to run code when Django starts.

release(*args, **kwargs)

class tof.fields.TranslatableFieldFormField(fields, *args, **kwargs)

Bases: MultiValueField

clean(values)

Validate every value in the given list. A value is validated against the corresponding Field in self.fields.

For example, if this MultiValueField was instantiated with fields=(DateField(), TimeField()), clean() would call DateField.clean(value[0]) and TimeField.clean(value[1]).

cleaned_langs = None

compress(data_list)

Return a single value for the given list of values. The values can be assumed to be valid.

For example, if this MultiValueField was instantiated with fields=(DateField(), TimeField()), this might return a datetime object created by combining the date and time in data_list.

hidden_widget

alias of TranslatableFieldHiddenWidget

widget

alias of TranslatableFieldWidget

class tof.forms.TranslationsForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

Bases: ModelForm

class Media

Bases: object

js = ('tof/js/translation_form.js',)

base_fields = {}

declared_fields = {}

property media

Return all media required to render the widgets on this form.

class tof.forms.TranslationsInLineForm(*args, parent_object=None, **kwargs)

Bases: ModelForm

base_fields = {}

declared_fields = {}

filter_ct(func)

property media

Return all media required to render the widgets on this form.

class tof.mixins.ClassPatcherMixin

Bases: object

classmethod patch_bases(target, *__)

classmethod unpatch_bases(target, *args)

class tof.mixins.InstancePatcherMixin

Bases: ClassPatcherMixin

classmethod patch_bases(target, *args)

classmethod unpatch_bases(target, *args)

class tof.mixins.TofAdminMixin

Bases: InstancePatcherMixin

static check_modeladmin(site, model)

If model was registered with builtin ModelAdmin class we replace it with our TofModelAdmin. Otherwise patch brake MRO for already patched admins.

classmethod get_admins(model)

get_form(request, obj=None, change=False, **kwargs)

classmethod patch_unpatch(patch, model, fields)

class tof.mixins.TofInlineMixin

Bases: ClassPatcherMixin

get_formset(request, obj=None, **kwargs)

classmethod get_inlines(model)

classmethod patch_unpatch(patch, model, fields)

classmethod set_inlines()

class tof.mixins.TofModelAdmin(model, admin_site)

Bases: ModelAdmin

property media

class tof.mixins.TranslationFieldMixin(*args, **kwargs)

Bases: ClassPatcherMixin

collect(action)

get_from_db(**kwargs)

save(*args, **kwargs)

class tof.mixins.TranslationFieldModelFormMixin(*args, **kwargs)

Bases: ClassPatcherMixin

get_initial_for_field(field, field_name)

class tof.mixins.TranslationManagerMixin

Bases: InstancePatcherMixin

exclude(*args, **kwargs)

expand(key, value)

expand_arg(arg)

filter(*args, **kwargs)

get_queryset(*args, **kwargs)

classmethod patch_bases(target, *args)

run_function(func, *args, **kwargs)

classmethod unpatch_bases(target, *args)

tof.mixins.apply_mixins(patch, target_cls, fields)

Add/remove to target_cls bases mixins, whose is necessary for work with tof.

tof.mixins.load_languages(request)

class tof.mixins.tofQ(*args, _connector=None, _negated=False, **kwargs)

Bases: Q

patch = True

tof.mixins.wrapper(func)

class tof.models.Language(id, iso, is_active)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_active

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

iso

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromLanguageQuerySet object>

translations

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class tof.models.LanguageQuerySet(model=None, query=None, using=None, hints=None)

Bases: QuerySet

active()

get_choices_by(*args, **kwargs)

class tof.models.StaticMessageTranslation(id, message, translation)

Bases: Model

CACHE = {}

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

base_translator_cls(message)

static gettext(translator, message)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

languages()

message

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromQuerySet object>

classmethod patch_djangotranslation()

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

translation

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tof.models.ThroughLanguage(*args, **kwargs)

Bases: Model

class Meta

Bases: object

abstract = False

language

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

language_id

class tof.models.TranslatableField(id, name, content_type)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

collect(instance, action)

collect_created(saved, value, instance)

static collect_updated(saved, value, *__)

content_type

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

content_type_id

delete(*args, **kwargs)

get_saved(instance)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_translatable(value)

name

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromTranslatableFieldQuerySet object>

patch_field(target_cls, fields)

patch_unpatch(patch)

pre_save(instance, *__)

replaced_field = None

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

translations

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

translator_cls

alias of TranslatableText

unpatch_field(target_cls, fields)

class tof.models.TranslatableFieldQuerySet(model=None, query=None, using=None, hints=None)

Bases: QuerySet

patch_fields()

class tof.models.Translation(id, content_type, object_id, field, lang, value)

Bases: Model

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

content_object

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

content_type

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

content_type_id

classmethod create(field, instance, lang, value)

field

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

field_id

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

lang

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

lang_id

object_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.ManagerFromTranslationQueryset object>

update(lang, value)

value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class tof.models.TranslationQueryset(model=None, query=None, using=None, hints=None)

Bases: QuerySet

bulk_delete(objs)

save_translations(instance)

class tof.utils.TranslatableText

Bases: str

Class like a string but returns values depends on get_language.

property DEFAULT

property current

static get_lang()

property iter

update(**kwargs)

update_current(value)

class tof.views.ActionView(**kwargs)

Bases: FormView

ADDITION = 1

CHANGE = 2

DELETION = 3

admin = None

allow_empty = False

answer

as_button = False

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

callback_template = None

callback_template_name_suffix = 'callback'

cancel(*__, **kwargs)

Send cancel message during process and return None.

cancel_message = 'Action was cancelled'

classmethod check_permissions(request, admin=None)

counter = 0

description = ''

dispatch(admin, request, queryset, *args, **kwargs)

error(cause, **kwargs)

error_message = 'Error {cause}'

extra_context = {'action_checkbox_name': '_selected_action'}

finished(*__, **kwargs)

Send message after process and return None.

finished_message = ''

form_valid(*args, **kwargs)

Make something ready befor processing.

get(request, *args, **kwargs)

Handle GET requests: instantiate a blank version of the form.

classmethod get_as_tuple()

get_callback_template()

get_context_data(**kwargs)

Insert the form into the context dict.

get_form(form_class=None, **kwargs)

Return an instance of the form to be used in this view.

get_object()

get_prefix()

Return the prefix to use for forms.

get_queryset(*args, **kwargs)

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

info(info, **kwargs)

log(obj, action_flag=2, **kwargs)

logger

alias of LogEntry

model = None

classmethod name()

classmethod patch_request_data(data)

permissions = ()

permissions_message_error = "You don't have enough permissions"

post(request, *args, **kwargs)

Handle POST requests: instantiate a form instance with the passed POST variables and then check if it’s valid.

processing(*args, **kwargs)

processing_message = '{} was change'

queryset = None

classmethod render_as_button()

request = None

setup(admin, request, queryset, *args, **kwargs)

Initialize attributes shared by all view methods.

short_description = ''

template_button = 'core/action_button.html'

template_name = 'core/confirmation.html'

template_name_suffix = 'confirmation'

warning(warning, **kwargs)

class tof.views.ActionViewsMixin

Bases: object

changelist_view(request, extra_context=None)

get_actions(request)

get_changelist_instance(request)

class tof.views.YesNoForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)

Bases: YesNoMixIn, Form

base_fields = {'answer': <django.forms.fields.ChoiceField object>}

button_template = '<button type="{submit}" name="{name}" onclick="document.getElementById(`layer`).style.display = `block`;" value="{value}">{title}</button>'

declared_fields = {'answer': <django.forms.fields.ChoiceField object>}

property media

Return all media required to render the widgets on this form.

prefix = 'YesNoForm'

class tof.views.YesNoMixIn

Bases: object

CHOICES = (('yes', "Yes, I'm sure"), ('no', "No, I'm not sure"))

NEGATIVE = 'no'

NEGATIVE_TEXT = "No, I'm not sure"

POSITIVE = 'yes'

POSITIVE_TEXT = "Yes, I'm sure"

answer_help_text = ''

answer_label = ''

button_negative_template = '<a href="#" class="button cancel-link">{title}</a>'

button_template = '<button type="{submit}" name="answer" value="{value}">{title}</button>'

form_template = 'core/extraform.html'

get_cleaned_data(*args, **kwargs)

get_cleaned_field(field=None, **kwargs)

get_field_name(field=None, **kwargs)

get_request()

is_positiv

method = 'POST'

process_url = ''

render_button_negative()

render_button_positive()

setup(*args, **kwargs)

class tof.widgets.TranslatableFieldHiddenWidget(attrs=None)

Bases: TranslatableFieldWidget

property media

Media for a multiwidget is the combination of all media of the subwidgets.

class tof.widgets.TranslatableFieldWidget(widgets, attrs=None)

Bases: ValueFormatterMixin, MultiWidget

decompress(value)

Return a list of decompressed values for the given compressed value. The given value can be assumed to be valid, but not necessarily non-empty.

get_context(name, value, attrs)

id_for_label(id_)

Return the HTML ID attribute of this Widget for use by a <label>, given the ID of the field. Return an empty string if no ID is available.

This hook is necessary because some widgets have multiple HTML elements and, thus, multiple IDs. In that case, this method should return an ID value that corresponds to the first ID in the widget’s tags.

input_type = 'text'

property media

Media for a multiwidget is the combination of all media of the subwidgets.

static rednder_subwidget(subwidget, **kwargs)

template_name = 'tof/multiwidget.html'

value_from_datadict(data, __, name)

Given a dictionary of data and this widget’s name, return the value of this widget or None if it’s not provided.

value_omitted_from_data(data, files, name)

class tof.widgets.ValueFormatterMixin

Bases: object

format_value(value)

tof.widgets.resolve_admin_link(app_label, model, action)