Flask-WTF
和Flask-SQLAlchemy
都是很好用的外掛,然而當它們結合到一起後,就不是那麼美妙了。
問題的提出
在models.py
中定義了一個Article
、Category
和Tag
類:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
class Article(db.Model): """定義文章""" __tablename__ = 'articles' id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String(128), unique=True, index=True) # 儲存md格式的文字 content = db.Column(db.Text) # 儲存html格式的文字 content_html = db.Column(db.Text) # 文章分類 category_id = db.Column(db.Integer, db.ForeignKey('categories.id')) # 文章標籤 tags = db.relationship( 'Tag', secondary='article_tag_ref', backref='articles') class Category(db.Model): """文章分類""" __tablename__ = 'categories' id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(128), unique=True) articles = db.relationship('Article', backref='category', lazy='dynamic') class Tag(db.Model): """文章標籤""" __tablename__ = 'tags' id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String(128), unique=True) # 文章和標籤的對映表 ,多對多關係 article_tag_ref = db.Table('article_tag_ref', db.Column('article_id', db.Integer, db.ForeignKey('articles.id')), db.Column('tag_id', db.Integer, db.ForeignKey('tags.id')) ) |
然後在forms.py
中定義一個ArticleForm
表單
1 2 3 4 5 6 7 |
class ArticleForm(Form): title = StringField(u"標題", validators=[Required()]) category = QuerySelectField(u"分類", query_factory=getUserFactory(['id', 'name']), get_label='name') tags = StringField(u"標籤", validators=[Required()]) content = PageDownField(u"正文", validators=[Required()]) submit = SubmitField(u"釋出") |
此時在處理表單的時候可以這樣:
1 2 3 4 |
form = ArticleForm() if form.validate_on_submit(): article = Article(title=from.data.title, content=form.data.content,category=form.category.data) ... |
等等,這樣怎麼處理form.data.tags
?只有像下面這樣寫了:
1 2 3 4 5 6 7 8 9 10 11 12 |
""" :param tags: 標籤列表,如[u'測試',u'Flask'] """ def str_to_obj(tags): r = [] for tag in tags: tag_obj = Tag.query.filter_by(name=tag).first() if tag_obj is None: tag_obj = Tag(name=tag) r.append(tag_obj) return r |
然後在上面的程式碼中加入:
1 2 3 |
form = ArticleForm() if form.validate_on_submit(): article = Article(title=from.data.title, content=form.data.content, category=form.category.data, tags=str_to_obj(form.data.tags)) |
這樣是不是很難看,像form.data.category
就是一個物件,為撒到form.data.tags
了就不是了,還要專門寫一個函式來坐一個轉換?這個時候就有必要擴充套件WTForms
中的表單了。
WTForms入門
閱讀WTForms
文件,關於如何建立一個TagListField,貼一下程式碼:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
class TagListField(Field): widget = TextInput() def _value(self): if self.data: return u', '.join(self.data) else: return u'' def process_formdata(self, valuelist): if valuelist: self.data = [x.strip() for x in valuelist[0].split(',')] else: self.data = [] |
簡單了看了一下WTForms
原始碼,大致搞清楚了上面程式碼兩個方法的作用:
- _value The _value method is called by the TextInput widget to provide the value that is displayed in the form. 在初始化表單的時候,就是呼叫這個方法在表單中渲染資料
- process_formdata 表單提交時,處理該欄位的資料。
編寫WTForm
擴充套件
根據上面的程式碼,將TagListField
中的字串轉為models.py
中定義的Tag
物件即可:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
class TagListField(Field): widget = TextInput() def __init__(self, label=None, validators=None, **kwargs): super(TagListField, self).__init__(label, validators, **kwargs) def _value(self): if self.data: r = u'' for obj in self.data: r += self.obj_to_str(obj) return u'' else: return u'' def process_formdata(self, valuelist): print 'process_formdata..' print valuelist if valuelist: tags = self._remove_duplicates([x.strip() for x in valuelist[0].split(',')]) self.data = [self.str_to_obj(tag) for tag in tags] else: self.data = None def pre_validate(self, form): pass @classmethod def _remove_duplicates(cls, seq): """去重""" d = {} for item in seq: if item.lower() not in d: d[item.lower()] = True yield item @classmethod def str_to_obj(cls, tag): """將字串轉換位obj物件""" tag_obj = Tag.query.filter_by(name=tag).first() if tag_obj is None: tag_obj = Tag(name=tag) return tag_obj @classmethod def obj_to_str(cls, obj): """將物件轉換為字串""" if obj: return obj.name else: return u'' |
主要就是在process_formdata
這一步處理表單的資料,將字串轉換為需要的資料。最終就可以在forms.py
中這樣定義表單了:
1 2 3 4 5 6 7 8 9 10 |
... class ArticleForm(Form): """編輯文章表單""" title = StringField(u'標題', validators=[Required()]) category = QuerySelectField(u'分類', query_factory=get_category_factory(['id', 'name']), get_label='name') tags = TagListField(u'標籤', validators=[Required()]) content = PageDownField(u'正文', validators=[Required()]) submit = SubmitField(u'釋出') ... |
在views.py
中處理表單就很方便了:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
def edit_article(): """編輯文章""" form = ArticleForm() if form.validate_on_submit(): article = Article(title=form.title.data, content=form.content.data) article.tags = form.tags.data article.category = form.category.data try: db.session.add(article) db.session.commit() except: db.session.rollback() return render_template('dashboard/edit.html', form=form) |
程式碼是不是很簡潔了?^_^。。。
當然了寫一個完整的WTForms
擴充套件還是很麻煩的。這裡只是剛剛入門。可以看官方擴充套件QuerySelectField
的原始碼。。。
最終效果