7 fAFdZddlmZddlZddlmZmZmZddlm Z ddl m Z m Z ddl mZddlmZdd lmZdd lmZerdd lmZdd lmZdd lmZddlmZejeZddZ GddZ!Gdde!Z"Gdde"Z#GddZ$dS)zUtility code for "Doc fields". "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. ) annotationsN) TYPE_CHECKINGAnycast)nodes)ElementNode)addnodes)__)logging) get_node_line)Inliner)ObjectDescription)BuildEnvironment) TextlikeNodenodenodes.field_bodyreturnboolct|dkrdSt|dkr*|ddD]}t|tjsdS t|dtjrdSdS)zCTrue if the node only contains one paragraph (and system messages).rFNT)len isinstancersystem_message paragraph)rsubnodes K/var/www/equiseq/venv/lib/python3.11/site-packages/sphinx/util/docfields.py_is_single_paragraphrs 4yyA~~u TQABBx  Ggu';<< uu $q'5?++t 5ceZdZdZdZdZ d-d.dZejddddfd/d Z ejddddfd0d"Z d1d&Z d2d3d,Z dS)4FieldaA doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified *rolename*. Field should be used for doc fields that usually don't occur more than once. The body can be linked using a specified *bodyrolename* if the content is just a single inline or text node. Example:: :returns: description of the return value :rtype: description of the return type FTnamestrnamestuple[str, ...]labelhas_argrrolename bodyrolenamerNonecZ||_||_||_||_||_||_dSN)r$r&r(r)r*r+)selfr$r&r(r)r*r+s r__init__zField.__init__:s5      (rNdomaintarget innernodetype[TextlikeNode]contnode Node | NoneenvBuildEnvironment | NoneinlinerInliner | NonelocationElement | Noner c |J|du|duks J||f|s|p |||S|||} | || <|:td} tt| |||t jd|d||} | |p |||z } ||| | Sd} |@tj t5t|} dddn #1swxYwY| |||| |ig\} }tj |dg| RS)Nz]Problem in %s domain: field is supposed to use role '%s', but that role is not in the domain.)r;r#F) refdomain refexplicitreftype reftarget) get_domainroler loggerwarningr pending_xrefprocess_field_xref contextlibsuppress ValueErrorr rinline)r/r*r1r2r3r5r7r9r;rDmsgrefnodelinenonsmessagess r make_xrefzField.make_xrefJs 4X%5666(8K666 98yy88 8~~f%%**844 <7?| 3QRRr#ww8LLL+B&e4<PPPG x<99VV#<#< > >N  $Z00 1 1&x00 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1tHfffgr2NN H|FB,,,,,sD""D&)D& list[Node]c <|||||||||gSr.)rR) r/r*r1r2r3r5r7r9r;s r make_xrefszField.make_xrefsgs0 xH"GX778 8rfieldargcontenttuple[str, list[Node]]c ||fSr.r")r/rVrWs r make_entryzField.make_entryos '""rtypesdict[str, list[Node]]itemtuple nodes.fieldc |\}}tjd|j} |rU| tjdz } | ||j||tj|||t|dkrt|dtjs_t|dtj r~t|ddkret|ddtjr?||j ||d |d|||}tj dtj ddg|R} tjd| | S)Nr# r7r9r;rr)r5r7r9r;)r field_namer(TextextendrUr*rrrLr+astext field_bodyrfield) r/r[r1r]r7r9r;rVrW fieldname fieldbodys r make_fieldzField.make_fieldrsv!'$R44  [ C (I   T__T]F-5uz14gPX-ZZ [ [ [ w<<1  71:uz22 GAJ 55 :=gaj//Q:N:NGAJqM5:66;Oood&7&-aj&7&7&9&9GAJ*-w&SSG$RR)J')J)J)JKK {2y)444r)r"r#Tr#r#)r$r%r&r'r(r%r)rr*r%r+r%rr,)r*r%r1r%r2r%r3r4r5r6r7r8r9r:r;r<rr )r*r%r1r%r2r%r3r4r5r6r7r8r9r:r;r<rrS)rVr%rWrSrrXNNN)r[r\r1r%r]r^r7r8r9r:r;r<rr_) __name__ __module__ __qualname____doc__ is_groupedis_typedr0r literal_emphasisrRrUrZrkr"rrr!r!*s  JH "$)))))"3;2K*.t,0T-----<4<3L+/PT-1d88888####(,"&#'5555555rr!cLeZdZdZdZejZ dd fd Z d!d"dZ xZ S)# GroupedFielda A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. It always has an argument. The argument can be linked using the given *rolename*. GroupedField should be used for doc fields that can occur more than once. If *can_collapse* is true, this field will revert to a Field if only used once. Example:: :raises ErrorClass: description when it is raised Tr"r#Fr$r%r&r'r(r* can_collapserrr,c`t|||d|||_dS)NT)superr0rv)r/r$r&r(r*rv __class__s rr0zGroupedField.__init__s1 ueT8<<<(rNr[r\r1itemsr^r7r8r9r:r;r<r_c tjd|j}|}|D]\} } tj} | ||j|| tj |||| tj dz } | | z } |tj d| z }t|dkrX|j rQttj |d} tjd| d} tjd|| Stjd|} tjd|| S)Nr#rb -- rr)rrcr( list_typerrerUr*r literal_strongrd list_itemrrvrrgrh)r/r[r1rzr7r9r;rilistnoderVrWparrrjs rrkzGroupedField.make_fields?$R44 >>##!& 1 1 Hg/##C JJtt}fh'/'>+.('TT U U U 5:f%% %C 7NC C00 0HH u::??t0?U_hqk::I(Yq\::I;r9i88 8$R22 {2y)444r)r"r#r#F) r$r%r&r'r(r%r*r%rvrrr,rlr[r\r1r%rzr^r7r8r9r:r;r<rr_) rmrnrorprqr bullet_listr}r0rk __classcell__rys@rrurus  J!ILN:?)))))))(,"&#'555555555rrucFeZdZdZdZ d!d"fd Z d#d$d ZxZS)% TypedFieldaa A doc field that is grouped and has type information for the arguments. It always has an argument. The argument can be linked using the given *rolename*, the type using the given *typerolename*. Two uses are possible: either parameter and type description are given separately, using a field from *names* and one from *typenames*, respectively, or both are given using a field from *names*, see the example. Example:: :param foo: description of parameter foo :type foo: SomeClass -- or -- :param SomeClass foo: description of parameter foo Tr"r#Fr$r%r&r' typenamesr(r* typerolenamervrrr,cnt|||||||_||_dSr.)rxr0rr) r/r$r&rr(r*rrvrys rr0zTypedField.__init__s: ueX|DDD"(rNr[r\r1rzr^r7r8r9r:r;r<r_c d fd }tjdj}t|dkrjr|d \} } || | } n>} |D]'\} } | tjd|| | z } (tjd| } tjd|| S) NrVr%rWrnodes.paragraphc tj}|  j|t j| vr|tjdz } |}t|dkryt|dtjrY|d }|  j |t j n||z }|tjdz }|tjdz }||z }|S)N)r7z (rrrb)r|)rrrerUr*r r~rdpoprrrfrrs) rVrWr fieldtypetypenamer1r7r9r;r/r[s r handle_itemz*TypedField.make_field..handle_itemsI/##C JJtt}fh'/'>C'II J J J5  uz$'''"IIh// y>>Q&&:ilEJ+O+O&(|2244HJJtt/@&(/7/Hc7> / S STTTT9$Cuz#& 5:f%% %C 7NCJrr#rr)rVr%rWr%rr) rrcr(rrvr}rrgrh) r/r[r1rzr7r9r;rrirVrWbodynoderjs ``` ``` rrkzTypedField.make_fields           ,$R44 u::??t0? %a Hg([7;;HH~~''H%* P P!'EOB Hg0N0NOOO$R22 {2y)444r)r"r"r#r#r#F)r$r%r&r'rr'r(r%r*r%rr%rvrrr,rlr)rmrnrorprrr0rkrrs@rrrs$H "$%'" ) ) ) ) ) ) )&(,"&#'(5(5(5(5(5(5(5(5(5rrc6eZdZUdZded<ddZdd Zdd ZdS)DocFieldTransformerz Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. zdict[str, tuple[Field, bool]]typemap directiverrr,cF||_||_dSr.)rget_field_type_mapr)r/rs rr0zDocFieldTransformer.__init__s " 3355 rraddnodes.desc_contentcn|D]1}t|tjr||2dS)z,Transform all field list children of a node.N)rr field_list transform)r/rchilds r transform_allz!DocFieldTransformer.transform_allsE & &E%!122 &u%%% & &rnodes.field_listc  |j}g}i}i}tttj|D]n}t |dksJttj|d}ttj|d} | dd\} } n&#t$r|d} } YnwxYw| | d\} } t|r(ttj |d} | j}n|j}| | jt!| kr| dd| ddz}| r|d| zz }tj||d<||| r6| r3|r0t |dkrt)|dtjrtt*| }|d}||j|jjpd||d|jjjjj}t|rJttj |d} | | |n*||tj ddg|Rz }| j }| r)d |D}|r||!|i| <| j"rY | #dd\}}tj|g|!|i|<|} n#t$rYnwxYwtj$|j%d }|j&j|_|j&j'|_'|j&j(|_(||z }| j)r||vr:ttTtVttXf|||}n,t |||<| g|f}||| -| |g}|d|?| -| |g}|| ||fptj.}|D]}t)|tjr||z }"|\}}}| |j i}|jjjjj}|jjj/} |jjpd}!||0||!||| | z }|1|dS) z%Transform a single field list *node*.rrNr#)NNra)r5r7c^g|]*}t|tjtjf(|+Sr")rrInlinerd).0ns r z1DocFieldTransformer.transform..cs0[[[A ej?Y1Z1Z[1[[[rT) translatablerb)2rrlistrrhrrcrgrfsplitrKgetrrchildrenr)rupperrdappendrrrUrrr1statedocumentsettingsr7clearrer$ setdefaultrrrsplitrL rawsourceparentsourcelinerqr^r!r rZrr9rk replace_self)"r/rrentries groupindicesr[rhrcrgfieldtype_namerVtypedesc is_typefieldrrW new_fieldname typed_fieldr2xrefsrargtypeargnametranslatable_contentgroup new_entrynew_listentryrrzr; fieldtypesr7r9r1s" rrzDocFieldTransformer.transform!s,BD') !#$u{+T22] =] =Eu::????e.a99Je.a99J C+5+<+<+>+>+D+DT1+M+M( C C C+5+<+<+>+> C&-[[%N%N "Hl$J// . *Q-@@ #,$-8#3tH~~#E#E!/qs 3 9 9 ; ;nQRR>P P 4!S8^3M % = 9 9 1 u%%%FF'FG ))jUZ.P.P)"&z8"<" % G + " =|++ udD'8!97rs #"""""++++++++++((((((((++++++0333333333333333333//////  8 $ $    a5a5a5a5a5a5a5a5H/5/5/5/5/55/5/5/5dK5K5K5K5K5K5K5K5\J$J$J$J$J$J$J$J$J$J$r