B \i=@stdZddlmZddlmZddlmZddZGdddeZ Gd d d e Z Gd d d e Z Gd ddeZ dS)a8 sphinx.util.docfields ~~~~~~~~~~~~~~~~~~~~~ "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. )absolute_import)nodes)addnodescCsZt|dkrdSt|dkrBx$|ddD]}t|tjs*dSq*Wt|dtjrVdSdS)zCTrue if the node only contains one paragraph (and system messages).rFNT)len isinstancerZsystem_message paragraph)nodeZsubnoder 4lib/python3.7/site-packages/sphinx/util/docfields.py_is_single_paragraphs   r c@sXeZdZdZdZdZdddZejddfdd Z ejddfd d Z d d Z dddZ dS)FieldaA 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 Fr NTcCs(||_||_||_||_||_||_dS)N)namenameslabelhas_argrolename bodyrolename)selfrrrrrrr r r __init__7s zField.__init__cCsP|s|p|||Stjd|d||d}||p4|||7}|rL|j|||S)NF)Z refdomainZ refexplicitZreftypeZ reftarget)rZ pending_xrefZdomainsZprocess_field_xref)rrdomaintarget innernodecontnodeenvZrefnoder r r make_xrefAs   zField.make_xrefcCs|||||||gS)N)r)rrrrrrrr r r make_xrefsSs zField.make_xrefscCs||fS)Nr )rfieldargcontentr r r make_entry^szField.make_entryc Cs|\}}td|j}|rF|td7}||j|j||tj|dt|dkrt|dtjst|dtj rt|ddkrt|ddtjr|j|j ||d |d|d}t dtj d|}td||S)Nr )rrr)rr)rr)r field_namerTextextendrrrrinlinerastext field_bodyrfield) rtypesritemrrr fieldname fieldbodyr r r make_fieldbs   zField.make_field)r NTNN)N) __name__ __module__ __qualname____doc__ is_groupedis_typedrrliteral_emphasisrrr r-r r r r r 's    r c@s.eZdZdZdZejZd ddZd dd Z dS) 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 NFcCst||||d|||_dS)NT)r r can_collapse)rrrrrr6r r r rszGroupedField.__init__c Cstd|j}|}x\|D]T\}}t} | |j|j||tj |d| t d7} | |7} |t d| 7}qWt |dkr|j rtd|dd} td|| Std|} td|| S)Nr)rz -- rr)rr"r list_typerr$rrrliteral_strongr# list_itemrr6r'r() rr)ritemsrr+Zlistnoderrparr,r r r r-s zGroupedField.make_field)r NNF)N) r.r/r0r1r2rZ bullet_listr7rr-r r r r r5zs   r5c@s(eZdZdZdZd ddZd dd ZdS) 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 NFcCs$t||||||||_||_dS)N)r5r typenames typerolename)rrrr=rrr>r6r r r rszTypedField.__init__c sfdd}tdj}t|dkrJjrJ|d\}}|||} n0} x&|D]\}}| td|||7} qXWtd| } td|| S)Nc st}|jj|tjd|kr|td7}|}t |dkrt |dtjrd dd|D}|jj |tj dn||7}|td7}|td 7}||7}|S) N)rz (rrrcss|]}|VqdS)N)r&).0nr r r sz=TypedField.make_field..handle_item..)z -- )rrr$rrrr8r#poprrjoinr>r4)rrr; fieldtypetypename)rrrr)r r handle_items z*TypedField.make_field..handle_itemrrr) rr"rrr6r7r9r'r() rr)rr:rrGr+rrZbodynoder,r )rrrr)r r-s   zTypedField.make_field)r r NNNF)N)r.r/r0r1r3rr-r r r r r<s  r<c@s0eZdZdZddZddZddZdd Zd S) DocFieldTransformerz Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. cCs0||_d|jjkr$||jj|j_|j|_dS)N_doc_field_type_map) directive __class____dict__preprocess_fieldtypesZdoc_field_typesrItypemap)rrJr r r rs zDocFieldTransformer.__init__cCsTi}xJ|D]B}x|jD]}|df||<qW|jr x|jD]}|df||<q8Wq W|S)NFT)rr3r=)rr)rNrErr r r rMs   z)DocFieldTransformer.preprocess_fieldtypescCs(x"|D]}t|tjr||qWdS)z,Transform all field list children of a node.N)rr field_list transform)rr Zchildr r r transform_alls  z!DocFieldTransformer.transform_allc Cs8|j}g}i}i}x|D]}|\}}y|dd\} } Wn"tk rb|d} } YnX|| d\} } t|r|jdj} n|j} | dks| jt| kr| dd | dd}| r|d| 7}t ||d<| || r| r| rt | dkrt| dt j r| d}| j| j|jj|| dd}t|rf|jd|jd|q||t 7}|d|q| j}| rdd | D} | r| ||i| <q| jr y| dd\}}Wntk rYnXt |g||i|<|} t j|jd d }|jj|_|jj|_|jj|_|| 7}| jr||kr`|||}nt |||<| gg}| || | |g}|d |q| | |g}| | |gqWt !}xd|D]\}t|t j"r||7}n>|\} } || ji}|jj#jj$j%}|| j&||jj| |d 7}qW|'|dS) z%Transform a single field list *node*.Nrr)NNrr!)rcSs(g|] }t|tjs t|tjr|qSr )rrZInliner#)r?r@r r r Msz1DocFieldTransformer.transform..T)Z translatable)r)(rNr&split ValueErrorgetr Zchildrenrboolupperrr#appendrrrr>rJrclearr$rr setdefaultr3r%Z rawsourceparentZdocumentsourceliner2r rOr(stateZsettingsrr-Z replace_self)rr rNentriesZ groupindicesr)r(r+r,rErZtypedescZ is_typefieldrZ new_fieldnamerZxrefsrFZargtypeargnameZtranslatable_contentgroupentryZnew_listZ fieldtypesrr r r rPs               zDocFieldTransformer.transformN)r.r/r0r1rrMrQrPr r r r rHs  rHN) r1Z __future__rZdocutilsrZsphinxrr objectr r5r<rHr r r r  s   S/E