Django รู้คำสั่งในการสร้างฟิลด์แบบฟอร์มได้อย่างไร

หากฉันมีรูปแบบ Django เช่น:

class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField()
    sender = forms.EmailField()

และฉันเรียกวิธี as_table () ของอินสแตนซ์ของแบบฟอร์มนี้ Django จะแสดงผลฟิลด์ตามลำดับเดียวกันกับที่ระบุไว้ข้างต้น

คำถามของฉันคือ Django รู้ลำดับที่ตัวแปรคลาสที่กำหนดไว้ได้อย่างไร

(ฉันจะแทนที่คำสั่งนี้ได้อย่างไรเช่นเมื่อฉันต้องการเพิ่มฟิลด์จากวิธีการเริ่มต้นของ classe )

[หมายเหตุ: คำตอบนี้ค่อนข้างล้าสมัยไปแล้ว - โปรดดูการสนทนาด้านล่างและคำตอบล่าสุด]

ถ้าfเป็นรูปแบบช่องของมันf.fieldsคือ a django.utils.datastructures.SortedDict (แสดงรายการตามลำดับที่เพิ่ม) หลังจากการสร้างแบบฟอร์ม f.fields มีแอตทริบิวต์ keyOrder ซึ่งเป็นรายการที่มีชื่อเขตข้อมูลตามลำดับที่ควรนำเสนอ คุณสามารถตั้งค่าให้เป็นลำดับที่ถูกต้อง (แม้ว่าคุณจะต้องใช้ความระมัดระวังเพื่อให้แน่ใจว่าคุณจะไม่ละรายการหรือเพิ่มสิ่งพิเศษ)

นี่คือตัวอย่างที่ฉันเพิ่งสร้างในโครงการปัจจุบันของฉัน:

class PrivEdit(ModelForm):
    def __init__(self, *args, **kw):
        super(ModelForm, self).__init__(*args, **kw)
        self.fields.keyOrder = [
            'super_user',
            'all_districts',
            'multi_district',
            'all_schools',
            'manage_users',
            'direct_login',
            'student_detail',
            'license']
    class Meta:
        model = Privilege

ใหม่เพื่อ Django 1.9 เป็นForm.field_orderและForm.order_fields ()

# forms.Form example
class SignupForm(forms.Form):

    password = ...
    email = ...
    username = ...

    field_order = ['username', 'email', 'password']


# forms.ModelForm example
class UserAccount(forms.ModelForm):

    custom_field = models.CharField(max_length=254)

    def Meta:
        model = User
        fields = ('username', 'email')

    field_order = ['username', 'custom_field', 'password']

ฉันตอบคำถามของตัวเองต่อไป นี่คือคำตอบสำหรับการอ้างอิงในอนาคต:

ใน Django form.pyใช้เวทมนตร์แห่งความมืดโดยใช้__new__วิธีการโหลดตัวแปรคลาสของคุณในท้ายที่สุดself.fieldsตามลำดับที่กำหนดไว้ในคลาส self.fieldsเป็นSortedDictอินสแตนซ์Django (กำหนดไว้ในdatastructures.py)

เพื่อลบล้างสิ่งนี้ในตัวอย่างของฉันคุณต้องการให้ผู้ส่งมาก่อน แต่จำเป็นต้องเพิ่มในวิธีการเริ่มต้นคุณจะต้องทำ:

class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField()
    def __init__(self,*args,**kwargs):
        forms.Form.__init__(self,*args,**kwargs)
        #first argument, index is the position of the field you want it to come before
        self.fields.insert(0,'sender',forms.EmailField(initial=str(time.time())))

เขตข้อมูลจะแสดงรายการตามลำดับที่กำหนดไว้ใน ModelClass._meta.fields แต่ถ้าคุณต้องการเปลี่ยนลำดับใน Form คุณสามารถทำได้โดยใช้ฟังก์ชัน keyOrder ตัวอย่างเช่น :

class ContestForm(ModelForm):
  class Meta:
    model = Contest
    exclude=('create_date', 'company')

  def __init__(self, *args, **kwargs):
    super(ContestForm, self).__init__(*args, **kwargs)
    self.fields.keyOrder = [
        'name',
        'description',
        'image',
        'video_link',
        'category']

ด้วย Django> = 1.7 คุณต้องแก้ไขContactForm.base_fieldsดังนี้:

from collections import OrderedDict

...

class ContactForm(forms.Form):
    ...

ContactForm.base_fields = OrderedDict(
    (k, ContactForm.base_fields[k])
    for k in ['your', 'field', 'in', 'order']
)

เคล็ดลับนี้ใช้ใน Django Admin PasswordChangeForm: Source on Github

creation_counterเขตข้อมูลฟอร์มมีแอตทริบิวต์สำหรับการสั่งซื้อการสร้างที่เรียกว่า .fieldsแอตทริบิวต์เป็นพจนานุกรมดังนั้นการเพิ่มพจนานุกรมและการเปลี่ยนcreation_counterแอตทริบิวต์ในทุกช่องอย่างง่าย ๆ เพื่อให้สอดคล้องกับการจัดลำดับใหม่ก็ควรจะเพียงพอ (ไม่เคยลองทำเช่นนี้)

ใช้ตัวนับในคลาสฟิลด์ เรียงตามตัวนับนั้น:

import operator
import itertools

