浅析python的string.Template

    今天心血来潮从某篇blog上面看到python的string模块里面的Template类的使用，于是查了python官方的文档，参见这里：

http://docs.python.org/library/string.html   上面说如果要换一个delimiter的话，可以继承一个Template的子类，然后覆盖它的类属性delimiter，然后就可以了。常规途径这样去做是没有问题的。就象以下代码：

 

#!/usr/bin/python
#coding :utf-8
from string import Template


class MyTemplate(Template):
    """docstring for MyTemplate"""
    delimiter = '#'


def _test():
    s = '#who likes #what'
    t = MyTemplate(s)
    d = {'who': 'jianpx', 'what': 'mac'}
    print t.substitute(d)
    print MyTemplate.delimiter
    print Template.delimiter


if __name__ == '__main__':
    _test()

 

 

这个结果是正确的。但是我又想如果能在类初始化的时候指定delimiter就好了。于是我尝试这样去做：

 

#!/usr/bin/python
#coding :utf-8
from string import Template
import re as _re


class MyTemplate(Template):
    """docstring for MyTemplate"""
    #delimiter = '#'
    def __init__(self, template, delimiter=Template.delimiter):
        super(MyTemplate, self).__init__(template)
        MyTemplate.delimiter = delimiter


def _test():
    s = '#who likes #what'
    t = MyTemplate(s, delimiter='#')
    d = {'who': 'jianpx', 'what': 'mac'}
    print t.substitute(d)
    print MyTemplate.delimiter
    print Template.delimiter
    print MyTemplate.pattern.match(s)


if __name__ == '__main__':
    _test()

 

 

但是结果却跟我想的不一样。。。上面的输出结果是： 

 

#who likes #what

#

$

None

说明类里面的delimiter属性虽然被替换了，但是替换的时候没有效。于是查了python的源码，发现了原来Template使用了元类metaclass来实现的，以下是源码：

class _TemplateMetaclass(type):
    pattern = r"""
    %(delim)s(?:
      (?P<escaped>%(delim)s) |   # Escape sequence of two delimiters
      (?P<named>%(id)s)      |   # delimiter and a Python identifier
      {(?P<braced>%(id)s)}   |   # delimiter and a braced identifier
      (?P<invalid>)              # Other ill-formed delimiter exprs
    )
    """

    def __init__(cls, name, bases, dct):
        super(_TemplateMetaclass, cls).__init__(name, bases, dct)
        if 'pattern' in dct:
            pattern = cls.pattern
        else:
            pattern = _TemplateMetaclass.pattern % {
                'delim' : _re.escape(cls.delimiter),
                'id'    : cls.idpattern,
                }
        cls.pattern = _re.compile(pattern, _re.IGNORECASE | _re.VERBOSE)

class Template:
    """A string class for supporting $-substitutions."""
    __metaclass__ = _TemplateMetaclass

    delimiter = '$'
    idpattern = r'[_a-z][_a-z0-9]*'

    def __init__(self, template):
        self.template = template

 

Template的源码只截取了一部分，够了，因为足以说明问题了。

 

 

这里简单解析为什么会出现上面的情况： 就是因为substitute函数是用Template类的pattern（Regex object）做正则替换的， 主要原因就是这个pattern属性在元类里的init函数已经构造好了，然后到Template类的时候已经生成好了（这个不知道大家能不能理解，其实就是利用元类new了一个Template类的时候），所以再在Template子类里面修改delimiter（其实delimiter就是用来生成pattern的）已经没有用了，来不及了。

 

 

所以这里大家以后如果要subclass就要用第一种方法了。如果要改变delimiter，其实还可以通过改变pattern实现。就如文档上说的，我们也可以修改类的pattern属性，只要在调用substitute之前就行了，就像这样：

 

 

    import re as _re
    deli = '#'
    idp = r'[_a-z][_a-z0-9]*'
    pattern = r"""
    %(delim)s(?:
      (?P<escaped>%(delim)s) |   # Escape sequence of two delimiters
      (?P<named>%(id)s)      |   # delimiter and a Python identifier
      {(?P<braced>%(id)s)}   |   # delimiter and a braced identifier
      (?P<invalid>)              # Other ill-formed delimiter exprs
    )
    """
    pattern = pattern % {'delim': _re.escape(deli), 'id': idp}
    pattern = _re.compile(pattern, _re.IGNORECASE | _re.VERBOSE)
    YourTemplate.pattern = pattern
    t = YourTemplate('#who likes #what')
    print t.substitute({'who': 'jianpx', 'what': 'python'})