在 上篇文章中咱们的模板引擎实现了变量和注释功能,同时在文章的最后我给你们留了一个 问题:如何实现支持 if
和 for
的标签功能:html
{% if user.is_admin %} admin, {{ user.name }} {% elif user.is_staff %} staff {% else %} others {% endif %} {% for name in names %} {{ name }} {% endfor %}
在本篇文章中咱们将一块儿来实现这个功能。python
首先咱们来实现对 if
语句的支持。 if
语句的语法以下:git
{% if True %} ... {% elif True %} ... {% else %} ... {% endif %}
咱们首先要作的跟以前同样,那就是肯定匹配标签语法的正则表达式。这里咱们用的是下面 的正则来匹配标签语法:github
re_tag = re.compile(r'\{% .*? %\}') >>> re_tag.findall('{% if True %}...{% elif True %}...{% else %}...{% endif %}') ['{% if True %}', '{% elif True %}', '{% else %}', '{% endif %}']
而后就是生成代码了, if
语句跟以前的变量不同那就是:须要进行缩进切换,这一点须要注意一下。正则表达式
下面咱们来看一下为了支持 if
标签增长了哪些代码吧(完整代码能够从 Github 上下载 template2a.py ):app
class Template: def __init__(self, ...): # ... # 注释 self.re_comment = re.compile(r'\{# .*? #\}') # 标签 self.re_tag = re.compile(r'\{% .*? %\}') # 用于按变量,注释,标签分割模板字符串 self.re_tokens = re.compile(r'''( (?:\{\{ .*? \}\}) |(?:\{\# .*? \#\}) |(?:\{% .*? %\}) )''', re.X) # 生成 def __func_name(): # ... def _parse_text(self): # ... for token in tokens: # ... if self.re_variable.match(token): # ... elif self.re_comment.match(token): continue # {% tag %} elif self.re_tag.match(token): # 将前面解析的字符串,变量写入到 code_builder 中 # 由于标签生成的代码须要新起一行 self.flush_buffer() tag = token.strip('{%} ') tag_name = tag.split()[0] if tag_name in ('if', 'elif', 'else'): # elif 和 else 以前须要向后缩进一步 if tag_name in ('elif', 'else'): self.code_builder.backward() self.code_builder.add_line('{}:'.format(tag)) # if 语句条件部分结束,向前缩进一步,为下一行作准备 self.code_builder.forward() elif tag_name in ('endif',): # if 语句结束,向后缩进一步 self.code_builder.backward() else: # ...
上面代码的关键点是生成代码时的缩进控制:优化
在遇到 if
的时候, 须要在 if
这一行以后将缩进往前移一步ui
在遇到 elif
和 else
的时候, 须要将缩进先日后移一步,待 elif
/ else
那一行完成后还须要把缩进再移回来code
在遇到 endif
的时候, 咱们知道此时 if
语句已经结束了,须要把缩进日后移一步, 离开 if
语句的主体部分orm
咱们来看一下生成的代码:
>>> from template2a import Template >>> t = Template(''' ... {% if score >= 80 %} ... A ... {% elif score >= 60 %} ... B ... {% else %} ... C ... {% endif %} ... ''') >>> t.code_builder def __func_name(): __result = [] __result.extend(['\n']) if score >= 80: __result.extend(['\nA\n']) elif score >= 60: __result.extend(['\nB\n']) else: __result.extend(['\nC\n']) __result.extend(['\n']) return "".join(__result)
代码中的 if
语句和缩进没有问题。下面再看一下 render
的结果:
>>> t.render({'score': 90}) '\n\nA\n\n' >>> t.render({'score': 70}) '\n\nB\n\n' >>> t.render({'score': 50}) '\n\nC\n\n'
对 if
语句的支持就这样实现了。有了此次经验下面让咱们一块儿来实现对 for
循环的支持吧。
模板中的 for
循环的语法以下:
{% for name in names %} ... {% endfor %}
从语法上能够看出来跟 if
语句是很类似了,甚至比 if
语句还要简单。只需在原有 if
语句代码 的基础上稍做修改就能够(完整版能够从 Github 上下载 template2b.py ):
class Template: # ... def _parse_text(self): # ... elif self.re_tag.match(token): # ... if tag_name in ('if', 'elif', 'else', 'for'): # ... elif tag_name in ('endif', 'endfor'): # ...
能够看到其实就是修改了两行代码。按照惯例咱们先来看一下生成的代码:
>>> from template2b import Template >>> t = Template(''' ... {% for number in numbers %} ... {{ number }} ... {% endfor %} ... ''') >>> t.code_builder def __func_name(): __result = [] __result.extend(['\n']) for number in numbers: __result.extend(['\n',str(number),'\n']) __result.extend(['\n']) return "".join(__result)
render
效果:
>>> t.render({'numbers': range(3)}) '\n\n0\n\n1\n\n2\n\n'
for ... endfor
语法就这样实现了。是否是很简单??可是还没完?
相信你们都知道在 python 中 for
循环其实还支持 break
和 else
。 下面咱们就一块儿来让咱们的模板引擎的 for
语法支持 break
和 else
(能够从 Github 上下载: template2c.py )
class Template: # ... def _parse_text(self): # ... elif self.re_tag.match(token): # ... if tag_name in ('if', 'elif', 'else', 'for'): # ... elif tag_name in ('break',): self.code_builder.add_line(tag) elif tag_name in ('endif', 'endfor'): # ...
能够看到,其实也是只增长了两行代码。效果:
from template2c import Template >>> t = Template(''' ... {% for number in numbers %} ... {% if number > 2 %} ... {% break %} ... {% else %} ... {{ number }} ... {% endif %} ... {% else %} ... no break ... {% endfor %} ... ''') >>> t.code_builder def __func_name(): __result = [] __result.extend(['\n']) for number in numbers: __result.extend(['\n ']) if number > 2: __result.extend(['\n ']) break __result.extend(['\n ']) else: __result.extend(['\n ',str(number),'\n ']) __result.extend(['\n']) else: __result.extend(['\n no break\n']) __result.extend(['\n']) return "".join(__result) >>> t.render({'numbers': range(3)}).replace('\n', '') ' 0 1 2 no break' >>> t.render({'numbers': range(4)}).replace('\n', '') ' 0 1 2 '
就这样咱们的模板引擎对 for
的支持算是比较完善了。 至于生成的代码里的换行和空格暂时先无论,留待以后优化代码的时候再处理。
咱们的 Template._parse_text
方法代码随着功能的增长已经变成下面这样了:
def _parse_text(self): """解析模板""" tokens = self.re_tokens.split(self.raw_text) for token in tokens: if self.re_variable.match(token): variable = token.strip('{} ') self.buffered.append('str({})'.format(variable)) elif self.re_comment.match(token): continue elif self.re_tag.match(token): self.flush_buffer() tag = token.strip('{%} ') tag_name = tag.split()[0] if tag_name in ('if', 'elif', 'else', 'for'): if tag_name in ('elif', 'else'): self.code_builder.backward() self.code_builder.add_line('{}:'.format(tag)) self.code_builder.forward() elif tag_name in ('break',): self.code_builder.add_line(tag) elif tag_name in ('endif', 'endfor'): self.code_builder.backward() else: self.buffered.append('{}'.format(repr(token)))
有什么问题呢?问题就是 for
循环里的代码太长了,咱们须要分割 for
循环里的 代码。好比把对变量,if/for
的处理封装到单独的方法里。
下面展现了一种方法(能够从 Github 下载 template2d.py ):
def _parse_text(self): """解析模板""" tokens = self.re_tokens.split(self.raw_text) handlers = ( (self.re_variable.match, self._handle_variable), # {{ variable }} (self.re_tag.match, self._handle_tag), # {% tag %} (self.re_comment.match, self._handle_comment), # {# comment #} ) default_handler = self._handle_string # 普通字符串 for token in tokens: for match, handler in handlers: if match(token): handler(token) break else: default_handler(token) def _handle_variable(self, token): """处理变量""" variable = token.strip('{} ') self.buffered.append('str({})'.format(variable)) def _handle_comment(self, token): """处理注释""" pass def _handle_string(self, token): """处理字符串""" self.buffered.append('{}'.format(repr(token))) def _handle_tag(self, token): """处理标签""" # 将前面解析的字符串,变量写入到 code_builder 中 # 由于标签生成的代码须要新起一行 self.flush_buffer() tag = token.strip('{%} ') tag_name = tag.split()[0] self._handle_statement(tag, tag_name) def _handle_statement(self, tag, tag_name): """处理 if/for""" if tag_name in ('if', 'elif', 'else', 'for'): # elif 和 else 以前须要向后缩进一步 if tag_name in ('elif', 'else'): self.code_builder.backward() # if True:, elif True:, else:, for xx in yy: self.code_builder.add_line('{}:'.format(tag)) # if/for 表达式部分结束,向前缩进一步,为下一行作准备 self.code_builder.forward() elif tag_name in ('break',): self.code_builder.add_line(tag) elif tag_name in ('endif', 'endfor'): # if/for 结束,向后缩进一步 self.code_builder.backward()
这样处理后是否是比以前那个都放在 _parse_text
方法里要好不少?
至此,咱们的模板引擎已经支持了以下语法:
变量: {{ variable }}
注释: {# comment #}
if
语句: {% if ... %} ... {% elif ... %} ... {% else %} ... {% endif %}
for
循环: {% for ... in ... %} ... {% break %} ... {% else %} ... {% endfor %}
以后的文章还将实现其余实用的模板语法,好比 include
, extends
模板继承等。
include
的语法(item.html 是个独立的模板文件, list.html 中 include item.html):
{# item.html #} <li>{{ item }}</li> {# list.html #} <ul> {% for name in names %} {% include "item.html" %} {% endfor %} </ul>
list.html 渲染后将生成相似下面这样的字符串:
<ul> <li>Tom</li> <li>Jim<li> </ul>
extends
的语法(base.html 是基础模板, child.html 继承 base.html 而后从新定义 base.html 中定义过的 block):
{# base.html #} <div id="content"> {% block content %} parent_content {% endblock content %} </div> <footer id="footer"> {% block footer %} (c) 2016 example.com {% endblock footer %} </footer>
child.html:
{% extends "base.html" %} {% block content %} child_content {{ block.super }} {% endblock content %}
child.html 渲染后将生成相似下面这样的字符串:
<div id="content"> child_content parent_content </div> <footer id="footer"> (c) 2016 example.com </footer>
那么,该如何实现 include
和 extends
功能呢? 我将在 第三篇文章 中向你详细的讲解。敬请期待。