Commit e7f409eb by Chris Jerdonek

Merge pull request #29 (2) "style and import changes"

From: https://github.com/kennethreitz/pystache/commit/20bec630efed85dd0e4eaa751da2af3db7f64f3e
Into: issue_29

This commit makes mostly spacing and docstring tweaks.  Not all changes
from the parent were incorporated into the commit.

Conflicts:
	pystache/template.py
	pystache/view.py
parents 77f508bc 20bec630
# coding: utf-8
"""
This module provides a Loader class.
"""
import os import os
class Loader(object): class Loader(object):
template_extension = 'mustache' template_extension = 'mustache'
template_path = '.' template_path = '.'
template_encoding = None template_encoding = None
def load_template(self, template_name, template_dirs=None, encoding=None, extension=None): def load_template(self, template_name, template_dirs=None, encoding=None, extension=None):
'''Returns the template string from a file or throws IOError if it non existent''' """
Find and load the given template, and return it as a string.
Raises an IOError if the template cannot be found.
"""
if None == template_dirs: if None == template_dirs:
template_dirs = self.template_path template_dirs = self.template_path
if encoding is not None: if encoding is not None:
self.template_encoding = encoding self.template_encoding = encoding
if extension is not None: if extension is not None:
self.template_extension = extension self.template_extension = extension
file_name = template_name + '.' + self.template_extension file_name = template_name + '.' + self.template_extension
# Given a single directory we'll load from it # Given a single directory, we'll load from it.
if isinstance(template_dirs, basestring): if isinstance(template_dirs, basestring):
file_path = os.path.join(template_dirs, file_name) file_path = os.path.join(template_dirs, file_name)
return self._load_template_file(file_path) return self._load_template_file(file_path)
# Given a list of directories we'll check each for our file # Given a list of directories, we'll check each for our file.
for path in template_dirs: for path in template_dirs:
file_path = os.path.join(path, file_name) file_path = os.path.join(path, file_name)
if os.path.exists(file_path): if os.path.exists(file_path):
return self._load_template_file(file_path) return self._load_template_file(file_path)
# TODO: we should probably raise an exception of our own type.
raise IOError('"%s" not found in "%s"' % (template_name, ':'.join(template_dirs),)) raise IOError('"%s" not found in "%s"' % (template_name, ':'.join(template_dirs),))
def _load_template_file(self, file_path): def _load_template_file(self, file_path):
'''Loads and returns the template file from disk''' """
Read a template file, and return it as a string.
"""
f = open(file_path, 'r') f = open(file_path, 'r')
try: try:
template = f.read() template = f.read()
if self.template_encoding: if self.template_encoding:
template = unicode(template, self.template_encoding) template = unicode(template, self.template_encoding)
finally: finally:
f.close() f.close()
return template return template
\ No newline at end of file
# coding: utf-8
import re import re
import cgi import cgi
import collections import collections
import os
import copy from .loader import Loader
try: try:
import markupsafe import markupsafe
escape = markupsafe.escape escape = markupsafe.escape
literal = markupsafe.Markup literal = markupsafe.Markup
except ImportError: except ImportError:
escape = lambda x: cgi.escape(unicode(x)) escape = lambda x: cgi.escape(unicode(x))
literal = unicode literal = unicode
...@@ -25,38 +27,37 @@ except ImportError: ...@@ -25,38 +27,37 @@ except ImportError:
class Modifiers(dict): class Modifiers(dict):
"""Dictionary with a decorator for assigning functions to keys.""" """Dictionary with a decorator for assigning functions to keys."""
def set(self, key): def set(self, key):
""" """
Decorator function to set the given key to the decorated function. Return a decorator that assigns the given function to the given key.
>>> modifiers = {}
>>> @modifiers.set('P')
... def render_tongue(self, tag_name=None, context=None):
... return ":P %s" % tag_name
>>> modifiers
{'P': <function render_tongue at 0x...>}
"""
def setter(func): >>> modifiers = {}
>>> @modifiers.set('P')
... def render_tongue(self, tag_name=None, context=None):
... return ":P %s" % tag_name
>>> modifiers
{'P': <function render_tongue at 0x...>}
"""
def decorate(func):
self[key] = func self[key] = func
return func return func
return setter return decorate
class Template(object): class Template(object):
tag_re = None tag_re = None
otag = '{{' otag = '{{'
ctag = '}}' ctag = '}}'
modifiers = Modifiers() modifiers = Modifiers()
def __init__(self, template=None, context=None, **kwargs): def __init__(self, template=None, context=None, **kwargs):
from view import View from .view import View
self.template = template self.template = template
...@@ -94,18 +95,22 @@ class Template(object): ...@@ -94,18 +95,22 @@ class Template(object):
# Callable # Callable
if it and check_callable(it): if it and check_callable(it):
replacer = it(inner) replacer = it(inner)
# Dictionary # Dictionary
elif it and hasattr(it, 'keys') and hasattr(it, '__getitem__'): elif it and hasattr(it, 'keys') and hasattr(it, '__getitem__'):
if section[2] != '^': if section[2] != '^':
replacer = self._render_dictionary(inner, it) replacer = self._render_dictionary(inner, it)
# Lists # Lists
elif it and hasattr(it, '__iter__'): elif it and hasattr(it, '__iter__'):
if section[2] != '^': if section[2] != '^':
replacer = self._render_list(inner, it) replacer = self._render_list(inner, it)
# Other objects # Other objects
elif it and isinstance(it, object): elif it and isinstance(it, object):
if section[2] != '^': if section[2] != '^':
replacer = self._render_dictionary(inner, it) replacer = self._render_dictionary(inner, it)
# Falsey and Negated or Truthy and Not Negated # Falsey and Negated or Truthy and Not Negated
elif (not it and section[2] == '^') or (it and section[2] != '^'): elif (not it and section[2] == '^') or (it and section[2] != '^'):
replacer = self._render_dictionary(inner, it) replacer = self._render_dictionary(inner, it)
...@@ -130,9 +135,12 @@ class Template(object): ...@@ -130,9 +135,12 @@ class Template(object):
def _render_dictionary(self, template, context): def _render_dictionary(self, template, context):
self.view.context_list.insert(0, context) self.view.context_list.insert(0, context)
template = Template(template, self.view) template = Template(template, self.view)
out = template.render() out = template.render()
self.view.context_list.pop(0) self.view.context_list.pop(0)
return out return out
def _render_list(self, template, listing): def _render_list(self, template, listing):
...@@ -167,15 +175,22 @@ class Template(object): ...@@ -167,15 +175,22 @@ class Template(object):
@modifiers.set('=') @modifiers.set('=')
def _change_delimiter(self, tag_name): def _change_delimiter(self, tag_name):
"""Changes the Mustache delimiter.""" """
Change the current delimiter.
"""
self.otag, self.ctag = tag_name.split(' ') self.otag, self.ctag = tag_name.split(' ')
self._compile_regexps() self._compile_regexps()
return '' return ''
@modifiers.set('{') @modifiers.set('{')
@modifiers.set('&') @modifiers.set('&')
def render_unescaped(self, tag_name): def render_unescaped(self, tag_name):
"""Render a tag without escaping it.""" """
Render a tag without escaping it.
"""
return literal(self.view.get(tag_name, '')) return literal(self.view.get(tag_name, ''))
def render(self, encoding=None): def render(self, encoding=None):
......
import os.path # coding: utf-8
"""
This module provides a View class.
"""
import re import re
from types import * from types import UnboundMethodType
from .loader import Loader
from .template import Template from .template import Template
def get_or_attr(context_list, name, default=None): def get_or_attr(context_list, name, default=None):
"""
Find and return an attribute from the given context.
"""
if not context_list: if not context_list:
return default return default
...@@ -19,8 +30,10 @@ def get_or_attr(context_list, name, default=None): ...@@ -19,8 +30,10 @@ def get_or_attr(context_list, name, default=None):
return getattr(obj, name) return getattr(obj, name)
except AttributeError: except AttributeError:
pass pass
return default return default
class View(object): class View(object):
template_name = None template_name = None
...@@ -31,6 +44,7 @@ class View(object): ...@@ -31,6 +44,7 @@ class View(object):
def __init__(self, template=None, context=None, **kwargs): def __init__(self, template=None, context=None, **kwargs):
self.template = template self.template = template
context = context or {} context = context or {}
context.update(**kwargs) context.update(**kwargs)
...@@ -38,6 +52,7 @@ class View(object): ...@@ -38,6 +52,7 @@ class View(object):
def get(self, attr, default=None): def get(self, attr, default=None):
attr = get_or_attr(self.context_list, attr, getattr(self, attr, default)) attr = get_or_attr(self.context_list, attr, getattr(self, attr, default))
if hasattr(attr, '__call__') and type(attr) is UnboundMethodType: if hasattr(attr, '__call__') and type(attr) is UnboundMethodType:
return attr() return attr()
else: else:
...@@ -49,16 +64,26 @@ class View(object): ...@@ -49,16 +64,26 @@ class View(object):
encoding=self.template_encoding, extension=self.template_extension) encoding=self.template_encoding, extension=self.template_extension)
def get_template(self, template_name): def get_template(self, template_name):
if not self.template: if not self.template:
template_name = self._get_template_name(template_name) template_name = self._get_template_name(template_name)
self.template = self.load_template(template_name) self.template = self.load_template(template_name)
return self.template return self.template
# TODO: consider removing the template_name parameter and using
# self.template_name instead.
def _get_template_name(self, template_name=None): def _get_template_name(self, template_name=None):
"""TemplatePartial => template_partial """
Takes a string but defaults to using the current class' name or Return the name of this Template instance.
the `template_name` attribute
If no template_name parameter is provided, this method returns the
class name modified as follows, for example:
TemplatePartial => template_partial
Otherwise, it returns the given template_name.
""" """
if template_name: if template_name:
return template_name return template_name
...@@ -78,7 +103,8 @@ class View(object): ...@@ -78,7 +103,8 @@ class View(object):
return context return context
def render(self, encoding=None): def render(self, encoding=None):
return Template(self.get_template(self.template_name), self).render(encoding=encoding) template = Template(self.get_template(self.template_name), self)
return template.render(encoding=encoding)
def __contains__(self, needle): def __contains__(self, needle):
return needle in self.context or hasattr(self, needle) return needle in self.context or hasattr(self, needle)
...@@ -97,4 +123,4 @@ class View(object): ...@@ -97,4 +123,4 @@ class View(object):
raise AttributeError("Attribute '%s' does not exist in View" % attr) raise AttributeError("Attribute '%s' does not exist in View" % attr)
def __str__(self): def __str__(self):
return self.render() return self.render()
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment