django forms定义时的一些小技巧

我们在使用django定义好一个model后,可能需要添加或者修改model数据,此时可以借助于django提供的forms表单组件.

forms表单和model结合使用时,必须在Meta类中指定关联的model和需要展示的字段(field)

django会自动根据每个字段的类型来生成适合的forms字段

如有一个外键字段,django会自动把他转化成其关联的对象而不是简单的展示其关联的id.

一个简单的model关联的forms表单定义,如FlowStageForm1.

class FlowStageForm1(forms.ModelForm):
    class Meta:
        model = WorkFlowStage
        fields = '__all__'
        exclude = ['work_type']  # 排除该字段

有时候forms默认的渲染可能不满足我们的需求,这时就需要通过手动来定义部分字段来满足我们的需求,没有手动定义的字段django会默认帮我们渲染.

但是有时候只是想简单的修改个小地方,如在所有的字段上添加一个默认的类,难道要把所有的字段都定义一遍吗,很蛋疼.

研究了一下官方文档,发现还是有方法的

可以在__init__初始化时直接循环所有的字段,给他们添加一些属性,而不用重新定义他们.

如果一个表有10个字段,有九个字段有共同属性,而有一个需要单独定制widget,这时候只需在forms中单独定义完,在__init__初始化添加通用属性的时候排除他即可,见红色代码处.

再如果我们想改变字段widget但又想保留django提供的一些功能,如果一个字段是外键,当我们自动在forms中定义过后,就不能使用django默认的功能,需要手动写代码去关联其对象,这时候可以在Meta中使用widgets来单独定义该字段的widget同时保留了django提供的一些特性,这样就完美了.

实例见FlowStageForm

# work_flow是WorkFlowStage的外键
class FlowStageForm(forms.ModelForm):
    handler_id = forms.IntegerField(label="参与人ID", required=False,
                                    widget=forms.HiddenInput())
    hook_method_name = forms.CharField(label="钩子程序方法名", required=False,
                                       widget=forms.TextInput(attrs={'class': 'form-control'}))

    class Meta:
        model = WorkFlowStage
        fields = '__all__'
        exclude = ['work_type']  # 排除该字段
        widgets = {
            'work_flow': forms.Select(attrs={'class': 'form-control disabled', 'required': 'required'}),   #work_flow是一个外键
            'handler_id_display': forms.TextInput(attrs={'class': 'form-control disabled', 'required': 'required'})

        }

    def __init__(self, **kwargs):
        super(FlowStageForm, self).__init__(**kwargs)

        #保存用户有自定义过的fields不对其进行更改.
        declared_fields = []
        if self.declared_fields:  # 自定义过的field
            declared_fields += list(self.declared_fields)
        if self.Meta.widgets:
            declared_fields += list(self.Meta.widgets)  # 修改过widgets的部件.

        attrs = {'class': 'form-control', 'required': 'required'}
        for field in self.fields:
            if field not in declared_fields:  # 排除掉有过自定义的field
                self.fields[field].widget.attrs.update(attrs)