class Field(object):
    _counter = itertools.count()
    def __init__(self):
        self.count = Field._counter.next()
        self.name = ''
    def __repr__(self):
        return "Field(%r)" % self.name

class MyForm(object):
    b = Field()
    a = Field()
    c = Field()

    def __init__(self):
        self.fields = []
        for field_name in dir(self):
            field = getattr(self, field_name)
            if isinstance(field, Field):
                field.name = field_name
                self.fields.append(field)
        self.fields.sort(key=operator.attrgetter('count'))

m = MyForm()
print m.fields # in defined order

เอาท์พุต:

[Field('b'), Field('a'), Field('c')]

ในรูปแบบ Django 1.7 ใช้ OrderDict ซึ่งไม่รองรับตัวดำเนินการผนวก ดังนั้นคุณต้องสร้างพจนานุกรมใหม่ตั้งแต่ต้น ...

class ChecklistForm(forms.ModelForm):

  class Meta:
    model = Checklist
    fields = ['name', 'email', 'website']

  def __init__(self, guide, *args, **kwargs):
    self.guide = guide
    super(ChecklistForm, self).__init__(*args, **kwargs)

    new_fields = OrderedDict()
    for tier, tasks in guide.tiers().items():
      questions = [(t['task'], t['question']) for t in tasks if 'question' in t]
      new_fields[tier.lower()] = forms.MultipleChoiceField(
        label=tier,
        widget=forms.CheckboxSelectMultiple(),
        choices=questions,
        help_text='desired set of site features'
      )

    new_fields['name'] = self.fields['name']
    new_fields['email'] = self.fields['email']
    new_fields['website'] = self.fields['website']
    self.fields = new_fields 

สำหรับการอ้างอิงในอนาคต: สิ่งต่าง ๆ มีการเปลี่ยนแปลงเล็กน้อยตั้งแต่รูปแบบใหม่ นี่เป็นวิธีหนึ่งในการจัดลำดับฟิลด์ใหม่จากคลาสฟอร์มพื้นฐานที่คุณไม่สามารถควบคุมได้:

def move_field_before(form, field, before_field):
    content = form.base_fields[field]
    del(form.base_fields[field])
    insert_at = list(form.base_fields).index(before_field)
    form.base_fields.insert(insert_at, field, content)
    return form

นอกจากนี้ยังมีเอกสารเล็กน้อยเกี่ยวกับ SortedDict ที่base_fieldsใช้ที่นี่: http://code.djangoproject.com/wiki/SortedDict

ถ้าอย่างใดอย่างหนึ่งfields = '__all__':

class AuthorForm(ModelForm):
    class Meta:
        model = Author
        fields = '__all__'

หรือexcludeใช้:

class PartialAuthorForm(ModelForm):
    class Meta:
        model = Author
        exclude = ['title']

จากนั้น Django อ้างอิงลำดับของเขตข้อมูลตามที่กำหนดไว้ในรูปแบบ แค่นี้ก็ทำให้ฉันรู้สึกแย่แล้วฉันก็เลยคิดว่าจะพูดถึงมัน มีการอ้างอิงในเอกสาร ModelForm :

หากใช้อย่างใดอย่างหนึ่งลำดับที่ฟิลด์ปรากฏในฟอร์มจะเป็นลำดับที่ฟิลด์ถูกกำหนดในโมเดลโดยอินสแตนซ์ ManyToManyField จะปรากฏเป็นอันดับสุดท้าย

วิธีที่ง่ายที่สุดในการสั่งซื้อฟิลด์ในฟอร์ม django 1.9 คือการใช้field_orderในฟอร์มForm.field_orderของคุณ

นี่คือตัวอย่างเล็ก ๆ

class ContactForm(forms.Form):
     subject = forms.CharField(max_length=100)
     message = forms.CharField()
     sender = forms.EmailField()
     field_order = ['sender','message','subject']

ซึ่งจะแสดงทุกอย่างตามลำดับที่คุณระบุไว้ในfield_orderdict

การใช้fieldsชั้นในMetaเป็นสิ่งที่เหมาะกับฉันDjango==1.6.5:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
Example form declaration with custom field order.
"""

from django import forms

from app.models import AppModel


class ExampleModelForm(forms.ModelForm):
    """
    An example model form for ``AppModel``.
    """
    field1 = forms.CharField()
    field2 = forms.CharField()

    class Meta:
        model = AppModel
        fields = ['field2', 'field1']

ง่ายๆแค่นั้นเอง

ฉันใช้สิ่งนี้เพื่อย้ายฟิลด์เกี่ยวกับ:

def move_field_before(frm, field_name, before_name):
    fld = frm.fields.pop(field_name)
    pos = frm.fields.keys().index(before_name)
    frm.fields.insert(pos, field_name, fld)

สิ่งนี้ใช้ได้ใน 1.5 และฉันมั่นใจพอสมควรว่ามันยังใช้งานได้ในเวอร์ชันล่าสุด

มันเกี่ยวข้องกับคลาสเมตาที่ใช้ในการกำหนดคลาสฟอร์ม ฉันคิดว่ามันจะเก็บรายชื่อเขตข้อมูลไว้ภายในและถ้าคุณแทรกลงไปตรงกลางรายการมันอาจใช้ได้ เป็นเวลานานแล้วที่ฉันดูรหัสนั้น