k7i{9 S r SSKJr SrSSKrSSKJs Jr Sr " S S\R 5 r " S S \ 5 r " S
S \ 5 r
" S S
\ 5 r " S S\ 5 r " S S\5 r " S S\5 r " S S\5 r " S S\5 r " S S\ 5 r " S S\ 5 r " S S \
5 r " S S \ 5 r " S S!\
5 r " S" S#\ 5 r " S$ S%\ 5 r " S& S'\ 5 r " S( S)\ 5 r " S* S+\ 5 r " S, S-\
5 r " S. S/\
5 r " S0 S1\
5 r " S2 S3\ 5 r! " S4 S5\ 5 r" " S6 S7\ 5 r# " S8 S9\ 5 r$ " S: S;\ 5 r% " S< S=\ 5 r&g)>ah MathML element classes based on `xml.etree`.
The module is intended for programmatic generation of MathML
and covers the part of `MathML Core`_ that is required by
Docutil's *TeX math to MathML* converter.
This module is PROVISIONAL:
the API is not settled and may change with any minor Docutils version.
.. _MathML Core: https://www.w3.org/TR/mathml-core/
) annotationsreStructuredTextN)classdir displaystyleidnonce scriptlevelstyletabindexc ^ \ rS rSrSrSr Sr SU 4S jjr\S 5 r SS jr
SS jr SU 4S jjr SU 4S jjr
S
rS rU 4S jrS
rSS jrS rSSS jjrSS jrSS jrSrU =r$ ) MathElement< z Base class for MathML elements.Nc > UR 5 VVs0 s H% u p4UR 5 U R U5 _M' nnn[ TU ] " U R
R 40 UD6 U R U5 gs snnf )a Set up node with `children` and `attributes`.
Attribute names are normalised to lowercase.
You may use "CLASS" to set a "class" attribute.
Attribute values are converted to strings
(with True -> "true" and False -> "false").
>>> math(CLASS='test', level=3, split=True)
math(class='test', level='3', split='true')
>>> math(CLASS='test', level=3, split=True).toxml()
''
N)itemslowera_strsuper__init__ __class____name__extend)selfchildren
attributeskvattribr s ]/home/james-whalen/.local/lib/python3.13/site-packages/docutils/utils/math/mathml_elements.pyr MathElement.__init__E sh 8B7G7G7IJ7Itq!'')TZZ]*7IJ
00;F; H Ks ,A;c t [ U [ 5 ( a [ U 5 R 5 $ [ U 5 $ N)
isinstanceboolstrr )r s r r MathElement.a_strW s* a q6<<> !1v
c ( U Vs/ s H n[ U5 PM nnU R ( a$ UR [ U R 5 5 U R U R R :w a UR SU R 35 [ U SS5 ( a UR S5 X R
5 VVs/ s H u p4Uc M
U SU< 3PM snn-
nU R SSR U5 S3$ s snf s snnf ) z"Return full string representation.z
nchildren=switchNz switch=True=(, )) reprtextappend nchildrenr getattrr tagjoin)r childargsr r s r __repr__MathElement.__repr__^ s )-.U . 99 KKTYY ( >>T^^ 5 5 5 KK*T^^$45 6 44 ( ( KK
& **,H,$!! A3au ,HH((1TYYt_ -Q// / Is D D Dc U R ( a [ U R 5 nOSR S U 5 5 nU R SU S3$ )z/Return concise, informal string representation.r, c 3 & # U H o v M g 7fr" ).0r5 s r &MathElement.__str__..o s :TEwZTs r+ r- )r/ r. r4 r3 )r r6 s r __str__MathElement.__str__j sA 99 ?D99 :T ::D((1TF!$$r' c B > [ TU ] XR U5 5 g r" )r setr )r keyvaluer s r rB MathElement.setr s
CE*+r' c \ > U R S:X a [ SU S35 e[ U[ 5 ( a Xl OaU R ( aA [ U 5 [ U5 - U R : a [ SU SU R S35 eU H nXl M [ TU ] X5 g )Nr Element "z" does not take children.z
" takes only children)r1 TypeErrorr# r parentlenr __setitem__)r rC rD er s r rL MathElement.__setitem__u s >>Q iv-F GH H e[ ) ) L~~#d)c%j"84>>"I )D6 t~~>N +!, - -
C'r' c \ U R SL=( a [ U 5 U R : $ )z;Return boolean indicating whether children may be appended.N)r1 rK r s r is_fullMathElement.is_full s# ~~T)Ic$i4>>.IIr' c [ U 5 U l U R nUb; UR 5 ( a& UR nUb UR 5 ( a M& U$ )z:Close element and return first non-full anchestor or None.)rK r1 rJ rQ )r rJ s r closeMathElement.close sJ T V^^%5%5]]F V^^%5%5
r' c > U R 5 ( a6 U R ( a SU R S3nOSn[ SU SU S35 e[ TU ] U5 Xl U R 5 ( a U R
5 $ U $ )a$ Append `element` and return new "current node" (insertion point).
Append as child element and set the internal `parent` attribute.
If self is already full, raise TypeError.
If self is full after appending, call `self.close()`
(returns first non-full anchestor or None) else return `self`.
z takes only rH zdoes not take childrenrG z" .)rQ r1 rI r r0 rJ rT )r elementstatusr s r r0 MathElement.append sv <<>>~~&t~~&6i@1ivRxq 9: :
w <<>>::< r' c > U nU H nU R U5 nM U$ )zYSequentially append `elements`. Return new "current node".
Raise TypeError if overfull.
)r0 )r elements current_noderX s r r MathElement.extend s'
G ;;w/L r' c X nX U$ r" r; )r indexrX s r popMathElement.pop s + Kr' c U R S5 c U R R 5 $ U R S5 S:H $ ! [ a gf = f)zReturn True, if `self` or an ancestor has ``display='block'``.
Used to find out whether we are in inline vs. displayed maths.
displayFblock)getrJ in_blockAttributeErrorrP s r rg MathElement.in_block sU
88I &
{{++-- xx "g-- "
s A
AAc 2 [ R " XU5 g)zFormat XML output with indents.
Use with care:
Formatting whitespace is permanently added to the
`text` and `tail` attributes of `self` and anchestors!
N)ETindent)r spacelevels r
indent_xmlMathElement.indent_xml s $u%r' c U R 5 Hz n[ U[ 5 ( d0 UR ( a UR R 5 Ul UR
( d M[ UR
R 5 Ul M| g)zStrip whitespace at the end of `text` and `tail` attributes...
to revert changes made by the `indent_xml()` method.
Use with care, trailing whitespace from the original may be lost.
N)iterr# MathTokenr/ rstriptail)r rM s r unindent_xmlMathElement.unindent_xml sR A a++ vvv r' c [ R " X=( d SSS9n UR SS5 nU$ ! [ a% UR SR U5 S5 n U$ f = f)a Return an XML representation of the element.
By default, the return value is a `str` instance. With an explicit
`encoding` argument, the result is a `bytes` instance in the
specified encoding. The XML default encoding is UTF-8, any other
encoding must be specified in an XML document header.
Name and encoding handling match `xml.dom.minidom.Node.toxml()`
while `etree.Element.tostring()` returns `bytes` by default.
unicodeF)short_empty_elementsu zs )rk tostringreplacerI encode)r encodingxmls r toxmlMathElement.toxml sl kk$ 5I/46 M++h(9:C
M++hooh 79KLC
Ms 4 +A#"A#)r1 returnNone)r r% ))z r r" )r
__module__ __qualname____firstlineno____doc__r1 rJ r staticmethodr r7 r? rB rL rQ rT r0 r ra rg ro rv r __static_attributes__
__classcell__r s @r r r < sv )I-
F- $
0%, (J,
. &
) r' r c \ rS rSrSrSrg)MathRow z:Base class for elements treating content as a single mrow.r; Nr r r r r r r; r' r r r s Dr' r c @ ^ \ rS rSrSrSrSU 4S jjrU 4S jrSrU =r $ )
MathSchema zBase class for schemata expecting 2 or more children.
The special attribute `switch` indicates that the last two child
elements are in reversed order and must be switched before XML-export.
See `msub` for an example.
c T > UR SS5 U l [ TU ] " U0 UD6 g )Nr) F)ra r) r r )r r kwargsr s r r MathSchema.__init__ s' jj51
(-f-r' c > [ TU ] U5 nU R ( a- U R 5 ( a U S U S sU S' U S' SU l U$ )z2Append element. Normalize order and close if full.r F)r r0 r) rQ )r rX r] r s r r0 MathSchema.append sK w~g. ;;4<<>>!%b48 DHd2h DKr' )r) r )
r r r r r r1 r r0 r r r s @r r r s I. r' r c 4 ^ \ rS rSrSrSrSU 4S jjrSrU =r$ )rs i z_Token Element: contains textual data instead of children.
Expect text data on initialisation.
r c > [ TU ] " S0 UD6 [ U[ [ R
45 ( d [
SU S35 e[ U5 U l g )Nz0MathToken element expects `str` or number, not "z".r; )r r r# r% numbersNumber
ValueErrorr/ )r r/ r r s r r MathToken.__init__ sR
&:&$gnn 566 &&*V2 / 0
0I r' )r/ r ) r r r r r r1 r r r r s @r rs rs s I r' rs c \ rS rSrSrSrg)mathi% z8Top-level MathML element, a single mathematical formula.r; Nr r; r' r r r % s Br' r c \ rS rSrSrSrg)mtexti, z*Arbitrary text with no notational meaning.r; Nr r; r' r r r , s 4r' r c \ rS rSrSrSrg)mii0 zCIdentifier, such as a function name, variable or symbolic constant.r; Nr r; r' r r r 0 s Mr' r c \ rS rSrSrSrg)mni4 zNumeric literal.
>>> mn(3.41).toxml()
'3.41'
Normally a sequence of digits with a possible separator (a dot or a comma).
(Values with comma must be specified as `str`.)
r; Nr r; r' r r r 4 s r' r c \ rS rSrSrSrg)moi? zOperator, Fence, Separator, or Accent.
>>> mo('<').toxml()
'<'
Besides operators in strict mathematical meaning, this element also
includes "operators" like parentheses, separators like comma and
semicolon, or "absolute value" bars.
r; Nr r; r' r r r ? s r' r c \ rS rSrSrSrSrg)mspaceiK zBlank space, whose size is set by its attributes.
Takes additional attributes `depth`, `height`, `width`.
Takes no children and no text.
See also `mphantom`.
r r; Nr r r r r r1 r r; r' r r r K s Ir' r c 6 ^ \ rS rSrSrSS jrU 4S jrSrU =r$ )mrowiY zqGeneric element to group children as a horizontal row.
Removed on closing if not required (see `mrow.close()`).
c SSS.nU R 5 Hn u p4US; aR U( aK UR U5 ( a5 X# R UR U5 R X# 5 U45 nUR X45 Mp g)zTransfer attributes from self to other.
"List values" (class, style) are appended to existing values,
other values replace existing values.
z; )r r N)r rf r4 rt rB )r other
delimitersr r s r transfer_attributesmrow.transfer_attributes_ ss #T2
JJLDA&&199Q<<"
** 1 ,,Z];Q?AA IIaO !r' c > U R nUbH [ U 5 S:X a9 U S n X![ U5 R U 5 ' Xl U R
U5 [ TU ]! 5 $ ! [ [
4 a gf = f)zlClose element and return first non-full anchestor or None.
Remove if it has only one child element.
N r ) rJ rK listr` rh r r r rT )r rJ r5 r s r rT
mrow.closem s}
#d)q.GE
38tF|))$/0 %
$ $U +w} #J/
s "A' 'A:9A:r; r ) r r r r r r rT r r r s @r r r Y s
r' r c \ rS rSrSrSrg)mfraci zAFractions or fraction-like objects such as binomial coefficients.r; Nr r; r' r r r s Kr' r c \ rS rSrSrSrSrg)msqrti z Square root. See also `mroot`.r r; Nr r; r' r r r s
(Ir' r c \ rS rSrSrSrg)mrooti z/Roots with an explicit index. See also `msqrt`.r; Nr r; r' r r r 9r' r c \ rS rSrSrSrg)mstylei zStyle Change.
In modern browsers, is equivalent to an element.
However, may still be relevant for compatibility with
MathML implementations outside browsers.
r; Nr r; r' r r r s r' r c \ rS rSrSrSrg)merrori z#Display contents as error messages.r; Nr r; r' r r r s -r' r c \ rS rSrSrSrSrg)menclosei zRenders content inside an enclosing notation...
... specified by the notation attribute.
Non-standard but still required by Firefox for boxed expressions.
r r; Nr r; r' r r r s Ir' r c \ rS rSrSrSrg)mpaddedi z Adjust space around content.r; Nr r; r' r r r s &r' r c \ rS rSrSrSrSrg)mphantomi z8Placeholder: Rendered invisibly but dimensions are kept.r r; Nr r; r' r r r s
BIr' r c \ rS rSrSrSrg)msubi z$Attach a subscript to an expression.r; Nr r; r' r r r s .r' r c \ rS rSrSrSrg)msupi z&Attach a superscript to an expression.r; Nr r; r' r r r s 0r' r c \ rS rSrSrSrSrg)msubsupi z;Attach both a subscript and a superscript to an expression. r; Nr r; r' r r r s
EIr' r c \ rS rSrSrSrg)munderi z0Attach an accent or a limit under an expression.r; Nr r; r' r r r s :r' r c \ rS rSrSrSrg)moveri z/Attach an accent or a limit over an expression.r; Nr r; r' r r r r r' r c \ rS rSrSrSrg)
munderoveri z;Attach accents or limits both under and over an expression.r; Nr r; r' r r r s Er' r c \ rS rSrSrSrg)mtablei zTable or matrix element.r; Nr r; r' r r r s "r' r c \ rS rSrSrSrg)mtri zRow in a table or a matrix.r; Nr r; r' r r r %r' r c \ rS rSrSrSrg)mtdi zCell in a table or a matrixr; Nr r; r' r r r r r' r )'r
__future__r
__docformat__r xml.etree.ElementTreeetree ElementTreerk GLOBAL_ATTRIBUTESElementr r r rs r r r r r r r r r r r r r r r r r r r r r r r r r; r' r r s
#"
" "
l"** lpEk E 2 $C7 C5I 5N N [ # 7 # LLJ LG
:J :W .W .w 'g '
w /: /1: 1j $;T ;:D :F F#[ #&' &&' &r'