\dE$dZddlmZddlmZddlmZddlmZddl 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 dZ3dee/e0fde/fdZ4dee/e0fde/fdZ5de e/ge1fde e/gdffdZ6dee/e0fde/fdZ7dee/e0fde/fdZ8 d(de0deeee0e2fdee2de2fdZ9dee-dee-fdZ:d ee,d!e2de e/ge1fdeeee0e2fd"ee+d#e ee/e0fge/fdeeeee2fddffd$Z;d ee,d!e2de e/ge1fddfd%ZdS))zu Context-free flattener/serializer for rendering Python objects, possibly complex or arbitrarily nested, as strings. ) iscoroutine)BytesIO)exc_info) extract_tb) GeneratorType) AnyCallable Coroutine GeneratorListMappingOptionalSequenceTupleTypeVarUnioncast)DeferredensureDeferred) nativeString)Failure)CDATACharRefCommentTagslot voidElements)FlattenerError UnfilledSlotUnsupportedType) IRenderableIRequestT.Nidatareturnct|tr|d}|dddddd}|S)a Escape some character or UTF-8 byte data for inclusion in an HTML or XML document, by replacing metacharacters (C{&<>}) 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$s 4lib/python3.11/site-packages/twisted/web/_flatten.pyescapeForContentr3Gs_$${{7## <<h ' ' / /g > > F FtW U UD KcZt|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/r1s r2attributeEscapingDoneOutsider6Zs-$${{7### Kr4writec&dtddffd }|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%Nc`t|dddS)N"s")r3r0)r$r7s r2_writez*writeWithAttributeEscaping.._writes2 t$$,,T9==>>>>>r4)bytes)r7r;s` r2writeWithAttributeEscapingr=ms7R?U?t?????? Mr4ct|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,r1s r2 escapedCDATAr@s<$${{7## << 2 3 33r4ct|tr|d}|dddd}|r|dddkr|d z }|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,r1s r2escapedCommentrEsr$${{7## <<w ' ' / /g > >D RSS T!!   Kr4nameslotDatadefaultcd|dddD]}|||vr ||cS||St|)zK Find the value of the named slot in the given stack of slot data. NrB)r)rFrGrH slotFrames r2 _getSlotValuerKsWddd^!!  TY%6%6T? " " "  N4   r4dctfddtdtffd }dtdtffd }||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. c,SN)cancel)_rLs r2z_fork..sr4resultr%c2||SrO)callback)rSd2s r2rUz_fork..callbacks F r4failurec2||SrO)errback)rWrVs r2rYz_fork..errbacks 7r4)rr#r addCallbacks)rLrUrYrVs` @r2_forkr[s 333344BqWNN8W%%% Ir4requestroot renderFactory dataEscaperc#R K|||fdtdttttfgtfdt t dttgtfdtttttfddff fd dttdttffd }t|ttfr|||dSt|tr*t|j |j}|VdSt|tr5|d |t!|j|d dSt|t$r5|d |t'|j|d dSt|t(r|j|j}|u|t1d|d|d} d| _||} | | } | VdS|js|jVdS|dt|jtr|jd} n|j} || |j D]m\} }t| tr| d} |d| zdz|tBtE|V|dn|jstG| tHvr6|d|jtJV|d| zdzdS|ddSt|tLtNtPfr|D]}|VdSt|tRr+d|j*fz}||ddSt|tr|tW|VdStY|rW|tj-t]t^ttttf|VdSt j0|r&|} | |VdStc|)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_r^r7r%Nc,t||||SrO)_flattenElement)rar_r^r7r\rGs r2 keepGoingz"_flattenElement..keepGoings$  WeX}k   r4rSc.|SrO) addCallback)rSrds r2keepGoingAsyncz'_flattenElement..keepGoingAsyncs!!),,,r4s z$Tag wants to be rendered by method "z)" but is not contained in any IRenderableFr)asciirDs=")r7r:r*sz&#%d;)r^)2 Flattenabler rr<r.rr!objectr rr-rrKrFrHrr@r$rrErappendrGrender ValueErrorclonelookupRenderMethodpoptagNamechildrenr/ attributesitemsr6r=rrr3tuplelistrrordinalr[r fromCoroutinerr providedByr )r\r]r7rGr^r_rg slotValue rendererName rootClone renderMethodrSrqkvelementescapedrds` ` @r2rcrcsb=H/<+0    uUCZ01589  , (  5HY$778$D E        -x 4-+9N------$ %%R$ kk$     D$  P$!$)Xt|DD i """"""" D% M$ l l49%%&&& f D' " "I$ g nTY''((( f D#  E$ &&&{  #$ ?<??? 5))I#I (;;LIIL!\'955F)F## # # # LLNNN F| )DM** * * * F d dlC ( ( #l))'22GGlG gO))++  DAq!S!! &HHW%% E$(U" # # #)/7QRW7X7X    E$KKKK = L11EE E$KKK)DM+;<< < < < E%'/D( ) ) ) ) ) E&MMMMM D5$ 6 7 7$ % %G)G$$ $ $ $ $ % % D' " "$T\O+ gnnW%%&&&&& D( # # $nU4[[))))))) T   $n  "Yx 4fkIJDQQ           % %$W%%id33333333d###r4c  Kg d dtddf fd }d fd t|||gdtg}|r$ |dj}t |d}t |t r |d{V}||n#t$r| Ynt$r}| g}|D]'} || jj d(||j dt||ttd d}~wwxYw|$ dS) 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}. rbsr%Nc|t|z tkr dSdSrO)rklen BUFFER_SIZE)rbufbufSize flushBuffers r2 bufferedWritez#_flattenTree..bufferedWritesD 23r77 k ! ! KMMMMM " !r4cbdkr'ddd=ddSdS)Nrr4)join)rrr7sr2rz!_flattenTree..flushBuffersA Q;; E#((3-- AAAGGG ;r4rBr])r%N)r<rcr3gi_framenextr-rrk StopIterationrp Exceptionf_localsrrr) r\r]r7rstackframereroots generatorrrrs ` @@@r2 _flattenTreerps( CG%D }b$@PQQE " ""I&E59ooG'8,, ( '------ LL ! ! ! !    IIKKKKK F F F IIKKKE" B B  Y/8@AAAA LL/ 0 0 0 E:hjjm+D+DEE E  F ",KMMMMMs A B!!E E BEEc>tt|||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)r\r]r7s r2flattenrs2 ,we<< = ==r4ctt||j}|fdt t t |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. c,SrO)getvalue)rQios r2rRzflattenString..sBKKMMr4)rrr7rfrrr<)r\r]rLrs @r2 flattenStringrsQ Brx((AMM))))***  # ##r4rO)?__doc__inspectrrrsysr tracebackrtypesrtypingrr r r r r rrrrrrtwisted.internet.deferrrtwisted.python.compatrtwisted.python.failurertwisted.web._stanrrrrrrtwisted.web.errorrrr twisted.web.iwebr!r"r#FlattenableRecursiver<r.rjrirr3r6r=r@rErKr[rcrrrr4r2rs'                                <;;;;;;;......******NNNNNNNNNNNNNNNNKKKKKKKKKK22222222 GCLL      #$  "D$./  !" h+,f6JJK    5,&uUCZ'8U&, UGVO $, ugtm,,,,^ 4uUCZ( 4U 4 4 4 4ucz*u(&*!! !x[(8 9:;!k "! !!!!"Xa[Xa[&N$ h N$ N$ UGVO $N$8GC$4567 N$ K( N$ 5,-u45 N$uY 556dBCN$N$N$N$bF h F'2F;CUGVO;TF FFFFR> h >'2>;CUGVO;T> d^>>>>8$8H-$[$Xe_$$$$$$r4