Использование mixin с классом формы Django - PullRequest
Новая
       8

Использование mixin с классом формы Django

20 голосов
/ 19 августа 2011

Я подумываю о создании класса форм mixin, чтобы я мог добавить общий набор полей к множеству других очень разных форм. Простое использование его в качестве базового класса не сработает, потому что я хочу иметь возможность использовать другие формы в качестве базовых классов, например: 

class NoteFormMixin(object):
    note = forms.CharField()

class MainForm(forms.Form):
    name = forms.CharField()
    age = forms.IntegerField()

class SpecialForm(MainForm, NoteFormMixin):
    favorite_color = forms.CharField()

Мой единственный вопрос: как это работает? Пока что похоже, что если я использую миксин, то он не распознает поля, установленные из этого миксина: 

>>> ff1 = SpecialForm()
>>> ff1.fields
{'name': <django.forms.fields.CharField object at 0x178d3110>, 'age': <django.forms.fields.IntegerField object at 0x178d3190>, 'favorite_color': <django.forms.fields.CharField object at 0x178d3210>}

Неужели это просто невозможно?

Ответы [ 3 ]

23 голосов
/ 20 августа 2011

Проблема в том, что ваш NoteFormMixin является производным от объекта, а не от форм. Форма.Вы должны изменить это так: 

class NoteFormMixin(forms.Form):
    note = forms.CharField()
6 голосов
/ 20 мая 2012

Решение Патрика Альтмана верно только для обычных форм - если вы попробуете это с ModelForm, вы застрянете либо с конфликтами метаклассов, либо с отсутствующими полями.

Самое простое и короткое решение, которое я нашел, было в приложении к Django ' ticket # 7018 - спасибо, bear330 : o)

Вам понадобится: 

from django.forms.forms import get_declared_fields
. . .

class ParentsIncludedModelFormMetaclass(ModelFormMetaclass):
    """
        Thanks to bear330 - taken from https://code.djangoproject.com/attachment/ticket/7018/metaforms.py
    """

    def __new__(cls, name, bases, attrs):
        # We store attrs as ModelFormMetaclass.__new__ clears all fields from it
        attrs_copy = attrs.copy()
        new_class = super(ParentsIncludedModelFormMetaclass, cls).__new__(cls, name, bases, attrs)
        # All declared fields + model fields from parent classes
        fields_without_current_model = get_declared_fields(bases, attrs_copy, True)
        new_class.base_fields.update(fields_without_current_model)
        return new_class


def get_next_in_mro(current_class, class_to_find):
    """
        Small util - used to call get the next class in the MRO chain of the class
        You'll need this in your Mixins if you want to override a standard ModelForm method
    """
    mro = current_class.__mro__
    try:
        class_index = mro.index(class_to_find)
        return mro[class_index+1]
    except ValueError:
        raise TypeError('Could not find class %s in MRO of class %s' % (class_to_find.__name__, current_class.__name__))

Затем вы определяете свой миксин как обычный ModelForm, но без объявления Meta : 

from django import forms
class ModelFormMixin(forms.ModelForm):

    field_in_mixin = forms.CharField(required=True, max_length=100, label=u"Field in mixin")
    . . .

    # if you need special logic in your __init__ override as usual, but make sure to
    # use get_next_in_mro() instead of super()
    def __init__(self, *args, **kwargs):
        #
        result = get_next_in_mro(self.__class__, ModelFormMixin).__init__(self, *args, **kwargs)

        # do your specific initializations - you have access to self.fields and all the usual stuff
        print "ModelFormMixin.__init__"

        return result

    def clean(self):
        result = get_next_in_mro(self.__class__, ModelFormMixin).clean(self)

        # do your specific cleaning
        print "ModelFormMixin.clean"

        return result

И, наконец, финальная ModelForm, повторно использующая возможности ModelFormMixin. Вы должны определить Мета и все обычные вещи. В окончательных формах вы можете просто позвонить супер (...) когда вы переопределяете методы (см. ниже).

ПРИМЕЧАНИЕ : в окончательной форме должен быть установлен ParentsIncludedModelFormMetaclass в качестве метакласса

ПРИМЕЧАНИЕ : важен порядок классов - сначала поместите миксин , затем ModelFrom. 

class FinalModelForm(ModelFormMixin, forms.ModelForm):
    """
        The concrete form.
    """
    __metaclass__ = ParentsIncludedModelFormMetaclass

    class Meta:
        model = SomeModel

    field_in_final_form = forms.CharField(required=True, max_length=100, label=u"Field in final form")

    def clean(self):
        result = super(FinalModelForm, self).clean()

        # do your specific cleaning
        print "FinalModelForm.clean"

        return result

Имейте в виду, что это работает, только если оба класса являются ModelForms. Если вы попытаетесь смешать и сопоставить Form и ModelFrom с помощью этой техники, это не будет красиво: o)

2 голосов
/ 14 марта 2015 
class TextFormMixin(object):
    def __init__(self, *args, **kwargs):
        super(TextFormMixin, self).__init__(*args, **kwargs)
        self.fields['text'] = forms.CharField(widget=forms.Textarea, required=True)

    def clean_text(self):
        if not ('{{EMAIL}}' in self.cleaned_data.get('text', '')):
            raise ValidationError("You have to put {{EMAIL}} in message body.")
        return self.cleaned_data.get('text', '')

    def get_text(self):
        return self.cleaned_dat['text'].replace('{{EMAIL}}', self.case.get_email())


class NewCaseForm(TextFormMixin, forms.ModelForm):
    pass
class ReplyForm(TextFormMixin, forms.Form):
    to = forms.CharField(max_length=50)
    subject = forms.CharField(max_length=50)
...