一. 用户级资料编辑器
app/main/forms.py:资料编辑表单
class EditProfileForm(FlaskForm):
name = StringField('Real name', validators=[Length(0, 64)])
location = StringField('Location', validators=[Length(0, 64)])
about_me = TextAreaField('About me')
submit = SubmitField('Submit')
注意:这个表单中的所有字段都是可选的,因此长度验证的最小值为0.
app/main/views.py:资料编辑路由
@main.route('/edit-profile', methods=['POST', 'GET'])
@login_required
def edit_profile():
form = EditProfileForm()
if form.validate_on_submit():
current_user.name = form.name.data
current_user.location = form.location.data
current_user.about_me = form.about_me.data
db.session.add(current_user._get_current_object())
db.session.commit()
flash('Your profile has been updated.')
return redirect(url_for('.user', username=current_user.username))
form.name.data = current_user.name
form.location.data = current_user.location
form.about_me.data = current_user.about_me
return render_template('edit_profile.html', form=form)
字段中的数据使用form.<field-name>.data获取,通过这个表达式不仅能获取用户提交的值,还能在字段中显示初始值,供用户编辑。当form.validate_on_submit()返回False时,表单中的3个字段都使用current_user中保存的初始值,提交表单后,表单字段的data属性中保存有更新后的值。用户级资料编辑界面如下:
二. 管理员级资料编辑器
除了以上字段外,管理员在表单中还能编辑用户的电子邮件、用户名、确认状态和角色,表单定义如下:
class EditProfileAdminForm(FlaskForm):
email = StringField('Email', validators=[DataRequired(), Length(1, 64), Email()])
username = StringField('Username', validators=[
DataRequired(), Length(1, 64),
Regexp("^[a-zA-Z][a-zA-Z0-9_.]*$", 0, 'Usernames must have only letters, numbers, dots or underscores')])
confirmed = BooleanField('Confirmed')
role = SelectField('Role', coerce=int)
name = StringField('Real name', validators=[Length(0, 64)])
location = StringField('Location', validators=[Length(0, 64)])
about_me = TextAreaField('About me')
submit = SubmitField('Submit')
def __init__(self, user, *args, **kwargs):
super().__init__(*args, **kwargs)
self.role.choices = [(role.id, role.name) for role in Role.query.order_by(Role.name).all()]
self.user = user
def validate_email(self, field):
if field.data != self.user.email and User.query.filter_by(email=field.data).first():
raise ValidationError('Email already registered.')
def validate_username(self, field):
if field.data != self.user.username and User.query.filter_by(username=field.data).first():
raise ValidationError('Username already in use.')
- SelectField是WTForms对HTML表单控件<select>的包装,功能是实现下拉列表,这个表单中用于选择用户角色;
- SelectField实例必须在其choices属性中设置各选项,选项必须是一个由元组组成的列表,各元组包含2个元素:选项的标志符、显示在控件中的文本字符串;
- self.role.choices列表在构造函数中设定,其值从Role模型中获取,使用一个查询按照角色名的字母顺序排序的所有角色。元组中的标志符是角色ID,因为这是个整数,所以在SelectField构造函数中加上了coerce=int参数,把字段的值转换为整数,而不使用默认的字符串。
- email和username字段在处理验证时需要小心:仅当有变化时,才要保证新值不与其它用户的相应字段重复,如果字段值没有变化,那么应该跳过验证。因此,表单构造函数需要接收用户作为参数,并将其保存在成员变量中,供后面自定义的验证方法使用。
app/main/views.py:管理员的资料编辑路由
@main.route('/edit-profile/<int:id>', methods=['GET', 'POST'])
@login_required
@admin_required
def edit_profile_admin(id):
user = User.query.get_or_404(id)
form = EditProfileAdminForm(user)
if form.validate_on_submit():
user.email = form.email.data
user.username = form.username.data
user.confirmed = form.confirmed.data
user.role = form.role.data
user.name = form.name.data
user.about_me = form.about_me.data
user.location = form.location.data
db.session.add(user)
db.session.commit()
flash("The profile has been updated.")
return redirect(url_for(".user", username=user.username))
form.email.data = user.email
form.username.data = user.username
form.confirmed.data = user.confirmed
form.role.data = user.role
form.name.data = user.name
form.about_me.data = user.about_me
form.location.data = user.location
return render_template("edit_profile.html", form=form, user=user)
分析:
- admin_required装饰器:自定义装饰器,当非管理员用户访问这个路由时,它会自动返回403错误;
- 用户id由URL中的动态参数指定,因此可使用Flask-Alchemy提供的get_or_404()函数,在提供的id不正确时返回404错误;
- 表单中声明SelectField时设定的coerce=int参数,其作用是保证这个字段的data属性始终被转换为整数。