Ki{9 d Z ddlmZ dZddlZddlmc mZ dZ G d dej Z G d d e Z G d
d e Z
G d d
e Z G d de Z G d de Z G d de Z G d de Z G d de Z G d de Z G d de Z G d d e
Z G d d e Z G d d!e
Z G d" d#e Z G d$ d%e Z G d& d'e Z G d( d)e Z G d* d+e Z G d, d-e
Z G d. d/e
Z G d0 d1e
Z G d2 d3e Z! G d4 d5e Z" G d6 d7e Z# G d8 d9e Z$ G d: d;e Z% G d< d=e Z&y)>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 e Zd ZdZdZ dZ d fd Zed ZddZ ddZ
d fd Z d fd Z d Z
d
Z fd Zd Zdd
Zd ZdddZddZddZ xZS ) MathElementz Base class for MathML elements.Nc |j D ci c]% \ }}|j | j | ' }}}t | | j
j fi | | j | yc c}}w )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 o/home/jay/workspace/scripts/.codegraph-venv/lib/python3.12/site-packages/docutils/utils/math/mathml_elements.pyr zMathElement.__init__E sg 8B7G7G7IJtq!!'')TZZ]*JJ
00;F; H Ks *A8c j t | t rt | j S t | S N)
isinstanceboolstrr )r s r r zMathElement.a_strW s' a q6<<> !1v
c | D cg c]
}t | }}| j r$|j t | j | j | j j k7 r |j d| j t | dd r|j d || j
D cg c] \ }}| | d| c}}z
}| j ddj | dS c c}w c c}}w ) z"Return full string representation.z
nchildren=switchNz switch=True=(, )) reprtextappend nchildrenr getattrr tagjoin)r childargsr r s r __repr__zMathElement.__repr__^ s )-.U .. 99 KKTYY ( >>T^^ 5 5 5 KK*T^^$45 6 44 ( KK
& $**,H$!Q!-A3au HH((1TYYt_ -Q// / Is C7<
C< C<c | j rt | j }ndj d | D }| j d| dS )z/Return concise, informal string representation.r) c 3 " K | ] }| y wr ).0r2 s r z&MathElement.__str__..o s :EwZ :s
r( r* )r, r+ r1 r0 )r r3 s r __str__zMathElement.__str__j sA 99 ?D99 :T ::D((1TF!$$r$ c D t | || j | y r )r setr )r keyvaluer s r r< zMathElement.setr s
CE*+r$ c F | j dk( rt d| d t |t r| |_ nZ| j r@t | t | z | j kD r t d| d| j d |D ] }| |_ t | || y )Nr Element "z" does not take children.z
" takes only children)r. TypeErrorr! r parentlenr __setitem__)r r= r> er s r rE zMathElement.__setitem__u s >>Q iv-F GH H e[ ) EL~~#d)c%j"84>>"I )D6 t~~>N +!, - -
C'r$ c R | j duxr t | | j k\ S )z;Return boolean indicating whether children may be appended.N)r. rD r s r is_fullzMathElement.is_full s# ~~T)Ic$i4>>.IIr$ c t | | _ | j }|/|j r |j }||j r |S )z:Close element and return first non-full anchestor or None.)rD r. rC rI )r rC s r closezMathElement.close sD T V^^%5]]F V^^%5
r$ c | j r1| j rd| j d}nd}t d| d| d t | | | |_ | j r| j
S | S )aL 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 rA zdoes not take childrenr@ z" .)rI r. rB r r- rC rK )r elementstatusr s r r- zMathElement.append st <<>~~&t~~&6i@1ivRxq 9: :
w <<>::< r$ c : | }|D ] }| j | } |S )ziSequentially append `elements`. Return new "current node".
Raise TypeError if overfull.
)r- )r elements current_noderN s r r zMathElement.extend s,
0G ;;w/L 0r$ c | | }| |= |S r r7 )r indexrN s r popzMathElement.pop s u+ Kr$ c | j d | j j S | j d dk( S # t $ r Y yw xY w)zReturn True, if `self` or an ancestor has ``display='block'``.
Used to find out whether we are in inline vs. displayed maths.
displayFblock)getrC in_blockAttributeErrorrH s r rZ zMathElement.in_block sU
88I &
{{++-- xx "g-- "
s A A
A
c 2 t j | || y)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_xmlzMathElement.indent_xml s $u%r$ c | j D ]i }t |t s+|j r |j j |_ |j
sK|j
j |_ k y)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 rF s r unindent_xmlzMathElement.unindent_xml sR )A a+ vv )r$ c t j | |xs dd } |j dd }|S # t $ r% |j dj | d }Y |S w xY w)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 )r] tostringreplacerB encode)r encodingxmls r toxmlzMathElement.toxml sn kk$ 5I/46 M++h(9:C
M++hooh 79KLC
Ms 2 *A A returnNone)rr r# ))z r r )r
__module__ __qualname____doc__r. rC r staticmethodr r4 r: r< rE rI rK r- r rU rZ ra rg rp
__classcell__r s @r r r < sq )I-
F- $
0%, (J,
. &
)r$ r c e Zd ZdZy)MathRowz:Base class for elements treating content as a single mrow.Nr ru rv rw r7 r$ r r| r| s Dr$ r| c 2 e Zd ZdZdZd fd Z fdZ xZS )
MathSchemazBase 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 R |j dd | _ t | |i | y )Nr& F)rU r& r r )r r kwargsr s r r zMathSchema.__init__ s' jj51
(-f-r$ c t | | }| j r(| j r| d | d c| d< | d< d| _ |S )z2Append element. Normalize order and close if full.rt F)r r- r& rI )r rN rR r s r r- zMathSchema.append sI w~g. ;;4<<>!%b48 DHd2h DKr$ rq )r ru rv rw r. r r- ry rz s @r r r s I. r$ r c ( e Zd ZdZdZd fd Z xZS )rd zgToken Element: contains textual data instead of children.
Expect text data on initialisation.
r c t | di | t |t t j
f st
d| d t | | _ y )Nz0MathToken element expects `str` or number, not "z".r7 )r r r! r# numbersNumber
ValueErrorr, )r r, r r s r r zMathToken.__init__ sO
&:&$gnn 56 &&*V2 / 0
0I r$ rq )r ru rv rw r. r ry rz s @r rd rd s I r$ rd c e Zd ZdZy)mathz8Top-level MathML element, a single mathematical formula.Nr} r7 r$ r r r % s Br$ r c e Zd ZdZy)mtextz*Arbitrary text with no notational meaning.Nr} r7 r$ r r r , s 4r$ r c e Zd ZdZy)mizCIdentifier, such as a function name, variable or symbolic constant.Nr} r7 r$ r r r 0 s Mr$ r c e Zd ZdZy)mnzNumeric 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`.)
Nr} r7 r$ r r r 4 s r$ r c e Zd ZdZy)moa Operator, 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.
Nr} r7 r$ r r r ? s r$ r c e Zd ZdZdZy)mspacezBlank space, whose size is set by its attributes.
Takes additional attributes `depth`, `height`, `width`.
Takes no children and no text.
See also `mphantom`.
r Nr ru rv rw r. r7 r$ r r r K s Ir$ r c * e Zd ZdZddZ fdZ xZS )mrowzyGeneric element to group children as a horizontal row.
Removed on closing if not required (see `mrow.close()`).
c ddd}| j D ]e \ }}|dv rJ|rH|j | r7|| j |j | j || |f }|j || g y)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 rY r1 re r< )r other
delimitersr r s r transfer_attributeszmrow.transfer_attributes_ s~ #T2
JJL DAq&&199Q<"1
** 1 ,,Z];Q?AA IIaO r$ c | j }|It | dk( r;| d } ||t | j | < ||_ | j
| t | ! S # t t
f$ r Y yw xY w)z|Close element and return first non-full anchestor or None.
Remove if it has only one child element.
N r ) rC rD listrT r[ r r r rK )r rC r2 r s r rK z
mrow.closem s
#d)q.GE
38tF|))$/0 %
$ $U +w} #J/
s $A' 'A98A9rq )r ru rv rw r rK ry rz s @r r r Y s
r$ r c e Zd ZdZy)mfraczAFractions or fraction-like objects such as binomial coefficients.Nr} r7 r$ r r r s Kr$ r c e Zd ZdZdZy)msqrtz Square root. See also `mroot`.r Nr r7 r$ r r r s
(Ir$ r c e Zd ZdZy)mrootz/Roots with an explicit index. See also `msqrt`.Nr} r7 r$ r r r 9r$ r c e Zd ZdZy)mstylezStyle Change.
In modern browsers, is equivalent to an element.
However, may still be relevant for compatibility with
MathML implementations outside browsers.
Nr} r7 r$ r r r s r$ r c e Zd ZdZy)merrorz#Display contents as error messages.Nr} r7 r$ r r r s -r$ r c e Zd ZdZdZy)menclosezRenders content inside an enclosing notation...
... specified by the notation attribute.
Non-standard but still required by Firefox for boxed expressions.
r Nr r7 r$ r r r s Ir$ r c e Zd ZdZy)mpaddedz Adjust space around content.Nr} r7 r$ r r r s &r$ r c e Zd ZdZdZy)mphantomz8Placeholder: Rendered invisibly but dimensions are kept.r Nr r7 r$ r r r s
BIr$ r c e Zd ZdZy)msubz$Attach a subscript to an expression.Nr} r7 r$ r r r s .r$ r c e Zd ZdZy)msupz&Attach a superscript to an expression.Nr} r7 r$ r r r s 0r$ r c e Zd ZdZdZy)msubsupz;Attach both a subscript and a superscript to an expression. Nr r7 r$ r r r s
EIr$ r c e Zd ZdZy)munderz0Attach an accent or a limit under an expression.Nr} r7 r$ r r r s :r$ r c e Zd ZdZy)moverz/Attach an accent or a limit over an expression.Nr} r7 r$ r r r r r$ r c e Zd ZdZy)
munderoverz;Attach accents or limits both under and over an expression.Nr} r7 r$ r r r s Er$ r c e Zd ZdZy)mtablezTable or matrix element.Nr} r7 r$ r r r s "r$ r c e Zd ZdZy)mtrzRow in a table or a matrix.Nr} r7 r$ r r r %r$ r c e Zd ZdZy)mtdzCell in a table or a matrixNr} r7 r$ r r r r r$ r )'rw
__future__r
__docformat__r xml.etree.ElementTreeetree ElementTreer] GLOBAL_ATTRIBUTESElementr r| r rd r r r r r r r r r r r r r r r r r r r r r r r r r7 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$