Django formes, l'héritage et l'ordre des champs de formulaire

De Django 1.9+

Django 1.9 ajoute une nouvelle Form attribut, field_order, permettant de commander le terrain, quel que soit leur ordre de déclaration dans la classe.

class MyForm(forms.Form):
    summary = forms.CharField()
    description = forms.CharField(widget=forms.TextArea)
    author = forms.CharField()
    notes = form.CharField()

    field_order = ['author', 'summary']

Champs manquants dans field_order garder leur ordre dans la classe et sont ajoutés après ceux spécifiés dans la liste. L'exemple ci-dessus sera de produire des champs dans cet ordre: ['author', 'summary', 'description', 'notes']

Voir la documentation: https://docs.djangoproject.com/en/stable/ref/forms/api/#notes-on-field-ordering

Jusqu'à Django 1.6

J'ai eu ce même problème et j'ai trouvé une autre technique pour la réorganisation des champs de la Django Livre De Recettes:

class EditForm(forms.Form):
    summary = forms.CharField()
    description = forms.CharField(widget=forms.TextArea)


class CreateForm(EditForm):
    name = forms.CharField()

    def __init__(self, *args, **kwargs):
        super(CreateForm, self).__init__(*args, **kwargs)
        self.fields.keyOrder = ['name', 'summary', 'description']

J'ai utilisé la solution posté par Séléné, mais trouve qu'elle a enlevé tous les champs qui n'étaient pas affectés à keyOrder. Le formulaire que je suis sous-classement a beaucoup de champs afin que cela ne fonctionnait pas très bien pour moi. J'ai codé cette fonction pour résoudre le problème à l'aide de akaihola réponse, mais si vous voulez qu'il fonctionne comme Selene est tout ce que vous devez faire est de régler throw_away à True.

def order_fields(form, field_list, throw_away=False):
    """
    Accepts a form and a list of dictionary keys which map to the
    form's fields. After running the form's fields list will begin
    with the fields in field_list. If throw_away is set to true only
    the fields in the field_list will remain in the form.

    example use:
    field_list = ['first_name', 'last_name']
    order_fields(self, field_list)
    """
    if throw_away:
        form.fields.keyOrder = field_list
    else:
        for field in field_list[::-1]:
            form.fields.insert(0, field, form.fields.pop(field))

C'est la façon dont je l'utilise dans mon code:

class NestableCommentForm(ExtendedCommentSecurityForm):
    # TODO: Have min and max length be determined through settings.
    comment = forms.CharField(widget=forms.Textarea, max_length=100)
    parent_id = forms.IntegerField(widget=forms.HiddenInput, required=False)

    def __init__(self, *args, **kwargs):
        super(NestableCommentForm, self).__init__(*args, **kwargs)
        order_fields(self, ['comment', 'captcha'])

Vous pouvez également créer un décorateur à l'ordre des champs (inspiré par Joshua solution):

def order_fields(*field_list):
    def decorator(form):
        original_init = form.__init__
        def init(self, *args, **kwargs):
            original_init(self, *args, **kwargs)        
            for field in field_list[::-1]:
                self.fields.insert(0, field, self.fields.pop(field))
        form.__init__ = init
        return form            
    return decorator

Cela permettra d'assurer que tous les champs transmis à la décoratrice venir en premier.
Vous pouvez l'utiliser comme ceci:

@order_fields('name')
class CreateForm(EditForm):
    name = forms.CharField()

Voir les notes en cette SORTE de question sur le chemin de Django reinhardt, les internes de garder une trace de l'ordre des champs, et les réponses comprennent des suggestions sur la façon de "réorganiser" les champs à votre convenance (en fin de compte, ça revient à jouer avec le .fields attribut).

Basé sur une réponse par @akaihola et mis à jour pour fonctionner avec la dernière version de Django 1.5 self.fields.insert est amorti.

from easycontactus.forms import *
from django import forms
class  CustomEasyContactUsForm(EasyContactUsForm):
    ### form settings and configuration
    CAPTHCA_PHRASE = 'igolf'

    ### native methods
    def __init__(self, *args, **kwargs):
        super(CustomEasyContactUsForm, self).__init__(*args, **kwargs)
        # re-order placement of added attachment field 
        self.fields.keyOrder.insert(self.fields.keyOrder.index('captcha'),
                                    self.fields.keyOrder.pop(self.fields.keyOrder.index('attachment'))
                                    )

    ### field defintitions
    attachment = forms.FileField()

Dans l'au-dessus de nous, l'extension d'un EasyContactUsForm de la classe de base tel qu'il est défini dans django-easycontactus paquet.

Les réponses ci-dessus sont juste, mais incomplète. Elles ne fonctionnent que si tous les champs sont définis comme des variables de classe. Qu'en dynamique des champs de formulaire qui doivent être définis dans le intitialiser (__init__)?

from django import forms

class MyForm(forms.Form):
    field1 = ...
    field2 = ...

    field_order = ['val', 'field1', 'field2']

    def __init__(self, val_list, *args, **kwargs):
        super(MyForm, self).__init__(*args, **kwargs)
        vals = zip(val_list, val_list)
        self.fields['val'] = forms.CharField(choices=vals)

Le ci-dessus ne fonctionnera jamais pour val mais va travailler pour field1 et field2 (si nous réorganiser). Vous voudrez peut-être essayer de définir field_order dans l'initialiser:

class MyForm(forms.Form):
    # other fields

    def __init__(self, val_list, *args, **kwargs):
        super(MyForm, self).__init__(*args, **kwargs)
        vals = zip(val_list, val_list)
        self.fields['val'] = forms.CharField(choices=vals)
        self.field_order = ['val', 'field1', 'field2']

mais cela échouera également parce que le domaine de commande est fixé avant l'appel à super().

Donc la seule solution est le constructeur (__new__) et de définir field_order à une variable de classe.

class MyForm(forms.Form):
    # other fields

    field_order = ['val', 'field1', 'field2']

    def __new__(cls, val_list, *args, **kwargs):
        form = super(MyForm, cls).__new__(cls)
        vals = zip(val_list, val_list)
        form.base_fields['val'] = forms.CharField(choices=vals)
        return form