summaryrefslogtreecommitdiff
path: root/pystache/template_spec.py
diff options
context:
space:
mode:
Diffstat (limited to 'pystache/template_spec.py')
-rw-r--r--pystache/template_spec.py43
1 files changed, 43 insertions, 0 deletions
diff --git a/pystache/template_spec.py b/pystache/template_spec.py
new file mode 100644
index 0000000..c33f30b
--- /dev/null
+++ b/pystache/template_spec.py
@@ -0,0 +1,43 @@
+# coding: utf-8
+
+"""
+This module supports customized (aka special or specified) template loading.
+
+"""
+
+# TODO: finish the class docstring.
+class TemplateSpec(object):
+
+ """
+ A mixin or interface for specifying custom template information.
+
+ The "spec" in TemplateSpec can be taken to mean that the template
+ information is either "specified" or "special."
+
+ A view should subclass this class only if customized template loading
+ is needed. The following attributes allow one to customize/override
+ template information on a per view basis. A None value means to use
+ default behavior for that value and perform no customization. All
+ attributes are initialized to None.
+
+ Attributes:
+
+ template: the template as a string.
+
+ template_rel_path: the path to the template file, relative to the
+ directory containing the module defining the class.
+
+ template_rel_directory: the directory containing the template file, relative
+ to the directory containing the module defining the class.
+
+ template_extension: the template file extension. Defaults to "mustache".
+ Pass False for no extension (i.e. extensionless template files).
+
+ """
+
+ template = None
+ template_rel_path = None
+ template_rel_directory = None
+ template_name = None
+ template_extension = None
+ template_encoding = None