scripts.templateloader.TemplateLoader Class Reference

Inheritance diagram for scripts.templateloader.TemplateLoader:

Public Member Functions
def	__init__ (self, root, subpaths, conditions={})
def	TryLoad (self, name, more_conditions={})
def	Load (self, name, more_conditions={})

Detailed Description

Loads template files from a path.

Definition at line 20 of file templateloader.py.

Constructor & Destructor Documentation

__init__()

def scripts.templateloader.TemplateLoader.__init__	(		self,
			root,
			subpaths,
			conditions = {}
	)

Initializes loader.

Args:
root - a string, the directory under which the templates are stored.
subpaths - a list of strings, subpaths of root in search order.
conditions - a dictionary from strings to booleans.  Any conditional
expression must be a key in the map.

Definition at line 23 of file templateloader.py.

    def __init__(self, root, subpaths, conditions={}):
        """Initializes loader.
 
    Args:
      root - a string, the directory under which the templates are stored.
      subpaths - a list of strings, subpaths of root in search order.
      conditions - a dictionary from strings to booleans.  Any conditional
        expression must be a key in the map.
    """
        self._root = root
        self._subpaths = subpaths
        self._conditions = conditions
        self._cache = {}
 

Member Function Documentation

Load()

def scripts.templateloader.TemplateLoader.Load	(		self,
			name,
			more_conditions = {}
	)

Returns contents of template file as a string, or raises an exception.

Definition at line 54 of file templateloader.py.

    def Load(self, name, more_conditions={}):
        """Returns contents of template file as a string, or raises an exception."""
        template = self.TryLoad(name, more_conditions)
        if template is not None:  # Can be empty string
            return template
        raise Exception("Could not find template '%s' on %s / %s" %
                        (name, self._root, self._subpaths))
 

TryLoad()

def scripts.templateloader.TemplateLoader.TryLoad	(		self,
			name,
			more_conditions = {}
	)

Returns content of template file as a string, or None of not found.

Definition at line 37 of file templateloader.py.

    def TryLoad(self, name, more_conditions={}):
        """Returns content of template file as a string, or None of not found."""
        conditions = dict(self._conditions, **more_conditions)
        cache_key = (name, tuple(sorted(conditions.items())))
        if cache_key in self._cache:
            return self._cache[cache_key]
 
        for subpath in self._subpaths:
            template_file = os.path.join(self._root, subpath, name)
            if os.path.exists(template_file):
                template = ''.join(open(template_file).readlines())
                template = self._Preprocess(template, template_file, conditions)
                self._cache[cache_key] = template
                return template
 
        return None
 

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/tools/dom/scripts/templateloader.py