Django-form表单
构建一个表单
假设你想在你的网站上创建一个简单的表单,以获得用户的名字。你需要类似这样的模板:
1
2
3
4
5
|
<form action = "/your-name/" method= "post" > <label for = "your_name" >Your name : </label> <input id= "your_name" type= "text" name = "your_name" > <input type= "submit" value= "OK" > </form> |
这是一个非常简单的表单。实际应用中,一个表单可能包含几十上百个字段,其中大部分需要预填充,而且我们预料到用户将来回编辑-提交几次才能完成操作。
我们可能需要在表单提交之前,在浏览器端作一些验证。我们可能想使用非常复杂的字段,以允许用户做类似从日历中挑选日期这样的事情,等等。
这个时候,让Django 来为我们完成大部分工作是很容易的。
在Django 中构建一个表单
Form 类
我们已经计划好了我们的 HTML 表单应该呈现的样子。在Django 中,我们的起始点是这里:
1
2
3
4
5
6
|
#forms.py from django import forms class NameForm(forms.Form): your_name = forms.CharField(label= 'Your name' , max_length=100) |
它定义一个Form
类,只带有一个字段(your_name
)。
字段允许的最大长度通过max_length
定义。它完成两件事情。首先,它在HTML 的<input>
上放置一个maxlength="100"
(这样浏览器将在第一时间阻止用户输入多于这个数目的字符)。它还意味着当Django 收到浏览器发送过来的表单时,它将验证数据的长度。
Form
的实例具有一个is_valid()
方法,它为所有的字段运行验证的程序。当调用这个方法时,如果所有的字段都包含合法的数据,它将:
- 返回
True
- 将表单的数据放到
cleaned_data
属性中。
完整的表单,第一次渲染时,看上去将像:
1
2
|
<label for = "your_name" >Your name : </label> <input id= "your_name" type= "text" name = "your_name" maxlength= "100" > |
注意它不包含 <form>
标签和提交按钮。我们必须自己在模板中提供它们。
视图
发送给Django 网站的表单数据通过一个视图处理,一般和发布这个表单的是同一个视图。这允许我们重用一些相同的逻辑。
当处理表单时,我们需要在视图中实例化它:
#views.pyfrom django.shortcuts import render
from django.http import HttpResponseRedirectfrom .forms import NameForm
def get_name(request):
# if this is a POST request we need to process the form data
if request.method == 'POST':
# create a form instance and populate it with data from the request:
form = NameForm(request.POST)
# check whether it's valid:
if form.is_valid():
# process the data in form.cleaned_data as required
# ...
# redirect to a new URL:
return HttpResponseRedirect('/thanks/')</span><span style="color: #008000;">#</span><span style="color: #008000;"> if a GET (or any other method) we'll create a blank form</span> <span style="color: #0000ff;">else</span><span style="color: #000000;">: form </span>=<span style="color: #000000;"> NameForm() </span><span style="color: #0000ff;">return</span> render(request, <span style="color: #800000;">'</span><span style="color: #800000;">name.html</span><span style="color: #800000;">'</span>, {<span style="color: #800000;">'</span><span style="color: #800000;">form</span><span style="color: #800000;">'</span>: form})</pre>
如果访问视图的是一个GET
请求,它将创建一个空的表单实例并将它放置到要渲染的模板的上下文中。这是我们在第一个访问该URL 时预期发生的情况。
如果表单的提交使用POST
请求,那么视图将再次创建一个表单实例并使用请求中的数据填充它:form = NameForm(request.POST)
。这叫做”绑定数据至表单“(它现在是一个绑定的表单)。
我们调用表单的is_valid()
方法;如果它不为True
,我们将带着这个表单返回到模板。这时表单不再为空(未绑定),所以HTML 表单将用之前提交的数据填充,然后可以根据要求编辑并改正它。
如果is_valid()
为True
,我们将能够在cleaned_data
属性中找到所有合法的表单数据。在发送HTTP 重定向给浏览器告诉它下一步的去向之前,我们可以用这个数据来更新数据库或者做其它处理。
模板
我们不需要在name.html 模板中做很多工作。最简单的例子是:
1
2
3
4
5
|
<form action = "/your-name/" method= "post" > {% csrf_token %} {{ form }} <input type= "submit" value= "Submit" /> </form> |
根据{{ form }}
,所有的表单字段和它们的属性将通过Django 的模板语言拆分成HTML 标记 。
注:Django 原生支持一个简单易用的跨站请求伪造的防护。当提交一个启用CSRF 防护的POST
表单时,你必须使用上面例子中的csrf_token
模板标签。
现在我们有了一个可以工作的网页表单,它通过Django Form 描述、通过视图处理并渲染成一个HTML <form>
。
如果我们自定义的验证提示等,当我们在前端页面使用时:
<form action="/blog/backend/updateArticle/p/{{ nid }}" method="post" > <div> <label for="title">标题:</label> <p>{{ article_form.title }}</p> </div> <div> <label for="title">内容:</label> <p> {{ article_form.content }}</span><span style="color: #0000ff;"></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">div</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">p</span><span style="color: #0000ff;">><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">type</span><span style="color: #0000ff;">="submit"</span><span style="color: #ff0000;"> value</span><span style="color: #0000ff;">="提交"</span><span style="color: #0000ff;">></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">form</span><span style="color: #0000ff;">></span></pre>
如果出现以下错误提示时:
(index):1 An invalid form control with name='content' is not focusable.
我们需要在加上 novalidate
<form action="/blog/backend/updateArticle/p/{{ nid }}" method="post" novalidate>
Django Form 类详解
绑定的和未绑定的表单实例
绑定的和未绑定的表单 之间的区别非常重要:
- 未绑定的表单没有关联的数据。当渲染给用户时,它将为空或包含默认的值。
- 绑定的表单具有提交的数据,因此可以用来检验数据是否合法。如果渲染一个不合法的绑定的表单,它将包含内联的错误信息,告诉用户如何纠正数据。
字段详解
考虑一个比上面的迷你示例更有用的一个表单,我们完成一个更加有用的注册表单:
#forms.pyfrom django import forms
class RegisterForm(forms.Form):
username = forms.CharField(max_length=100,
error_messages={"min_length":"最短为5个字符","required":"该字段不能为空"},
)
password = forms.CharField(max_length=100,
widget=widgets.PasswordInput(attrs={"placeholder":"password"})
)telephone</span>=<span style="color: #000000;">forms.IntegerField() email </span>=<span style="color: #000000;"> forms.EmailField() is_married </span>= forms.BooleanField(required=False)</pre>
ChoiceField是下拉框类型
如果直接设置此字段,更新操作后,下拉框并不会更新,需要重启django程序,因为直接在类中定义的静态字段,只会执行一次,即查询显示操作,在编译时就已经执行完毕,
为了让下拉框的数据实时同步,我们需要重写构造方法
1. 班级管理 class ClassForm(Form): caption = fields.CharField(error_messages={'required':'班级名称不能为空'}) # headmaster = fields.ChoiceField(choices=[(1,'娜娜',)]) 这样写无法实时更新 headmaster_id = fields.ChoiceField(choices=models.UserInfo.objects.filter(ut_id=2).values_list('id','username'))</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> class_add(request): </span><span style="color: #0000ff;">if</span> request.method == <span style="color: #800000;">'</span><span style="color: #800000;">GET</span><span style="color: #800000;">'</span><span style="color: #000000;">: form </span>=<span style="color: #000000;"> ClassForm() </span><span style="color: #0000ff;">return</span> render(request,<span style="color: #800000;">'</span><span style="color: #800000;">class_add.html</span><span style="color: #800000;">'</span>,{<span style="color: #800000;">'</span><span style="color: #800000;">form</span><span style="color: #800000;">'</span><span style="color: #000000;">:form}) </span><span style="color: #0000ff;">else</span><span style="color: #000000;">: form </span>= ClassForm(data=<span style="color: #000000;">request.POST) </span><span style="color: #0000ff;">if</span> <span style="color: #0000ff;">not</span><span style="color: #000000;"> form.is_valid(): </span><span style="color: #0000ff;">return</span> render(request, <span style="color: #800000;">'</span><span style="color: #800000;">class_add.html</span><span style="color: #800000;">'</span>, {<span style="color: #800000;">'</span><span style="color: #800000;">form</span><span style="color: #800000;">'</span><span style="color: #000000;">: form}) models.ClassList.objects.create(</span>**<span style="color: #000000;">form.cleaned_data) </span><span style="color: #0000ff;">return</span> redirect(<span style="color: #800000;">'</span><span style="color: #800000;">/class_list/</span><span style="color: #800000;">'</span><span style="color: #000000;">) </span>1<span style="color: #000000;">. headmaster_id </span>2<span style="color: #000000;">. <span style="color: #ff0000;">数据源无法实施更新,重写构造方法</span> 方式一(推荐): </span><span style="color: #0000ff;">class</span><span style="color: #000000;"> ClassForm(Form): caption </span>= fields.CharField(error_messages={<span style="color: #800000;">'</span><span style="color: #800000;">required</span><span style="color: #800000;">'</span>:<span style="color: #800000;">'</span><span style="color: #800000;">班级名称不能为空</span><span style="color: #800000;">'</span><span style="color: #000000;">}) </span><span style="color: #008000;">#</span><span style="color: #008000;"> headmaster = fields.ChoiceField(choices=[(1,'娜娜',)])</span> headmaster_id = fields.ChoiceField(choices=<span style="color: #000000;">[]) </span><span style="color: #0000ff;">def</span> <span style="color: #800080;">__init__</span>(self,*args,**<span style="color: #000000;">kwargs): super().</span><span style="color: #800080;">__init__</span>(*args,**<span style="color: #000000;">kwargs) self.fields[</span><span style="color: #800000;">'</span><span style="color: #800000;">headmaster_id</span><span style="color: #800000;">'</span>].choices = models.UserInfo.objects.filter(ut_id=2).values_list(<span style="color: #800000;">'</span><span style="color: #800000;">id</span><span style="color: #800000;">'</span>,<span style="color: #800000;">'</span><span style="color: #800000;">username</span><span style="color: #800000;">'</span><span style="color: #000000;">) 方式二: </span><span style="color: #0000ff;">from</span> django.forms.models <span style="color: #0000ff;">import</span><span style="color: #000000;"> ModelChoiceField </span><span style="color: #0000ff;">class</span><span style="color: #000000;"> ClassForm(Form): caption </span>= fields.CharField(error_messages={<span style="color: #800000;">'</span><span style="color: #800000;">required</span><span style="color: #800000;">'</span>:<span style="color: #800000;">'</span><span style="color: #800000;">班级名称不能为空</span><span style="color: #800000;">'</span><span style="color: #000000;">}) </span><span style="color: #008000;">#</span><span style="color: #008000;"> headmaster = fields.ChoiceField(choices=[(1,'娜娜',)])</span> headmaster_id = ModelChoiceField(queryset=models.UserInfo.objects.filter(ut_id=2))</pre>
Widgets
每个表单字段都有一个对应的Widget
类,它对应一个HTML 表单Widget
,例如<input type="text">
。
在大部分情况下,字段都具有一个合理的默认Widget。例如,默认情况下,CharField
具有一个TextInput Widget
,它在HTML 中生成一个<input type="text">
。
字段的数据
不管表单提交的是什么数据,一旦通过调用is_valid()
成功验证(is_valid()
返回True
),验证后的表单数据将位于form.cleaned_data
字典中。这些数据已经为你转换好为Python 的类型。
注:此时,你依然可以从request.POST
中直接访问到未验证的数据,但是访问验证后的数据更好一些。
在上面的联系表单示例中,is_married将是一个布尔值。类似地,IntegerField
和FloatField
字段分别将值转换为Python 的int
和float
。
form的字段可以定义正则表达式
from django.core.validators import RegexValidator
password = fields.CharField( required=True, min_length=3, max_length=18, error_messages={ 'required': '密码不能为空', 'min_length': '密码长度不能小于3', 'max_length': '密码长度不能大于18', 'invalid': '密码格式错误', #如果没写这个,则格式不对时显示下面的‘只能是数字’ }, validators=[RegexValidator('\d+','只能是数字') ] )
主动向form中添加错误信息
# form.add_error('password','用户名或密码错误') form.add_error('password',ValidationError('用户名或密码错误'))
form初始化填写input里的默认值
def edit_teacher(request,nid): obj = models.UserInfo.objects.filter(id=nid,ut_id=1).first() if not obj: return redirect('/teachers/')</span><span style="color: #0000ff;">if</span> request.method == <span style="color: #800000;">"</span><span style="color: #800000;">GET</span><span style="color: #800000;">"</span><span style="color: #000000;">: </span><span style="color: #008000;">#</span><span style="color: #008000;"> 显示input,并且将数据库中的默认值填写到input框中</span> form = TeacherForm(initial={<span style="color: #800000;">'</span><span style="color: #800000;">username</span><span style="color: #800000;">'</span>:obj.username,<span style="color: #800000;">'</span><span style="color: #800000;">password</span><span style="color: #800000;">'</span>:obj.password,<span style="color: #800000;">'</span><span style="color: #800000;">email</span><span style="color: #800000;">'</span><span style="color: #000000;">:obj.email}) </span><span style="color: #0000ff;">return</span> render(request,<span style="color: #800000;">'</span><span style="color: #800000;">edit_teacher.html</span><span style="color: #800000;">'</span>,{<span style="color: #800000;">'</span><span style="color: #800000;">form</span><span style="color: #800000;">'</span><span style="color: #000000;">:form}) </span><span style="color: #0000ff;">else</span><span style="color: #000000;">: form </span>= TeacherForm(data=<span style="color: #000000;">request.POST) </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> form.is_valid(): </span><span style="color: #008000;">#</span><span style="color: #008000;"> 校验成功</span> models.UserInfo.objects.filter(id=nid).update(**<span style="color: #000000;">form.cleaned_data) </span><span style="color: #0000ff;">return</span> redirect(<span style="color: #800000;">'</span><span style="color: #800000;">/teachers/</span><span style="color: #800000;">'</span><span style="color: #000000;">) </span><span style="color: #0000ff;">return</span> render(request,<span style="color: #800000;">'</span><span style="color: #800000;">edit_teacher.html</span><span style="color: #800000;">'</span>,{<span style="color: #800000;">'</span><span style="color: #800000;">form</span><span style="color: #800000;">'</span>:form})</pre>
钩子函数
此处拿登陆验证为例
from app01 import models
from django.core.exceptions import ValidationError
# # def index(request): # # all_teacher_list=models.Teacher.objects.all() # # return render(request,"index.html",locals()) # # # def index(request): # # is_login=request.COOKIES.get("is_login",None) # # if is_login: # # username=request.COOKIES.get("username") # # return render(request, "index.html",locals()) # # else: # # return redirect("/login/") # # # # # def delTeacher(request,tid): # # models.Teacher.objects.filter(tid=tid).delete() # # return redirect("/index/") # class LoginForm(Form): username = fields.CharField( required=True, min_length=3, max_length=18, error_messages={ 'required': '用户不能为空', 'min_length': '用户长度不能小于3', 'max_length': '用户长度不能大于18', } ) password = fields.CharField( required=True, min_length=3, max_length=18, error_messages={ 'required': '密码不能为空', 'min_length': '密码长度不能小于3', 'max_length': '密码长度不能大于18', 'invalid': '密码格式错误', }, validators=[RegexValidator('\d+','只能是数字') ] )</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> clean_username(self): <span style="color: #008000;">#这个就是钩子函数,为哪个字段写,函数名就必须为clean_字段名 </span></span><span style="color: #008000;">#</span><span style="color: #008000;"> ...form验证username时,若通过了正则验证,则会执行此函数,下面的函数会判断数据库中是否有这个用户名<br> 如果没有则不会再进行其他字段的验证,并会报错提示:用户名不存在<br></span> user = self.cleaned_data[<span style="color: #800000;">'</span><span style="color: #800000;">username</span><span style="color: #800000;">'</span><span style="color: #000000;">] is_exsit </span>= models.UserInfo.objects.filter(username=<span style="color: #000000;">user).count() </span><span style="color: #0000ff;">if</span> <span style="color: #0000ff;">not</span><span style="color: #000000;"> is_exsit: </span><span style="color: #0000ff;">raise</span> ValidationError(<span style="color: #800000;">'</span><span style="color: #800000;">用户名不存在</span><span style="color: #800000;">'</span><span style="color: #000000;">) </span><span style="color: #0000ff;">return</span> user</pre>
注意:
必须有返回值
只能拿自己当前字段值
raise ValidationError('xxx')
使用表单模板
你需要做的就是将表单实例放进模板的上下文。如果你的表单在Contex
t 中叫做form
,那么{{ form }}
将正确地渲染它的<label>
和 <input>
元素。
表单渲染的选项
对于<label>/<input>
对,还有几个输出选项:
{{ form.as_table }}
以表格的形式将它们渲染在<tr>
标签中{{ form.as_p }}
将它们渲染在<p>
标签中{{ form.as_ul }}
将它们渲染在<li>
标签中
注意,你必须自己提供<table>
或<ul>
元素。
{{ form.as_p }}
会渲染如下:
<form action=""> <p> <label for="id_username">Username:</label> <input id="id_username" maxlength="100" name="username" type="text" required=""> </p><span style="color: #0000ff;"><</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">label </span><span style="color: #ff0000;">for</span><span style="color: #0000ff;">="id_password"</span><span style="color: #0000ff;">></span>Password:<span style="color: #0000ff;"></</span><span style="color: #800000;">label</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">id</span><span style="color: #0000ff;">="id_password"</span><span style="color: #ff0000;"> maxlength</span><span style="color: #0000ff;">="100"</span><span style="color: #ff0000;"> name</span><span style="color: #0000ff;">="password"</span><span style="color: #ff0000;"> placeholder</span><span style="color: #0000ff;">="password"</span><span style="color: #ff0000;"> type</span><span style="color: #0000ff;">="password"</span><span style="color: #ff0000;"> required</span><span style="color: #0000ff;">=""</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">label </span><span style="color: #ff0000;">for</span><span style="color: #0000ff;">="id_telephone"</span><span style="color: #0000ff;">></span>Telephone:<span style="color: #0000ff;"></</span><span style="color: #800000;">label</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">id</span><span style="color: #0000ff;">="id_telephone"</span><span style="color: #ff0000;"> name</span><span style="color: #0000ff;">="telephone"</span><span style="color: #ff0000;"> type</span><span style="color: #0000ff;">="number"</span><span style="color: #ff0000;"> required</span><span style="color: #0000ff;">=""</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">label </span><span style="color: #ff0000;">for</span><span style="color: #0000ff;">="id_email"</span><span style="color: #0000ff;">></span>Email:<span style="color: #0000ff;"></</span><span style="color: #800000;">label</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">id</span><span style="color: #0000ff;">="id_email"</span><span style="color: #ff0000;"> name</span><span style="color: #0000ff;">="email"</span><span style="color: #ff0000;"> type</span><span style="color: #0000ff;">="email"</span><span style="color: #ff0000;"> required</span><span style="color: #0000ff;">=""</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">label </span><span style="color: #ff0000;">for</span><span style="color: #0000ff;">="id_is_married"</span><span style="color: #0000ff;">></span>Is married:<span style="color: #0000ff;"></</span><span style="color: #800000;">label</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">id</span><span style="color: #0000ff;">="id_is_married"</span><span style="color: #ff0000;"> name</span><span style="color: #0000ff;">="is_married"</span><span style="color: #ff0000;"> type</span><span style="color: #0000ff;">="checkbox"</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"></</span><span style="color: #800000;">p</span><span style="color: #0000ff;">></span> <span style="color: #0000ff;"><</span><span style="color: #800000;">input </span><span style="color: #ff0000;">type</span><span style="color: #0000ff;">="submit"</span><span style="color: #ff0000;"> value</span><span style="color: #0000ff;">="注册"</span><span style="color: #0000ff;">></span>
</form>
手工渲染字段
我们没有必要非要让Django 来分拆表单的字段;如果我们喜欢,我们可以手工来做(例如,这样允许重新对字段排序)。每个字段都是表单的一个属性,可以使用{{ form.name_of_field }}
访问,并将在Django 模板中正确地渲染。例如:
1
2
3
4
5
|
< div class="fieldWrapper"> {{ form.Username.errors }} {{ form.Username.label_tag }} {{ form.Username }} </ div > |
渲染表单的错误信息
1、
1
2
3
|
registerForm=RegisterForm(request.POST) print(type(registerForm.errors),"----------")#< class 'django.forms.utils.ErrorDict'> print(type(registerForm.errors["username"]),"----------")#< class 'django.forms.utils.ErrorList'> |
2、
使用{{ form.name_of_field.errors }}
显示表单错误的一个清单,并渲染成一个ul
。看上去可能像:
1
2
3
|
< ul class="errorlist"> < li >Sender is required.</ li > </ ul > |