htmltmpl.Template Class Reference

Public Member Functions
def	__init__ (self, version, file, include_files, tokens, compile_params, debug=0)
def	is_uptodate (self, compile_params=None)
def	tokens (self)
def	file (self)
def	debug (self, debug)
def	__getstate__ (self)
	PRIVATE METHODS #. More...
def	__setstate__ (self, dict)
def	DEB (self, str)

Detailed Description

This class represents a compiled template.

    This class provides storage and methods for the compiled template
    and associated metadata. It's serialized by pickle if we need to
    save the compiled template to disk in a precompiled form.

    You should never instantiate this class directly. Always use the
    <em>TemplateManager</em> or <em>TemplateCompiler</em> classes to
    create the instances of this class.

    The only method which you can directly use is the <em>is_uptodate</em>
    method.

Constructor & Destructor Documentation

__init__()

def htmltmpl.Template.__init__	(		self,
			version,
			file,
			include_files,
			tokens,
			compile_params,
			debug = 0
	)

Constructor.
    @hidden

Member Function Documentation

__getstate__()

def htmltmpl.Template.__getstate__

(

self

)

PRIVATE METHODS #.

Used by pickle when the class is serialized.
    Remove the 'debug' attribute before serialization.
    @hidden

__setstate__()

def htmltmpl.Template.__setstate__	(		self,
			dict
	)

Used by pickle when the class is unserialized.
    Add the 'debug' attribute.
    @hidden

DEB()

def htmltmpl.Template.DEB	(		self,
			str
	)

Print debugging message to stderr.
    @hidden

debug()

def htmltmpl.Template.debug	(		self,
			debug
	)

Get debugging state.
    @hidden

file()

def htmltmpl.Template.file

(

self

)

Get filename of the main file of this template.
    @hidden

is_uptodate()

def htmltmpl.Template.is_uptodate	(		self,
			compile_params = None
	)

Check whether the compiled template is uptodate.

    Return true if this compiled template is uptodate.
    Return false, if the template source file was changed on the
    disk since it was compiled.
    Works by comparison of modification times.
    Also takes modification times of all included templates
    into account.

    @header is_uptodate(compile_params=None)
    @return True if the template is uptodate, false otherwise.

    @param compile_params Only for internal use.
    Do not use this optional parameter. It's intended only for
    internal use by the <em>TemplateManager</em>.

tokens()

def htmltmpl.Template.tokens

(

self

)

Get tokens of this template.
    @hidden

---

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

• Websites/planet.webkit.org/planet/planet/htmltmpl.py