o r|a@@sdZddlmZddlmZmZmZddlmZm Z ddl m Z ddl m Z ddlmZmZddlmZdd lmZGd d d eZd S) z= This module provides a Renderer class to render templates. )defaults)TemplateNotFoundError MissingTags is_string) ContextStackKeyNotFoundError)Loader)ParsedTemplate) context_get RenderEngine) SpecLoader) TemplateSpecc@seZdZdZ        d-ddZeddZddZd d Zd d Z d dZ d.ddZ ddZ ddZ ddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,ZdS)/Renderera A class for rendering mustache templates. This class supports several rendering options which are described in the constructor's docstring. Other behavior can be customized by subclassing this class. For example, one can pass a string-string dictionary to the constructor to bypass loading partials from the file system: >>> partials = {'partial': 'Hello, {{thing}}!'} >>> renderer = Renderer(partials=partials) >>> # We apply print to make the test work in Python 3 after 2to3. >>> print(renderer.render('{{>partial}}', {'thing': 'world'})) Hello, world! To customize string coercion (e.g. to render False values as ''), one can subclass this class. For example: class MyRenderer(Renderer): def str_coerce(self, val): if not val: return '' else: return str(val) Nc Cs|durtj}|durtj}|durtj}|durtj}|dur#tj}|dur*tj}|dur1tj}t|t r9|g}d|_ ||_ ||_ ||_ ||_||_||_||_||_dS)a Construct an instance. Arguments: file_encoding: the name of the encoding to use by default when reading template files. All templates are converted to unicode prior to parsing. Defaults to the package default. string_encoding: the name of the encoding to use when converting to unicode any byte strings (type str in Python 2) encountered during the rendering process. This name will be passed as the encoding argument to the built-in function unicode(). Defaults to the package default. decode_errors: the string to pass as the errors argument to the built-in function unicode() when converting byte strings to unicode. Defaults to the package default. search_dirs: the list of directories in which to search when loading a template by name or file name. If given a string, the method interprets the string as a single directory. Defaults to the package default. file_extension: the template file extension. Pass False for no extension (i.e. to use extensionless template files). Defaults to the package default. partials: an object (e.g. a dictionary) for custom partial loading during the rendering process. The object should have a get() method that accepts a string and returns the corresponding template as a string, preferably as a unicode string. If there is no template with that name, the get() method should either return None (as dict.get() does) or raise an exception. If this argument is None, the rendering process will use the normal procedure of locating and reading templates from the file system -- using relevant instance attributes like search_dirs, file_encoding, etc. escape: the function used to escape variable tag values when rendering a template. The function should accept a unicode string (or subclass of unicode) and return an escaped string that is again unicode (or a subclass of unicode). This function need not handle strings of type `str` because this class will only pass it unicode strings. The constructor assigns this function to the constructed instance's escape() method. To disable escaping entirely, one can pass `lambda u: u` as the escape function, for example. One may also wish to consider using markupsafe's escape function: markupsafe.escape(). This argument defaults to the package default. missing_tags: a string specifying how to handle missing tags. If 'strict', an error is raised on a missing tag. If 'ignore', the value of the tag is the empty string. Defaults to the package default. N)rZ DECODE_ERRORSZ TAG_ESCAPEZ FILE_ENCODINGZTEMPLATE_EXTENSIONZ MISSING_TAGSZ SEARCH_DIRSZSTRING_ENCODING isinstancestr_context decode_errorsescape file_encodingfile_extension missing_tagspartials search_dirsstring_encoding) selfrrrrrrrrr3/usr/lib/python3/dist-packages/pystache/renderer.py__init__1s2F  zRenderer.__init__cCs|jS)zG Return the current rendering context [experimental]. )rrrrrcontextszRenderer.contextcCst|S)aK Coerce a non-string value to a string. This method is called whenever a non-string is encountered during the rendering process when a string is needed (e.g. if a context value for string interpolation is not a string). To customize string coercion, you can override this method. )rrvalrrr str_coerces zRenderer.str_coercecCst|tr|S||S)zT Convert a basestring to unicode, preserving any unicode subclass. )rrrsrrr_to_unicode_softs  zRenderer._to_unicode_softcCst||S)zU Convert a basestring to a string with type unicode (not subclass). )rr%r#rrr_to_unicode_hardszRenderer._to_unicode_hardcCst|||S)z Convert a basestring to unicode (preserving any unicode subclass), and escape it. Returns a unicode string (not subclass). )rrr%r#rrr_escape_to_unicodeszRenderer._escape_to_unicodecCs|dur|j}t|||jS)a Convert a byte string to unicode, using string_encoding and decode_errors. Arguments: b: a byte string. encoding: the name of an encoding. Defaults to the string_encoding attribute for this instance. Raises: TypeError: Because this method calls Python's built-in unicode() function, this method raises the following exception if the given string is already unicode: TypeError: decoding Unicode is not supported N)rrr)rbencodingrrrrsz Renderer.strcCst|j|j|j|jdS)zE Create a Loader instance using current attributes. )r extensionZ to_unicoder)rrrrrrrrr _make_loaders zRenderer._make_loadercs|fdd}|S)zC Return a function that loads a template by name. cs |SN) load_name) template_nameloaderrr load_templates z3Renderer._make_load_template..load_template)r+)rr1rr/r_make_load_templates zRenderer._make_load_templatecs*jdur Sjfdd}|S)zB Return a function that loads a partial by name. Ncs4|}|durtdt|tf|S)Nz!Name %s not found in partials: %s)getrreprtyper&)nametemplaterrrr load_partial s  z1Renderer._make_load_partial..load_partial)rr2)rr9rr8r_make_load_partials zRenderer._make_load_partialcCs2|j}|tjkr dS|tjkrdStdt|)z@ Return whether missing_tags is set to strict. TFz$Unsupported 'missing_tags' value: %s)rrstrictignore Exceptionr4r rrr_is_missing_tags_stricts   z Renderer._is_missing_tags_strictcs$||r Sfdd}|S)zZ Return the resolve_partial function to pass to RenderEngine.__init__(). cs z|WStyYdSwN)r)r6r9rrresolve_partial6s   z7Renderer._make_resolve_partial..resolve_partial)r:r>)rrBrrAr_make_resolve_partial+s  zRenderer._make_resolve_partialcCs|rtSdd}|S)zZ Return the resolve_context function to pass to RenderEngine.__init__(). cSs"zt||WStyYdSwr?)r r)stackr6rrrresolve_contextGs   z7Renderer._make_resolve_context..resolve_context)r>r )rrErrr_make_resolve_context>szRenderer._make_resolve_contextcCs,|}|}t|j|j|||jd}|S)z@ Return a RenderEngine instance for rendering. )literalrrErBZto_str)rFrCr r&r'r")rrErBenginerrr_make_render_engineOszRenderer._make_render_enginecCs|}||S)z@ Load a template by name from the file system. )r2)rr.r1rrrr1aszRenderer.load_templatecOsV|}t|trt|}||}n||}|gt|}|j|g|Ri|S)zH Render the template associated with the given object. )r+rr r loadZ load_objectlist_render_string)robjrkwargsr0r7rrr_render_objectis   zRenderer._render_objectcO*|}||}|j|g|Ri|S)z Render the template with the given name using the given context. See the render() docstring for more information. )r+r-rL)rr.rrNr0r7rrr render_names zRenderer.render_namecOrP)z Render the template at the given path using the given context. Read the render() docstring for more information. )r+readrL)rZ template_pathrrNr0r7rrr render_paths zRenderer.render_pathcs.|fdd}|j|g|Ri|S)zL Render the given template string using the given context. cs ||Sr,renderrHrDr7rr z)Renderer._render_string..)r& _render_finalrr7rrN render_funcrrWrrLs  zRenderer._render_stringcOs(tj|i|}||_|}|||S)z Arguments: render_func: a function that accepts a RenderEngine and ContextStack instance and returns a template rendering as a unicode string. )rZcreaterrI)rr\rrNrDrHrrrrZs zRenderer._render_finalcsftr|jg|Ri|Sttr'fdd}|j|g|Ri|S|jg|Ri|S)a Render the given template string, view template, or parsed template. Returns a unicode string. Prior to rendering, this method will convert a template that is a byte string (type str in Python 2) to unicode using the string_encoding and decode_errors attributes. See the constructor docstring for more information. Arguments: template: a template string that is unicode or a byte string, a ParsedTemplate instance, or another object instance. In the final case, the function first looks for the template associated to the object by calling this class's get_associated_template() method. The rendering process also uses the passed object as the first element of the context stack when rendering. *context: zero or more dictionaries, ContextStack instances, or objects with which to populate the initial context stack. None arguments are skipped. Items in the *context list are added to the context stack in order so that later items in the argument list take precedence over earlier items. **kwargs: additional key-value data to add to the context stack. As these arguments appear after all items in the *context list, in the case of key conflicts these values take precedence over all items in the *context list. cs ||Sr,rTrVrWrrrXrYz!Renderer.render..)rrLrr rZrOr[rrWrrUs    zRenderer.render)NNNNNNNNr,)__name__ __module__ __qualname____doc__rpropertyrr"r%r&r'rr+r2r:r>rCrFrIr1rOrQrSrLrZrUrrrrrs@ m          rN)r`ZpystacherZpystache.commonrrrZpystache.contextrrZpystache.loaderrZpystache.parsedr Zpystache.renderenginer r Zpystache.specloaderr Zpystache.template_specr objectrrrrrs