tfFdZddlmZddlmZddlmZddlmZddl m Z ddl m Z ddl mZmZmZmZmZmZmZmZmZmZmZmZdd lmZmZdd lmZdd lm Z dd l!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+ddl,m-Z-m.Z.edZ/eZ0 ee1e2e&e"e$e%ee0dfee0ee0ddfe#ee0eee0e3e0fe-f Z4 dZ5d:dZ6d:dZ7d;dZ8d:dZ9d:dZ: dd)ZdAd7Z?dBd9Z@dS)Czu Context-free flattener/serializer for rendering Python objects, possibly complex or arbitrarily nested, as strings. ) annotations) iscoroutine)BytesIO)exc_info) extract_tb) GeneratorType) AnyCallable Coroutine GeneratorListMappingOptionalSequenceTupleTypeVarUnioncast)DeferredensureDeferred) nativeString)Failure)CDATACharRefCommentTagslot voidElements)FlattenerError UnfilledSlotUnsupportedType) IRenderableIRequestT.NidataUnion[bytes, str]returnbytesct|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&s> isinstancestrencodereplacer%s S/var/www/surfInsights/venv3-11/lib/python3.11/site-packages/twisted/web/_flatten.pyescapeForContentr5Gs_$${{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/r0r1r3s r4attributeEscapingDoneOutsider8Zs-$${{7### Kr6writeCallable[[bytes], object]Callable[[bytes], None]cdfd }|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(r'Nonec`t|dddS)N"s")r5r2)r%r9s r4_writez*writeWithAttributeEscaping.._writes2 t$$,,T9==>>>>>r6)r%r(r'r=)r9r@s` r4writeWithAttributeEscapingrBms)R?????? Mr6ct|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.r3s r4 escapedCDATArEs<$${{7## << 2 3 33r6ct|tr|d}|dd}|r|dddkr|dz }|S)a Within comments the sequence C{-->} can be mistaken as the end of the comment. To ensure consistent parsing and valid output the sequence is replaced with C{-->}. Furthermore, whitespace is added when a comment ends in a dash. This is done to break the connection of the ending C{-} with the closing C{-->}. @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-->N- r.r3s r4escapedCommentrKsb$${{7## << * *D RSS T!!   Kr6namer0slotData-Sequence[Optional[Mapping[str, Flattenable]]]defaultOptional[Flattenable] Flattenableclt|D]}|||vr ||cS||St|)zK Find the value of the named slot in the given stack of slot data. )reversedr )rLrMrO slotFrames r4 _getSlotValuerUsUh''!!  TY%6%6T? " " "  N4   r6d Deferred[T]crtfdd fd }d fd }||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)_rVs r4z_fork..sr6resultr$r'c2||SrZ)callback)r^d2s r4r`z_fork..callbacks F r6failurerc2||SrZ)errback)rbras r4rdz_fork..errbacks 7r6)r^r$r'r$)rbrr'r)r addCallbacks)rVr`rdras` @r4_forkrfst 333344BNN8W%%% Ir6requestOptional[IRequest]root)List[Optional[Mapping[str, Flattenable]]] renderFactoryOptional[IRenderable] dataEscaper$Callable[[Union[bytes, str]], bytes]MGenerator[Union[Generator[Any, Any, Any], Deferred[Flattenable]], None, None]c #K|||fd"fd d#fd }t|ttfr|||dSt|tr*t |j|j}|VdSt|tr5|d|t|j |ddSt|tr5|d|t|j |ddSt|tr |j|j}|u|t!d|d|d} d| _||} | | } | VdS|js|jVdS|dt|jtr|jd} n|j} || |jD]m\} }t| tr| d} |d| zdz|t2t5|V|dn|jst7| t8vr6|d|jt:V|d| zdzdS|ddSt|t<t>t@fr|D]}|VdSt|tBr+d |j"fz}||ddSt|tFr|tI|VdStK|rW|tGj&tOtPtFtRtTtRf|VdStWj,|r&|} | |!VdSt[|)$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. newRootrQrmrnrkrlr9r:r'@Generator[Union[Flattenable, Deferred[Flattenable]], None, None]c,t||||SrZ)_flattenElement)rqrmrkr9rgrMs r4 keepGoingz"_flattenElement..keepGoings$  WeX}k   r6r^Deferred[Flattenable]c.|SrZ) addCallback)r^rus r4keepGoingAsyncz'_flattenElement..keepGoingAsyncs!!),,,r6s z&#%d;)rk) rqrQrmrnrkrlr9r:r'rr)r^rvr'rv).r/r(r0rrUrLrOrrEr%rrKrappendrMrender ValueErrorclonelookupRenderMethodpoptagNamechildrenr1 attributesitemsr8rBrrr5tuplelistrrordinalrrfr fromCoroutinerr rQobjectr" providedByr!)rgrir9rMrkrmry slotValue rendererName rootClone renderMethodr^rkvelementescapedrus` ` @r4rtrtsEb=H/<+0         ------$ %%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###r6r=c  Kg d d fd }d fd t|||gdtg}|r t|d }t|tr |d{V}||n#t $r|Ynt$r|}g}|D].}|j %||j j d /|t||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(r'r=c|t|z tkr dSdSrZ)r{len BUFFER_SIZE)rbufbufSize flushBuffers r4 bufferedWritez#_flattenTree..bufferedWritesD 23r77 k ! ! KMMMMM " !r6cbdkr'ddd=ddSdS)Nrr6)join)rrr9sr4rz!_flattenTree..flushBuffersA Q;; E#((3-- AAAGGG ;r6NrHri)rr(r'r=)r'r=)rtr5nextr/rr{ StopIterationr Exceptiongi_framef_localsrrr) rgrir9rstackreroots generatorrrrs ` @@@r4 _flattenTreerss( CG }b$@PQQ-E " "59ooG'8,, ( '------ LL ! ! ! !    IIKKKKK F F FE" F F %1LL!3!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)rgrir9s r4flattenrs2 ,we<< = ==r6Deferred[bytes]ctt||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,SrZ)getvalue)r\ios r4r]zflattenString..sBKKMMr6)rrr9rxrrr()rgrirVrs @r4 flattenStringrsQ Brx((AMM))))***  # ##r6)r%r&r'r()r9r:r'r;rZ)rLr0rMrNrOrPr'rQ)rVrWr'rW)rgrhrirQr9r:rMrjrkrlrmrnr'ro)rgrhrirQr9r:r'r=)rgrhrirQr9r:r'r)rgrhrirQr'r)A__doc__ __future__rinspectrrrsysr tracebackrtypesrtypingr r r r r rrrrrrrtwisted.internet.deferrrtwisted.python.compatrtwisted.python.failurertwisted.web._stanrrrrrrtwisted.web.errorrr r!twisted.web.iwebr"r#r$FlattenableRecursiver(r0rrQrr5r8rBrErKrUrfrtrrrrAr6r4rs; #"""""                             <;;;;;;;......******NNNNNNNNNNNNNNNNKKKKKKKKKK22222222 GCLL      #$  "D$./  !" h+,f6JJK    &&,,,,^ 4 4 4 4.&*!!!!!"&N$N$N$N$bEEEEP>>>>8$$$$$$r6