genshi/mirror: genshi/template/base.py comparison

comparison genshi/template/base.py @ 790:da90cee22560 trunk

Merged the custom-directives branch back into trunk.

author	cmlenz
date	Wed, 10 Sep 2008 20:53:09 +0000
parents	52219748e5c1
children	ae8727f7e1e1

comparison

equal deleted inserted replaced

-:31432f30a6fb
+:da90cee22560
 import sys
 from genshi.core import Attrs, Stream, StreamEventKind, START, TEXT, _ensure
 from genshi.input import ParseError
-__all__ = ['Context', 'Template', 'TemplateError', 'TemplateRuntimeError',
+__all__ = ['Context', 'DirectiveFactory', 'Template', 'TemplateError',
-'TemplateSyntaxError', 'BadDirectiveError']
+'TemplateRuntimeError', 'TemplateSyntaxError', 'BadDirectiveError']
 __docformat__ = 'restructuredtext en'
 class TemplateError(Exception):
 """Base exception class for errors related to template processing."""
 top = ctxt.pop()
 ctxt.pop()
 ctxt.frames[0].update(top)
-class TemplateMeta(type):
+class DirectiveFactoryMeta(type):
-"""Meta class for templates."""
+"""Meta class for directive factories."""
 def __new__(cls, name, bases, d):
 if 'directives' in d:
 d['_dir_by_name'] = dict(d['directives'])
 d['_dir_order'] = [directive[1] for directive in d['directives']]
 return type.__new__(cls, name, bases, d)
-class Template(object):
+class DirectiveFactory(object):
+"""Base for classes that provide a set of template directives.
+:since: version 0.6
+"""
+__metaclass__ = DirectiveFactoryMeta
+directives = []
+"""A list of `(name, cls)` tuples that define the set of directives
+provided by this factory.
+"""
+def compare_directives(self):
+"""Return a function that takes two directive classes and compares
+them to determine their relative ordering.
+"""
+def _get_index(cls):
+if cls in self._dir_order:
+return self._dir_order.index(cls)
+return 0
+return lambda a, b: cmp(_get_index(a[0]), _get_index(b[0]))
+def get_directive(self, name):
+"""Return the directive class for the given name.
+:param name: the directive name as used in the template
+:return: the directive class
+:see: `Directive`
+"""
+return self._dir_by_name.get(name)
+class Template(DirectiveFactory):
 """Abstract template base class.
 This class implements most of the template processing model, but does not
 specify the syntax of templates.
 """
-__metaclass__ = TemplateMeta
 EXEC = StreamEventKind('EXEC')
 """Stream event kind representing a Python code suite to execute."""
 EXPR = StreamEventKind('EXPR')
 self.filename = filename
 self.loader = loader
 self.lookup = lookup
 self.allow_exec = allow_exec
 self._init_filters()
+self._prepared = False
 if isinstance(source, basestring):
 source = StringIO(source)
 else:
 source = source
 try:
-self.stream = list(self._prepare(self._parse(source, encoding)))
+self._stream = self._parse(source, encoding)
 except ParseError, e:
 raise TemplateSyntaxError(e.msg, self.filepath, e.lineno, e.offset)
 def __getstate__(self):
 state = self.__dict__.copy()
 def _init_filters(self):
 self.filters = [self._flatten, self._eval, self._exec]
 if self.loader:
 self.filters.append(self._include)
+def _get_stream(self):
+if not self._prepared:
+self._stream = list(self._prepare(self._stream))
+self._prepared = True
+return self._stream
+stream = property(_get_stream)
 def _parse(self, source, encoding):
 """Parse the template.
 The parsing stage parses the template and constructs a list of

Mercurial > genshi > mirror

comparison genshi/template/base.py @ 790:da90cee22560 trunk