o b@@sdZddlmZddlmZddlmZddlmZddl m Z ddl m Z m Z mZmZmZmZmZmZmZmZmZmZddlmZmZdd lmZdd lmZdd lm Z m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'm(Z(m)Z)dd l*m+Z+m,Z,edZ-e Z. ee/e0e$e e"e#ee.dfee.ee.ddfe!ee.eee.e1e.fe+f Z2 dee/e0fde/fddZ3dee/e0fde/fddZ4de e/ge1fde e/gdffddZ5dee/e0fde/fddZ6dee/e0fde/fddZ7 d2de0deeee0e2fd ee2de2fd!d"Z8d#ee-dee-fd$d%Z9d&ee,d'e2de e/ge1fdeeee0e2fd(ee+d)e ee/e0fge/fdeeeee2fddffd*d+Z:d&ee,d'e2de e/ge1fddfd,d-Z;d&ee,d'e2de e/ge1fdedfd.d/Z}) with their entity equivalents (C{&<>}). This is used as an input to L{_flattenElement}'s C{dataEscaper} parameter. @param data: The string to escape. @return: The quoted form of C{data}. If C{data} is L{str}, return a utf-8 encoded string. utf-8&s&> isinstancestrencodereplacer#r06/usr/lib/python3/dist-packages/twisted/web/_flatten.pyescapeForContentCs r2cCst|tr |dS|S)aG Escape some character or UTF-8 byte data for inclusion in the top level of an attribute. L{attributeEscapingDoneOutside} actually passes the data through unchanged, because L{writeWithAttributeEscaping} handles the quoting of the text within attributes outside the generator returned by L{_flattenElement}; this is used as the C{dataEscaper} argument to that L{_flattenElement} call so that that generator does not redundantly escape its text output. @param data: The string to escape. @return: The string, unchanged, except for encoding. r%)r+r,r-r/r0r0r1attributeEscapingDoneOutsideVs  r3writecsdtddffdd }|S)aU Decorate a C{write} callable so that all output written is properly quoted for inclusion within an XML attribute value. If a L{Tag } C{x} is flattened within the context of the contents of another L{Tag } C{y}, the metacharacters (C{<>&"}) delimiting C{x} should be passed through unchanged, but the textual content of C{x} should still be quoted, as usual. For example: C{&}. That is the default behavior of L{_flattenElement} when L{escapeForContent} is passed as the C{dataEscaper}. However, when a L{Tag } C{x} is flattened within the context of an I{attribute} of another L{Tag } C{y}, then the metacharacters delimiting C{x} should be quoted so that it can be parsed from the attribute's value. In the DOM itself, this is not a valid thing to do, but given that renderers and slots may be freely moved around in a L{twisted.web.template} template, it is a condition which may arise in a document and must be handled in a way which produces valid output. So, for example, you should be able to get C{}. This should also be true for other XML/HTML meta-constructs such as comments and CDATA, so if you were to serialize a L{comment } in an attribute you should get C{}. Therefore in order to capture these meta-characters, flattening is done with C{write} callable that is wrapped with L{writeWithAttributeEscaping}. The final case, and hopefully the much more common one as compared to serializing L{Tag } and arbitrary L{IRenderable} objects within an attribute, is to serialize a simple string, and those should be passed through for L{writeWithAttributeEscaping} to quote without applying a second, redundant level of quoting. @param write: A callable which will be invoked with the escaped L{bytes}. @return: A callable that writes data with escaping. r#r$Ncst|dddS)N"s")r2r.r/r4r0r1_writesz*writeWithAttributeEscaping.._write)bytes)r4r7r0r6r1writeWithAttributeEscapingis)r9cCs t|tr |d}|ddS)z Escape CDATA for inclusion in a document. @param data: The string to escape. @return: The quoted form of C{data}. If C{data} is unicode, return a utf-8 encoded string. r%]]>s]]]]>r*r/r0r0r1 escapedCDATAs  r;cCsHt|tr |d}|dddd}|r"|dddkr"|d 7}|S) z Escape a comment for inclusion in a document. @param data: The string to escape. @return: The quoted form of C{data}. If C{data} is unicode, return a utf-8 encoded string. r%s--s- - r(r)N- r*r/r0r0r1escapedComments r?nameslotDatadefaultcCsD|dddD]}|dur||vr||Sq|dur|St|)zK Find the value of the named slot in the given stack of slot data. Nr<)r)r@rArB slotFramer0r0r1 _getSlotValues rDdcsLtfdddtdtffdd }dtdtffdd }||S) z Create a new L{Deferred} based on C{d} that will fire and fail with C{d}'s result or error, but will not modify C{d}'s callback type. cSN)cancel_)rEr0r1z_fork..resultr$c||SrG)callbackrMd2r0r1rO z_fork..callbackfailurecrNrG)errback)rTrQr0r1rUrSz_fork..errback)rr"r addCallbacks)rErOrUr0)rErRr1_forks  rWrequestroot renderFactory dataEscaperc#sV|||fdtdttttfgtfdttdttgtfdtttt tfddff fdd d t tdt tffd d }t |ttfrP|||dSt |t rdt |j |j}|VdSt |trz|d |t|j|d dSt |tr|d|t|j|ddSt |tr@|j|j}|dur|durtd|d|d} d| _||} | | } | VdS|js׈|jVdS|dt |jtr|jd} n|j} || |j D]%\} }t | tr| d} |d| d|t!t"|dV|dq|js%t#| t$vr:|d|jt%V|d| ddS|ddSt |t&t't(frV|D]}|VqKdSt |t)rkd|j*f}||ddSt |t rz|t+|VdSt,|r|t -t.t/t tttf|VdSt0|r|} | |dVdSt1|)at Make C{root} slightly more flat by yielding all its immediate contents as strings, deferreds or generators that are recursive calls to itself. @param request: A request object which will be passed to L{IRenderable.render}. @param root: An object to be made flatter. This may be of type C{unicode}, L{str}, L{slot}, L{Tag }, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or an object that implements L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @param slotData: A L{list} of L{dict} mapping L{str} slot names to data with which those slots will be replaced. @param renderFactory: If not L{None}, an object that provides L{IRenderable}. @param dataEscaper: A 1-argument callable which takes L{bytes} or L{unicode} and returns L{bytes}, quoted as appropriate for the rendering context. This is really only one of two values: L{attributeEscapingDoneOutside} or L{escapeForContent}, depending on whether the rendering context is within an attribute or not. See the explanation in L{writeWithAttributeEscaping}. @return: An iterator that eventually writes L{bytes} to C{write}. It can yield other iterators or L{Deferred}s; if it yields another iterator, the caller will iterate it; if it yields a L{Deferred}, the result of that L{Deferred} will be another generator, in which case it is iterated. See L{_flattenTree} for the trampoline that consumes said values. newRootr[rZr4r$Ncst||||SrG)_flattenElement)r\r[rZr4)rXrAr0r1 keepGoing s z"_flattenElement..keepGoingrMcs |SrG) addCallbackrP)r^r0r1keepGoingAsyncs z'_flattenElement..keepGoingAsyncs z$Tag wants to be rendered by method "z)" but is not contained in any IRenderableFr'asciir>s="r6r5r(sz&#%d;)rZ)2 Flattenablerrr8r,r r objectr rr+rrDr@rBrr;r#rr?rappendrArender ValueErrorclonelookupRenderMethodpoptagNamechildrenr- attributesitemsr3r9rrr2tuplelistrrordinalrWr fromCoroutinerr providedByr)rXrYr4rArZr[r` slotValue rendererName rootClone renderMethodrMrjkvelementescapedr0)r^rXrAr1r]s1                           r]c st|||gdtg}|rmz|dj}t|d}t|tr#|IdH}Wn?ty1|Yn8tyc}z'|g}|D] }| |jj dq@| |j dt ||t t dd}~ww| ||s dSdS)a Make C{root} into an iterable of L{bytes} and L{Deferred} by doing a depth first traversal of the tree. @param request: A request object which will be passed to L{IRenderable.render}. @param root: An object to be made flatter. This may be of type C{unicode}, L{bytes}, L{slot}, L{Tag }, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or something providing L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @return: A C{Deferred}-returning coroutine that resolves to C{None}. Nr<rY)r]r2gi_framenextr+r StopIterationri Exceptionrdf_localsrrr) rXrYr4stackframeryeroots generatorr0r0r1 _flattenTreels.        rcCstt|||S)a Incrementally write out a string representation of C{root} using C{write}. In order to create a string representation, C{root} will be decomposed into simpler objects which will themselves be decomposed and so on until strings or objects which can easily be converted to strings are encountered. @param request: A request object which will be passed to the C{render} method of any L{IRenderable} provider which is encountered. @param root: An object to be made flatter. This may be of type L{str}, L{bytes}, L{slot}, L{Tag }, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or something that provides L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @return: A L{Deferred} which will be called back with C{None} when C{root} has been completely flattened into C{write} or which will be errbacked if an unexpected exception occurs. )rr)rXrYr4r0r0r1flattensrcs4tt||j}|fddttt|S)a Collate a string representation of C{root} into a single string. This is basically gluing L{flatten} to an L{io.BytesIO} and returning the results. See L{flatten} for the exact meanings of C{request} and C{root}. @return: A L{Deferred} which will be called back with a single UTF-8 encoded string as its result when C{root} has been completely flattened or which will be errbacked if an unexpected exception occurs. crFrG)getvaluerIior0r1rKrLzflattenString..)rrr4r_rrr8)rXrYrEr0rr1 flattenStrings rrG)>__doc__inspectrrrsysr tracebackrtypesrtypingrrr r r r r rrrrrtwisted.internet.deferrrtwisted.python.compatrtwisted.python.failurertwisted.web._stanrrrrrrtwisted.web.errorrrrtwisted.web.iwebr r!r"FlattenableRecursiver8r,rcrbr2r3r9r;r?rDrWr]rrrr0r0r0r1s     8        /     *  "