-Ph<dZddlmZddlZddlmZmZmZmZddl m Z ddl m Z m Z ddlmZddlm Z dd lmZdd lmZer(dd lmZdd lmZdd lmZddlmZddlmZmZddlmZm Z ej!dZ"ej!dZ#d#dZ$edZ%Gddeee%Z&GddeZ'GddeZ(d$d"Z)dS)%z(Handlers for additional ReST directives.) annotationsN) TYPE_CHECKINGGenericTypeVarcast)nodes) directivesroles)addnodes)docutils)DocFieldTransformer)SphinxDirective)ClassVar)Node)desc_signature)Sphinx)Field TypedField)ExtensionMetadata OptionSpecz\\\nz\\(.)argumentstrreturn int | NonecZ|dSt|}|dkrd}t||S)zICheck for an integer argument or None value; raise ``ValueError`` if not.Nrz(negative value; must be positive or zero)int ValueError)rvaluemsgs Z/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/sphinx/directives/__init__.py optional_intr! s7tH  199G"&|U";";K + 5GG:?066''r" list[str]ctd|jdd}|jjr d|DSd|DS)zRetrieve the signatures to document from the directive arguments. By default, signatures are given as arguments, one per line. r chg|]/}td|0S)z\1)strip_backslash_resubstrip.0lines r z4ObjectDescription.get_signatures..cs1RRRD&**5$**,,??RRRr"c6g|]}|S)rFrGs r rJz4ObjectDescription.get_signatures..es 333TDJJLL333r") nl_escape_rerE argumentssplitconfigstrip_signature_backslash)r:liness r get_signaturesz ObjectDescription.get_signatures[sc   T^A%677==dCC ; 0 4RRERRR R33U333 3r"sigsignoderr#ct)aParse the signature *sig*. The individual nodes are then appended to *signode*. If ValueError is raised, parsing is aborted and the whole *sig* is put into a single desc_name node. The return value should be a value that identifies the object. It is passed to :meth:`add_target_and_index()` unchanged, and otherwise only used to skip duplicates. )r)r:rTrUs r handle_signaturez"ObjectDescription.handle_signaturegs r"r<NonecdS)zAdd cross-reference IDs and entries to self.indexnode, if applicable. *name* is whatever :meth:`handle_signature()` returned. NrL)r:r<rTrUs r add_target_and_indexz&ObjectDescription.add_target_and_indext  r"cdS)zCalled before parsing content. Used to set information about the current directive context on the build environment. NrLr:s r before_contentz ObjectDescription.before_content} r" content_nodeaddnodes.desc_contentcdS)zCan be used to manipulate the content. Called after creating the content through nested parsing, but before the ``object-description-transform`` event is emitted, and before the info-fields are transformed. NrL)r:r`s r transform_contentz#ObjectDescription.transform_contentr[r"cdS)zCalled after parsing content. Used to reset information about the current directive context on the build environment. NrLr]s r after_contentzObjectDescription.after_contentr_r"sig_nodetuple[str, ...]cdS)aReturns a tuple of strings, one entry for each part of the object's hierarchy (e.g. ``('module', 'submodule', 'Class', 'method')``). The returned tuple is used to properly nest children within parents in the table of contents, and can also be used within the :py:meth:`_toc_entry_name` method. This method must not be used outwith table of contents generation. rLrLr:rfs r _object_hierarchy_partsz)ObjectDescription._object_hierarchy_partss rr"cdS)aReturns the text of the table of contents entry for the object. This function is called once, in :py:meth:`run`, to set the name for the table of contents entry (a special attribute ``_toc_name`` is set on the object node, later used in ``environment.collectors.toctree.TocTreeCollector.process_doc().build_toc()`` when the table of contents entries are collected). To support table of contents entries for their objects, domains must override this method, also respecting the configuration setting ``toc_object_entries_show_parents``. Domains must also override :py:meth:`_object_hierarchy_parts`, with one (string) entry for each part of the object's hierarchy. The result of this method is set on the signature node, and can be accessed as ``sig_node['_toc_parts']`` for use within this method. The resulting tuple is also used to properly nest children within parents in the table of contents. An example implementations of this method is within the python domain (:meth:`!PyObject._toc_entry_name`). The python domain sets the ``_toc_parts`` attribute within the :py:meth:`handle_signature()` method. rArLris r _toc_entry_namez!ObjectDescription._toc_entry_names .rr" list[Node]c d|jvr)|jdd\|_|_nd|jc|_|_t jg|_t j}|jj |_ | \}}||dz}|jj |||j|d<|jx|d<|d<d |j vrd |j vr|j d |j d <d |j vrd |j vr|j d |j d <d |j vrd|j vr|j d|j d <d |j vx|d <x|d <}d |j vx|d <|d <d |j vx|d <|d<d|j v|d<|jr |d |j|d |dg|_|}|D]}t j|d}||| | |||}n#t&$rv||t j||z }Y|jjr1|||d<|||d<d|d<d|d<wxYw |jjr1|||d<|||d<nWd|d<d|d<nL#|jjr1|||d<|||d<n d|d<d|d<wxYw||jvr3|j ||s|||||jre|jd} t7| t8r%t;| d|jj_ nt;| |jj_ |!|"d} t j#dg| R} | | |$| |jj%&d|j|j| tO|(| d|jj_ |)|drfd|*tVj,Dx} r3tWj-| } || |j| gS|jgS|j|gS)aMain directive entry function, called by docutils upon encountering the directive. This directive is meant to be quite easily subclassable, so it delegates to several additional methods. What it does: * find out if called as a domain-specific directive, set self.domain * create a `desc` node to fit all description inside * parse standard options, currently `no-index` * create an index node if needed as self.indexnode * parse all given signatures (as returned by self.get_signatures()) using self.handle_signature(), which should either return a name or raise ValueError * add index entries using self.add_target_and_index() * parse the content and handle doc fields in it :r&rA)entriesNr1r2desctyper'r+r(r,r)r-r*classes _toc_parts _toc_namerLrT)allow_section_headingsobject-description-transformcDg|]}|ddD]}|S)idsrL)get)rHelnode_ids r rJz)ObjectDescription.run..4sM!vveR00r")rx).r<rOr1r2r indexr3descstatedocumentget_source_info note_sourceoptionsappendr7rSrset_source_inforWrclear desc_namerPtoc_object_entriesrjrlrZ isinstancetuplerenvcurrent_document obj_desc_namer^parse_content_to_nodes desc_contentrceventsemitr transform_allrefindallrElementtarget)r:nodesourcerIno_index signaturesrTrUr< object_namecontent_childrenr`node_ids target_nodes r runzObjectDescription.runs" $)  (, Q(?(? %DK(*DI %DK!333} + ++--    AID ''555X-1\9Y$z* T\ ) )i4<.G.G'+|I'>DL $ 4< / /Ndl4R4R-1\.-IDL) * t| 3 3!T\1104 =N0ODL, -8Bdl8RRZR4 ?X8HDL8XX n!5 4< /  !D):$;"2T\!A  ; 0 O " "4; / / / YtI///%' ((**  B BC-c266G   ) ) ) KK  .,,S'::    8-c3777;1.,0,H,H,Q,QGL)+/+?+?+H+HGK((,.GL)+-GK(( ;1.,0,H,H,Q,QGL)+/+?+?+H+HGK((,.GL)+-GK(( ;1.,0,H,H,Q,QGL)+/+?+?+H+HGK((,.GL)+-GK(----4:%% !!$'''B--dCAAA : K$(JqMK+u-- K:=k!n:M:M)77:=k:J:J)7 66d6SS,RC2BCCC  L!!! |,,,  *DK|    D!!// ===24!/   ! $ ,,u}55x 5 $lx888 $$[111 44N# #%%s+:IL6KLKLA M&)rr4)rr?)rTrrUrrr#)r<r#rTrrUrrrX)rrX)r`rarrX)rfrrrg)rfrrrrrm)__name__ __module__ __qualname____doc__ has_contentrequired_argumentsoptional_argumentsfinal_argument_whitespacer flagr/__annotations__r0r1r5r>rSrWrZr^rcrerjrlrrLr"r r%r%/s K $O$/'_$/?"%?))K$&O%%%%FLLL:<;;;; ( ( ( ( 4 4 4 4                        2C&C&C&C&C&C&r"r%c"eZdZdZdZdZddZdS) DefaultRolezASet the default interpreted text role. Overridden from docutils.r&Frrmc|jstjdgS|jd}tj||jj|j|jj \}}|r'tj d|||j j _ nQtj|j|j}|jj }|d|z||j}||gz }t%d|S)NrArz#Unknown interpreted text role "%s".)rIzlist[nodes.Node])rNr unregister_roler role state_machinelanguagelinenor~reporter register_rolerr default_roler literal_block block_texterrorr)r: role_namermessagesrrrs r rzDefaultRole.runFs~   $R ( ( (IN1%  t)2DKAT  h   "2t , , ,5>DH % 2 2!/QQMz*HNN5 A[#E  H&111r"Nr)rrrrrrrrLr"r rr@s:KK %222222r"rc:eZdZUdZdZdZdZdZiZde d<d d Z d S) DefaultDomainz>Directive to (re-)set the default domain for this source file.Fr&rr.r/rrmc|jd}|jj|}||jj_gS)Nr)rNlowerrdomainsryrdefault_domain)r: domain_namers r rzDefaultDomain.rungsDnQ'--// )--k::3A!0 r"Nr) rrrrrrrrr/rrrLr"r rr^sXHHK %(*K****r"rapprrc`|dddtthtjdt tjdt tjdttjdt|d d d d d S) NrQFr)typesz default-rolezdefault-domaindescribeobjectrvbuiltinT)versionparallel_read_safeparallel_write_safe) add_config_value frozensetboolr register_directiverrr% add_event)rs r setuprns#UED69J9J!.+>>>!"2MBBB!*.?@@@!(,=>>>MM0111"#  r")rrrr)rrrr)*r __future__rretypingrrrrr rdocutils.parsers.rstr r sphinxr sphinx.utilsphinx.util.docfieldsr sphinx.util.docutilsrrdocutils.nodesrsphinx.addnodesrsphinx.applicationrrrsphinx.util.typingrrcompilerMrDr!r#r%rrrrLr"r rs3.."""""" 88888888888822222222 555555000000A######......))))))77777777@@@@@@@@rz'"" RZ))     7:  N&N&N&N&N&):N&N&N&b22222/222<     O    r"