3
T'ícÏê ã @ s2 d Z ddlZddlZddlZddlZddlZddlZddlmZ ddlmZm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlmZ ddlmZmZ ddlmZ ddlmZ dd lm Z dd
l m Z m Z m Z dd l!m"Z" dd l#m$Z$ dd
l%m&Z&m'Z' ddl(m)Z) ddl*m+Z+m,Z,m-Z-m.Z. ddl/m0Z0 ddl1m2Z2m3Z3 ddl4m5Z5 ddl4m6Z7 ddl8m9Z9 ddl:m;Z; ddl<m=Z=m>Z>m?Z? ddl@mAZA ddlBmCZC ddlDmEZEmFZFmGZG ddlHmIZImJZJ e;jKeLZMejNdejOZPe2d e2d e2d e2d e2d e2d!e2d"d#ZQG d$d% d%e
ZRG d&d' d'e
ZSdkeTeUeeTeTeTeUf d)d*d+ZVdleTe0eUe j d,d-d.ZWdmeTe0e e d/d0d1ZXdneTe0e jYd2d3d4ZZe eTdd5d6d7Z[G d8d9 d9Z\G d:d; d;e\e=Z]G d<d= d=e\e>Z^G d>d? d?e\e?Z_G d@dA dAe)eeTeTf Z`G dBdC dCe`ZaG dDdE dEeaZbG dFdG dGe`ZcG dHdI dIe`ZdG dJdK dKe`ZeG dLdM dMeeZfG dNdO dOeeZgG dPdQ dQeeZhG dRdS dSe`ZiG dTdU dUe`ZjG dVdW dWZkG dXdY dYeAZlG dZd[ d[eAZmG d\d] d]e9Zne"eTeTedd^d_d`ZoG dadb dbe,ZpG dcdd dde+Zqe"e0e eededfdgZre"e eTef dhdidjZsdS )ozThe Python domain.é N)Ú Parameter)
ÚAnyÚDictÚIterableÚIteratorÚListÚ
NamedTupleÚOptionalÚTupleÚTypeÚcast)Únodes)ÚElementÚNode)Ú
directives)ÚInliner)Úaddnodes)Údesc_signatureÚ pending_xrefÚpending_xref_condition)ÚSphinx)ÚBuilder)ÚRemovedInSphinx50WarningÚRemovedInSphinx60Warning)ÚObjectDescription)ÚDomainÚIndexÚ
IndexEntryÚObjType)ÚBuildEnvironment)Ú_Ú__)Úast)Úparse)ÚXRefRole)Úlogging)ÚFieldÚ GroupedFieldÚ
TypedField)ÚSphinxDirective)Úsignature_from_str)Úfind_pending_xref_conditionÚmake_idÚ make_refnode)Ú
OptionSpecÚ TextlikeNodea ^ ([\w.]*\.)? # class name(s)
(\w+) \s* # thing name
(?: \(\s*(.*)\s*\) # optional: arguments
(?:\s* -> \s* (.*))? # return annotation
)? $ # and nothing more
ÚmoduleÚkeywordÚoperatorÚobjectÚ exceptionÚ statementzbuilt-in function)r0 r1 r2 r3 r4 r5 Úbuiltinc @ s e Zd ZU eeeedS )Ú ObjectEntryN) Ú__name__Ú
__module__Ú __qualname__ÚstrÚdocnameÚnode_idÚobjtypeÚboolÚaliased© rA rA ú7/tmp/pip-build-gk9425m9/sphinx/sphinx/domains/python.pyr7 < s
r7 c @ s" e Zd ZU eeeee dS )Ú ModuleEntryN)
r8 r9 r: r; r< r= ÚsynopsisÚplatformr? Ú
deprecatedrA rA rA rB rC C s
rC F)Ú reftargetÚsuppress_prefixÚreturnc C s¢ d}| j dr$| dd
} | }d}nV| j drJ| dd
} | jdd }n0|r^| jdd
}n | j drv| dd
}n| }| d ks| j drd
}nd }|| ||fS )zLParse a type string and return (reftype, reftarget, title, refspecific flag)FÚ.é NTú~ztyping.é ÚNoneÚobjÚclasséÿÿÿÿrQ )Ú
startswithÚsplit)rG rH Ú refspecificÚtitleÚreftyperA rA rB Úparse_reftargetK s"
rW )ÚtargetÚenvrH rI c C s |r |j jd|j jdd}ni }t| |\}} }}|jjrj|jdd }td|ddtd|d dg}n tj|g}t d
|d
|| |d |S )z0Convert a type string to a cross reference node.z py:modulezpy:class)z py:modulezpy:classrJ rK Ú Úresolved)Ú conditionÚ*Úpy)Ú refdomainrV rG rT rQ )rZ )
Ú ref_contextÚgetrW ÚconfigÚ!python_use_unqualified_type_namesrS r r
ÚTextr ) rX rY rH ÚkwargsrV rU rT Ú shortnameÚ contnodesrA rA rB Ú type_to_xreff s
rh )Ú
annotationrY rI c
s t jtt d fdd |dkr2tjdtdd y¸t| }g }x¦ |D ]}t|t j
rj|j |d qJt|t j rÚ|j
rÚ|rÄt|d
tjrÄ|d j d
krÄ|j |j tt||d d qä|j tt|| qJ|j | qJW |S tk
r t| |gS X dS )zParse type annotation.)ÚnoderI c sD t | tjr,tjd | jd | jf gS t | tjrf | j}|j | j
|j | j |S t | tj rt
j t
jddt
j gS t | tjr,| jtkr²t
jddgS t | jtrÒt
jdt| jgS t | jt rôt
jdt| jgS t | jtrt
jdt| jgS tjt| jgS nt | tjrD | jS t | tjr\ | jS t | tjrxt
jddgS t | tj rt
jddg}| j rìx>| j D ]4}|j | |j t
jdd |j t
j q¤W |j |j |j t
jdd |S t | tj r*t! fd
d | j"D g S t | tj#rFtj| j$gS t | tj%rè | j}|j t
jdd |j | j& |j t
jdd |d dkräxBt'|dd
ddD ]*\}}t |tjr¶tj(dd|||< q¶W |S t | tj)r
| j
| j* S t | tj+r| j rvg }x>| j D ]4}|j | |j t
jdd |j t
j q,W |j |j nt
jddt
jddg}|S t,j-dk r<t | tj.rÀt
jdt| j/gS t | tjrÜt
jddgS t | tj0røtj| jgS t | tj1rt
jdt| j2gS t | tj3r<t
jdt| j/gS t4d S )Nz%s.%sr rZ ú|z...rL ú[ú,ú]c 3 s | ]} |V qd S )NrA )Ú.0Úe)ÚunparserA rB ú <genexpr>° s z5_parse_annotation.<locals>.unparse.<locals>.<genexpr>ÚLiteralútyping.LiteralrK )Ústartú(ú)é é )rs rt )rx ry )5Ú
isinstancer" Ú Attributer
rd ÚvalueÚattrÚBinOpÚleftÚextendÚopÚrightÚBitOrr Údesc_sig_spaceÚdesc_sig_punctuationÚConstantÚEllipsisr? Údesc_sig_keywordÚreprÚintZdesc_sig_literal_numberr; Zdesc_sig_literal_stringÚExprr ÚInvertr ÚeltsÚappendÚpopÚModuleÚsumÚbodyÚNameÚidÚ SubscriptÚsliceÚ enumerateÚliteralÚUnaryOpÚoperandr
ÚsysÚ version_infoÚBytesÚsÚ NameConstantÚNumÚnÚStrÚ SyntaxError)rj ÚresultÚelemÚiZsubnode)rq rA rB rq s
z"_parse_annotation.<locals>.unparseNz=The env parameter for _parse_annotation becomes required now.é )Ú
stacklevelr rK rL T)rH rQ rQ )r" ÚASTr r ÚwarningsÚwarnr Ú ast_parserz r
r r rd Ústripr r
Úastextr rh r; r£ )ri rY Útreer¤ rj rA )rq rB Ú_parse_annotation s( \
r° )ÚarglistrY rI c C s t j| }td| }d}x¼|jj D ]¬}|j|jkr^||jkr^|t jddt jdd7 }|j|j kr||j
|jdfkr|t jddt jdd7 }t j }|j|j krÎ|t jdd7 }|t j d|j
7 }nB|j|jkrþ|t jdd7 }|t j d|j
7 }n|t j d|j
7 }|j|jk rXt|j|}|t jdd7 }|t j 7 }|t j d | 7 }|j|jk rÈ|j|jk r|t j 7 }|t jdd7 }|t j 7 }n|t jdd7 }|tjd|jd gd
d 7 }||7 }|j}q(W |tjkr |t jddt jdd7 }|S )
z*Parse a list of arguments using AST parserz(%s)NrZ ú/r] z**ú:ú=Ú
default_valueF)ÚclassesZsupport_smartquotes)rZ rZ )r Údesc_parameterlistr* Ú
parametersÚvaluesÚkindÚPOSITIONAL_ONLYÚdesc_parameterZdesc_sig_operatorÚ KEYWORD_ONLYÚPOSITIONAL_OR_KEYWORDÚVAR_POSITIONALÚ
desc_sig_nameÚnameÚ VAR_KEYWORDri Úemptyr° r
r Údefaultr
Úinliner )r± rY ÚparamsÚsigZ last_kindÚparamrj ÚchildrenrA rA rB Ú_parse_arglistö sH
rÊ )Úsignoder± rI c C sØ t j }|g}yxj|jdD ]Z}|j }d }}x@|jdrv|jt j |d
|d 7 < |dd
j }q8W x&|jdr|j |dd
j }qzW x2|jdrÒ|jd rÒ|d7 }|dd
j }q¢W x(|jd rü|d7 }|dd
j }qÖW |r&|d t j d d t j
||7 < x6|r\|jt j |d |d 7 < |d8 }q(W x |rz|j |d8 }q`W q W t |dkrt W n6 t k
rÊ t j }|t j ||7 }| |7 } Y n
X | |7 } dS )zÿ"Parse" a list of arguments separated by commas.
Arguments can have "optional" annotations given by enclosing them in
brackets. Currently, this will split at any comma, even if it's inside a
string literal (e.g. default argument value).
rm r rl r§ rK Nrn z[]rZ éþÿÿÿrQ rQ rQ rQ rÌ rQ )
r r· rS r rR r Z
desc_optionalr Úendswithr¼ rÀ ÚlenÚ
IndexError)rË r± Z paramlistÚstackÚargumentZ ends_openZ
ends_closerA rA rB Ú_pseudo_parse_arglist( sH rÒ c sx e Zd Zejddddfeeeee ee e
eed fdd
Z ejddddfeeeee ee e
ee e d ddZ
ZS )Ú PyXrefMixinN) ÚrolenameÚdomainrX Ú innernodeÚcontnoderY ÚinlinerÚlocationrI c
sì t j||||||d d d} t| trèd| d< |jjd| d< |jjd| d< t|\}
} } }
| | kr|
| d< | | d< | j | || | 7 } nZ|jj rè| j
}| j |j dd }|d
|}t d
d
|d d t d|d
dig}| j
| | S )N)rØ rÙ TrT z py:modulezpy:classrV rG rJ rK rZ r[ )r\ r\ r] rQ )rZ rZ )ÚsuperÚ make_xrefrz r r` ra rW Úclearrb rc rÉ rS r r )ÚselfrÔ rÕ rX rÖ r× rY rØ rÙ r¤ rV rG Zreftitler rÉ rf Ztextnoderg )Ú __class__rA rB rÛ \ s,
zPyXrefMixin.make_xrefc C sª d} t j| }
t j| |} t|o*|j |k} d}
g }xntd | D ]`}| rTtj|}|
sb|
j|rx|j |pr||| n |j | j
|||||||| |dkrBd}
qBW |S )Nz8(\s*[\[\]\(\),](?:\s*or\s)?\s*|\s+or\s+|\s*\|\s*|\.\.\.)Frs útyping.LiteralT)rs rß ) ÚreÚcompilerS r? r® Úfilterr
rd Úmatchr rÛ )rÝ rÔ rÕ rX rÖ r× rY rØ rÙ ÚdelimsZ delims_reZ sub_targetsZsplit_contnodeZ
in_literalÚresultsZ
sub_targetrA rA rB Ú
make_xrefs} s
zPyXrefMixin.make_xrefs)r8 r9 r: r
Zemphasisr; r r/ r r r rÛ r ræ Ú
__classcell__rA rA )rÞ rB rÓ [ s , rÓ c @ s e Zd ZdS )ÚPyFieldN)r8 r9 r: rA rA rA rB rè s rè c @ s e Zd ZdS )ÚPyGroupedFieldN)r8 r9 r: rA rA rA rB ré s ré c @ s e Zd ZdS )Ú PyTypedFieldN)r8 r9 r: rA rA rA rB rê ¡ s rê c @ s. e Zd ZU dZejejejejejdZee de
dd<d d=dde de
dd>d d?dde de
ddd@dd e d e
d d dAd#e
d$e
d%d dBd d'gZd Zeeej d(d)d*Zed+d,d-Zeeeeef d.d/d0Zeeeef ed1d2d3Zeeef eed4d5d6d7Zd4d+d8d9Z d4d+d:d;Z d4S )CÚPyObjectz¡
Description of a general Python object.
:cvar allow_nesting: Class is an object that allows for nested namespaces
:vartype allow_nesting: bool
)ÚnoindexÚ noindexentryr0 Ú canonicalri Ú parameterZ
ParametersrÈ ÚargrÑ r1 ÚkwargÚkwparamrP Ú paramtypeÚtypeT)ÚlabelÚnamesZ typerolenameZ typenamesÚ can_collapseÚvariableÚ VariablesÚvarÚivarÚcvarÚvartypeÚ
exceptionsZRaisesÚexcÚraisesÚraiser4 Úexcept)rõ rÔ rö r÷ Z returnvalueZReturnsFÚreturnsrI )rõ Úhas_argrö Z
returntypez Return typeÚrtype)rõ r rö Z bodyrolename)rÇ rI c C s g S )zTMay return a prefix to put before the object name in the
signature.
rA )rÝ rÇ rA rA rB Úget_signature_prefixÉ s z PyObject.get_signature_prefix)rI c C s dS )zqMay return true if an empty argument list is to be generated even if
the document contains none.
FrA )rÝ rA rA rB Ú
needs_arglistÏ s zPyObject.needs_arglist)rÇ rË rI c C s t j|}|dkrt|j \}}}}| jjd| jjjd}| jjjd} | r²d}
|r|| ksn|j| d r|| } |t | d
j
d}qÖ|r¤| d | | } qÖ| d | } n$d}
|rÎ|j d} || } nd} |} ||d< | |d < | |d
< | j |} | rRt
| tkr8tjd j| t |tj| dtj| 7 }n|tjt| df| 7 }|rj|tj||7 }n0|r|
r| jjjr|d }
|tj|
|
7 }|tj||7 }|r&y|t|| j7 }W n^ t k
rä t || Y n@ t k
r" } z"t j d |||d
t || W Y dd}~X nX n| j! r<|tj" 7 }|rdt#|| j}|tj$|df| 7 }| jjd}|r|tjd| dtj% tj|7 }| |fS )aJ Transform a Python signature into RST nodes.
Return (fully qualified name of the thing, classname if any).
If inside a class, the current class name is handled intelligently:
* it is stripped from the displayed name if present
* it is added to the full name (return value) if not present
Nr0 z py:modulezpy:classFrJ TrZ rP ÚfullnamezPython directive method get_signature_prefix() returning a string is deprecated. It must now return a list of nodes. Return value was '{}'.z could not parse arglist (%r): %s)rÙ ri ú )&Ú py_sig_rerã Ú
ValueErrorÚgroupsÚoptionsra rY r` rR rÎ ÚlstripÚrstripr rô r; rª r« Úformatr r Údesc_annotationr
rd Ú desc_addnamerb Úadd_module_namesZ desc_namerÊ r£ rÒ ÚNotImplementedErrorÚloggerÚwarningr r· r° Z desc_returnsr )rÝ rÇ rË ÚmÚprefixrÁ r± ZretannÚmodnameÚ classnameZ
add_moduler Z
sig_prefixZnodetextrÿ rÉ ÚannorA rA rB Úhandle_signatureÕ sx
zPyObject.handle_signature)r rÁ rI c C s t ddS )z2Return the text for the index entry of the object.z!must be implemented in subclassesN)r )rÝ r rÁ rA rA rB Úget_index_text2 s zPyObject.get_index_textN)Úname_clsrÇ rË rI c
C s | j jd| jjjd}|r$|d nd|d }t| j| jjd|}|d j| ||krv|| jjjkrv|d j| | jjj | t
t | jj d}|j
|| j||d | j jd }|rÐ|j
|| j|d
|d d | j kr| j||} | r| jd
jd| |dd f d S )Nr0 z py:modulerJ rZ r Úidsr^ )rÙ rî T)r@ rÙ rí ÚentriesÚsingle)r
ra rY r` r, ÚstateÚdocumentr r Únote_explicit_targetr Ú PythonDomainÚ
get_domainÚ note_objectr> r Ú indexnode)
rÝ r rÇ rË r r r= rÕ Úcanonical_nameÚ indextextrA rA rB Úadd_target_and_index6 s" z PyObject.add_target_and_indexc C s¦ d}| j r2| j d \}}| jr$|}n|r2|jd}|rb|| jjd< | jrb| jjjdg }|j| d| jkr¢| jjjdg }|j| jjjd | jd | jjd< dS )
a Handle object nesting before content
:py:class:`PyObject` represents Python language constructs. For
constructs that are nestable, such as a Python classes, this method will
build up a stack of the nesting hierarchy so that it can be later
de-nested correctly, in :py:meth:`after_content`.
For constructs that aren't nestable, the stack is bypassed, and instead
only the most recent object is tracked. This object prefix name will be
removed with :py:meth:`after_content`.
NrK rJ zpy:classz
py:classesr0 z
py:modulesz py:modulerQ ) rö Ú
allow_nestingr rY r` Ú
setdefaultr r
ra )rÝ r r Z name_prefixr¶ ÚmodulesrA rA rB Úbefore_contentQ s
zPyObject.before_contentc C s | j jjdg }| jr8y |j W n tk
r6 Y nX t|dkrL|d nd| j jd< d| jkr| j jjdg }|r|j | j jd< n| j jjd dS )
a^ Handle object de-nesting after content
If this class is a nestable object, removing the last nested class prefix
ends further nesting in the object.
If this class is not a nestable object, the list of classes should not
be altered as we didn't affect the nesting levels in
:py:meth:`before_content`.
z
py:classesr rK Nzpy:classr0 z
py:modulesz py:modulerQ )rY r` r- r, r rÏ rÎ r
)rÝ r¶ r. rA rA rB Ú
after_contentr s
zPyObject.after_content)rÈ rï rð rÑ r1 rñ rò )ró rô )rú rû rü )rý )r r r4 r )r rI )r ) r8 r9 r: Ú__doc__r ÚflagÚ unchangedÚ option_specr. rê r ré r& rè Zdoc_field_typesr, r; r r
r r r? r r r
r r r+ r/ r0 rA rA rA rB rë ¥ s>
] !rë c s e Zd ZU dZejj Zeejde j
i e e e
j dddZedddZee e f e ed d
fd d Ze ee e f e d
ddZ ZS )Ú
PyFunctionzDescription of a function.Úasync)rÇ rI c C s& d| j kr tjddtj gS g S d S )Nr6 rZ )r
r r r )rÝ rÇ rA rA rB r s
z PyFunction.get_signature_prefix)rI c C s dS )NTrA )rÝ rA rA rB r s zPyFunction.needs_arglistN)r rÇ rË rI c s¤ t j||| d| jkr | jjd| jjjd}|d d }|\}}|rvtd||f }| jd jd||d d f n*d
t d |f }| jd jd ||d d f d S )
Nrí r0 z py:moduler r z%s() (in module %s)r r! rZ z%s; %s()r6 Úpair)
rÚ r+ r
ra rY r` r r( r Úpairindextypes) rÝ r rÇ rË r r= rÁ ÚclsÚtext)rÞ rA rB r+ s
z PyFunction.add_target_and_index)r r rI c C s d S )NrA )rÝ r r rA rA rB r s zPyFunction.get_index_text)r8 r9 r: r1 rë r4 Úcopyr. Úupdater r2 r; r r
r r r? r r
r r+ r rç rA rA )rÞ rB r5 s
r5 c sV e Zd ZdZee d fdd Zeee eef d fdd Z
e ddd Z Z
S )
ÚPyDecoratorFunctionzDescription of a decorator.)rI c s d| _ t j S )Nz py:function)rÁ rÚ Úrun)rÝ )rÞ rA rB r> µ s zPyDecoratorFunction.run)rÇ rË rI c s& t j||}|jdtjdd |S )Nr ú@)rÚ r Úinsertr r )rÝ rÇ rË Úret)rÞ rA rB r º s z$PyDecoratorFunction.handle_signaturec C s dS )NFrA )rÝ rA rA rB r ¿ s z!PyDecoratorFunction.needs_arglist)r8 r9 r: r1 r r r> r; r r
r r? r rç rA rA )rÞ rB r= ² s r= c sp e Zd ZU dZejj Zeeje j
e j
d e e e
e e f d fdd Ze e
e e f e dddZ ZS ) Ú
PyVariablezDescription of a variable.)rô r| )rÇ rË rI c s t j||\}}| jjd}|rTt|| j}|tj|dtjddtj f| 7 }| jjd}|r|tj|dtj tjddtj t
j |7 }||fS )Nrô rZ r³ r| r´ ) rÚ r r
ra r° rY r r r
r r
rd )rÝ rÇ rË r r ÚtypÚ annotationsr| )rÞ rA rB r Ì s
zPyVariable.handle_signature)r r rI c C s, |\}}|r t d||f S t d| S d S )Nz%s (in module %s)z%s (built-in variable))r )rÝ r r rÁ r9 rA rA rB r à s zPyVariable.get_index_text)r8 r9 r: r1 rë r4 r; r. r< r r3 r; r r
r r rç rA rA )rÞ rB rB Ã s
rB c @ sd e Zd ZU dZejj Zeejde j
i dZ e e
ej dddZe ee e f e ddd Zd
S ) Ú PyClasslikezO
Description of a class-like object (classes, interfaces, exceptions).
ÚfinalT)rÇ rI c C sD d| j kr,tjdtj tj| jtj gS tj| jtj gS d S )NrF )r
r
rd r r r> )rÝ rÇ rA rA rB r ô s
z PyClasslike.get_signature_prefix)r r rI c C sL | j dkr2|s td|d S td|d |f S | j dkrD|d S dS d S )NrP z%s (built-in class)r z%s (class in %s)r4 rZ )r> r )rÝ r r rA rA rB r û s
zPyClasslike.get_index_textN)r8 r9 r: r1 rë r4 r; r. r< r r2 r, r; r r
r r r
r rA rA rA rB rE è s
rE c @ s e Zd ZU dZejj Zeeje j
e j
e j
e j
e j
e j
d e dddZ e
eej dddZe
ee
e
f e
d d
d Zd S )
ÚPyMethodzDescription of a method.)Úabstractmethodr6 Ú classmethodrF ÚpropertyÚ staticmethod)rI c C s d| j krdS dS d S )NrJ FT)r
)rÝ rA rA rB r s
zPyMethod.needs_arglist)rÇ rI c C sø g }d| j kr,|jtjd |jtj d| j krT|jtjd |jtj d| j kr||jtjd |jtj d| j kr¤|jtjd |jtj d| j krÌ|jtjd |jtj d| j krô|jtjd |jtj |S ) NrF rH Úabstractr6 rI rJ rK Zstatic)r
r r
rd r r )rÝ rÇ r rA rA rB r s(
z PyMethod.get_signature_prefix)r r rI c C sÌ |\}}y0|j dd\}}|r6| jjjr6dj||g}W n0 tk
rh |r\td||f S d| S Y nX d| jkrtd||f S d| jkrtd||f S d | jkr¸td
||f S td ||f S d S ) NrJ rK z%s() (in module %s)z%s()rI z%s() (%s class method)rJ z%s (%s property)rK z%s() (%s static method)z%s() (%s method))ÚrsplitrY rb r Újoinr r r
)rÝ r r rÁ r9 ÚclsnameZmethnamerA rA rB r / s
zPyMethod.get_index_textN)r8 r9 r: r1 rë r4 r; r. r< r r2 r? r r; r r
r r r
r rA rA rA rB rG s
rG c s: e Zd ZU dZejj Zeee d fdd Z
Z S )Ú
PyClassMethodz Description of a classmethod.)rI c s d| _ d| jd< t j S )Nz py:methodTrI )rÁ r
rÚ r> )rÝ )rÞ rA rB r> J s
zPyClassMethod.run) r8 r9 r: r1 rë r4 r; r. r r r> rç rA rA )rÞ rB rP E s
rP c s: e Zd ZU dZejj Zeee d fdd Z
Z S )ÚPyStaticMethodz Description of a staticmethod.)rI c s d| _ d| jd< t j S )Nz py:methodTrK )rÁ r
rÚ r> )rÝ )rÞ rA rB r> V s
zPyStaticMethod.run) r8 r9 r: r1 rë r4 r; r. r r r> rç rA rA )rÞ rB rQ Q s
rQ c sV e Zd ZdZee d fdd Zeee eef d fdd Z
e ddd Z Z
S )
ÚPyDecoratorMethodz!Description of a decoratormethod.)rI c s d| _ t j S )Nz py:method)rÁ rÚ r> )rÝ )rÞ rA rB r> ` s zPyDecoratorMethod.run)rÇ rË rI c s& t j||}|jdtjdd |S )Nr r? )rÚ r r@ r r )rÝ rÇ rË rA )rÞ rA rB r d s z"PyDecoratorMethod.handle_signaturec C s dS )NFrA )rÝ rA rA rB r i s z PyDecoratorMethod.needs_arglist)r8 r9 r: r1 r r r> r; r r
r r? r rç rA rA )rÞ rB rR ] s rR c sp e Zd ZU dZejj Zeeje j
e j
d e e e
e e f d fdd Ze e
e e f e dddZ ZS ) Ú PyAttributez Description of an attribute.)rô r| )rÇ rË rI c s t j||\}}| jjd}|rTt|| j}|tj|dtjddtj f| 7 }| jjd}|r|tj|dtj tjddtj t
j |7 }||fS )Nrô rZ r³ r| r´ ) rÚ r r
ra r° rY r r r
r r
rd )rÝ rÇ rË r r rC rD r| )rÞ rA rB r v s
z PyAttribute.handle_signature)r r rI c C sv |\}}y0|j dd\}}|r6| jjjr6dj||g}W n, tk
rd |r\td||f S |S Y nX td||f S )NrJ rK z%s (in module %s)z%s (%s attribute))rM rY rb r rN r r )rÝ r r rÁ r9 rO ÚattrnamerA rA rB r s
zPyAttribute.get_index_text)r8 r9 r: r1 rë r4 r; r. r< r r3 r; r r
r r rç rA rA )rÞ rB rS m s
rS c s e Zd ZdZejj Zejej ej ej
d e e e
e e f d fdd Ze eej dddZe e
e e f e d d
d Z ZS ) Ú
PyPropertyz Description of an attribute.)rH rI rô )rÇ rË rI c s\ t j||\}}| jjd}|rTt|| j}|tj|dtjddtj f| 7 }||fS )Nrô rZ r³ )
rÚ r r
ra r° rY r r r
r )rÝ rÇ rË r r rC rD )rÞ rA rB r ¤ s
zPyProperty.handle_signature)rÇ rI c C sv g }d| j kr,|jtjd |jtj d| j krT|jtjd |jtj |jtjd |jtj |S )NrH rL rI rP rJ )r
r r
rd r r )rÝ rÇ r rA rA rB r ± s
z PyProperty.get_signature_prefix)r r rI c C sv |\}}y0|j dd\}}|r6| jjjr6dj||g}W n, tk
rd |r\td||f S |S Y nX td||f S )NrJ rK z%s (in module %s)z%s (%s property))rM rY rb r rN r r )rÝ r r rÁ r9 rO rT rA rA rB r ¾ s
zPyProperty.get_index_text)r8 r9 r: r1 rë r4 r; r< r r2 r3 r; r r
r r r
r r r rç rA rA )rÞ rB rU s
rU c s@ e Zd ZdZeeeeef d fdd ZedddZ Z
S )ÚPyDecoratorMixinz)
Mixin for decorator directives.
)rÇ rË rI c sh x@| j jD ]$}|jdkr
tjd| tdd P q
W tjdtdd t j||}|jdt j
dd |S )NZDirectiveAdapterzEPyDecoratorMixin is deprecated. Please check the implementation of %sr§ )r¨ z PyDecoratorMixin is deprecatedr r? ) rÞ Ú__mro__r8 rª r« r rÚ r r@ r r )rÝ rÇ rË r9 rA )rÞ rA rB r Ñ s
z!PyDecoratorMixin.handle_signature)rI c C s dS )NFrA )rÝ rA rA rB r à s z PyDecoratorMixin.needs_arglist) r8 r9 r: r1 r; r r
r r? r rç rA rA )rÞ rB rV Í s rV c @ sb e Zd ZU dZdZdZdZdZdd dd ej ej dZ
e
e e
d d
d Zeed d
dZdS )ÚPyModulez8
Directive to mark description of a new module.
FrK r c C s | S )NrA )ÚxrA rA rB Ú<lambda>î s zPyModule.<lambda>c C s | S )NrA )rY rA rA rB rZ ï s )rE rD rì rF )rI c
C s, t t| jjd}| jd j }d| jk}|| jjd< g }|s(t| j| j j
d|}t j dd|gdd}| j
| | j|}||kr || j j
jkr |d j| | j j
j| |j||| jjd
d| jjd dd | jk |j|d||d
|j| dtd |f }tjd||dd fgd} |j| |S )Nr^ r rì z py:moduler0 rZ T)r Zismodr rD rE rF )rÙ z%s; %sr7 )r )r r% rY r& Ú argumentsr r
r` r, r" r# r
rX Zset_source_infoÚ make_old_idr r r$ Ú note_modulera r' r8 r Úindex)
rÝ rÕ r rì rA r= rX Z old_node_idr* ÚinoderA rA rB r> ô s0
z PyModule.run)rÁ rI c C s d| S )zÚGenerate old styled node_id.
Old styled node_id is incompatible with docutils' node_id.
It can contain dots and hyphens.
.. note:: Old styled node_id was mainly used until Sphinx-3.0.
z module-%srA )rÝ rÁ rA rA rB r\ s zPyModule.make_old_idN)r8 r9 r: r1 Ú has_contentÚrequired_argumentsÚoptional_argumentsÚfinal_argument_whitespacer r2 r4 r. r r r> r; r\ rA rA rA rB rX ä s
$rX c @ s< e Zd ZU dZdZdZdZdZi Ze e
e dddZ dS ) ÚPyCurrentModulez
This directive is just to tell Sphinx that we're documenting
stuff in module foo, but links to module foo won't lead here.
FrK r )rI c C s8 | j d j }|dkr(| jjjdd n || jjd< g S )Nr rN z py:module)r[ r rY r` r )rÝ r rA rA rB r> / s
zPyCurrentModule.runN)
r8 r9 r: r1 r` ra rb rc r4 r. r r r> rA rA rA rB rd # s
rd c @ s, e Zd Zeeeeeeeef dddZdS )Ú
PyXRefRole)rY ÚrefnodeÚhas_explicit_titlerU rX rI c C s¢ |j jd|d< |j jd|d< |sv|jd}|jd}|dd
dkrv|dd
}|jd}|d krv||d d
}|dd
dkr|dd
}d|d< ||fS )
Nz py:modulezpy:classrJ rL r rK TrT rQ )r` ra r Úrfind)rÝ rY rf rg rU rX ÚdotrA rA rB Ú process_link9 s
zPyXRefRole.process_linkN) r8 r9 r: r r r? r; r
rj rA rA rA rB re 8 s re )ÚapprÕ r> ÚcontentrI c C s~ |dkr dS xl|D ]d}t |tjrtttj |}xB|D ]:}ttj|d j j }|dksf|j dr8|j
| P q8W qW dS )z+Filter ``:meta:`` field from its docstring.r^ Nr Úmetazmeta ) rz r
Z
field_listr r ÚfieldZ
field_bodyr® r rR Úremove)rk rÕ r> rl rj Úfieldsrn Ú
field_namerA rA rB Úfilter_meta_fieldsO s
rr c @ sR e Zd ZdZdZedZedZd ee e
e e
e e e f e
f dddZdS )
ÚPythonModuleIndexz<
Index subclass to provide the Python module index.
ZmodindexzPython Module Indexr. N)ÚdocnamesrI c
C s¼ i }| j jjd }t|tdd}t| j jd j dd d}d}d }xP|D ]F\}\}} }
} } |rn||krnqLx0|D ]$}
|j|
rt|t|
d
}|
}P qtW d}|s®|d }}|j|d j g }|j
d
d }||krT||kr$|rN|d }t |d d |d |d
|d |d |d |d< n*|j|sN|j t || d ddddd d }n |d 7 }d }| rnt
dnd}|j t || ||| | ||
|}qLW t|| |k }t|j }||fS )NZmodindex_common_prefixT)ÚkeyÚreverser. c S s | d j S )Nr )Úlower)rY rA rA rB rZ o s z,PythonModuleIndex.generate.<locals>.<lambda>)ru rZ r rJ rK r§ rx é é é Z
DeprecatedrQ rQ )rÕ rY rb ÚsortedrÎ ÚdataÚitemsrR r- rw rS r r r )rÝ rt rl Zignoresr. Z prev_modnameZ
num_toplevelsr r< r= rD Ú platformsrF ÚignoreÚstrippedr ÚpackageÚlastÚsubtypeZ qualifierZcollapseZsorted_contentrA rA rB Úgenerateg sL
zPythonModuleIndex.generate)N)r8 r9 r: r1 rÁ r Ú localnamerf r r; r
r r r? r rA rA rA rB rs ^ s rs c @ s~ e Zd ZU dZdZdZeedddeedddeeddd deed
d ddeed d deed
d deedd deedddeeddddeedddd
Ze e
ef e e e
e
eeeeeeeeed
Ze e edde e e edde e d Zi i dZe e
e e
ee f f e gZ e e e
e f dd d Z!d@e
e
e
e"e d d d!d"Z#e e e
e$f dd#d$Z%e
e
e
e
e"d d%d&d'Z&e
d d(d)d*Z'e(e
e d d+d,d-Z)dAe*e
e
e
e
e+e(ee
e f d/d0d1Z,e*e
e-e
e
e.e/e0e/ d2d3d4Z1e*e
e-e
e.e/e(ee
e/f d5d6d7Z2e-e
e
e3e/d8d9d:Z4e5ee
e
e
e
e
e+f dd;d<Z6e/e0e
d=d>d?Z7d S )Br% zPython language domain.r^ ÚPythonÚfunctionÚfuncrO r| rP rÿ r4 ÚmethodÚmethz class methodz
static methodÚ attributer} rJ Ú_propr0 Úmod)
r r| rP r4 r rI rK r rJ r0 )
r r| rP r4 r rI rK r rJ r0 Z
currentmoduleZ decoratorZdecoratormethodT)Z
fix_parens) r| rÿ r rP Úconstr} r r rO )Úobjectsr. )rI c C s | j jdi S )Nr )r| r- )rÝ rA rA rB r Ù s zPythonDomain.objectsFN)rÁ r> r= r@ rÙ rI c C sj || j krN| j | }|jr$|dkr$n*|jdkr6|r6dS tjtd||j|d t| jj|||| j |< dS )zQNote a python object for cross reference.
.. versionadded:: 2.1
FNzWduplicate object description of %s, other instance in %s, use :noindex: for one of them)rÙ )r r@ r r r! r< r7 rY )rÝ rÁ r> r= r@ rÙ ÚotherrA rA rB r' Ý s
zPythonDomain.note_objectc C s | j jdi S )Nr. )r| r- )rÝ rA rA rB r. ò s zPythonDomain.modules)rÁ r= rD rE rF rI c C s t | jj||||| j|< dS )zQNote a python module for cross reference.
.. versionadded:: 2.1
N)rC rY r< r. )rÝ rÁ r= rD rE rF rA rA rB r] ö s
zPythonDomain.note_module)r< rI c C s` x,t | jj D ]\}}|j|kr| j|= qW x,t | jj D ]\}}|j|kr>| j|= q>W d S )N)Úlistr r} r< r. )rÝ r< r rO r r rA rA rB Ú clear_docÿ s
zPythonDomain.clear_doc)rt Ú otherdatarI c C s` x,|d j D ] \}}|j|kr|| j|< qW x,|d j D ] \}}|j|kr<|| j|< q<W d S )Nr r. )r} r< r r. )rÝ rt r r rO r r rA rA rB Úmerge_domaindata s
z PythonDomain.merge_domaindatar )rY r r rÁ rô Ú
searchmoderI c
sì |d d
dkr |dd
}|s$g S g }d}|dkr |dkrJt j n
j| dk rÊ|r|r|d | d | } | jkrj| j kr| }|sÊ|rÚ|d | jkrÚj|d | j krÚ|d | }nB|jkoòj| j k rü|}n d| fddjD }n¬|jkr0|}n|dkr>g S |rf|d | jkrf|d | }nd|r|d | jkr|d | }n<|rÊ|rÊ|d | d | jkrÊ|d | d | }|dk rè|j|j| f |S ) zFind a Python object for "name", perhaps using the given module
and/or classname. Returns a list of (name, object entry) tuples.
r§ Nz()rK rJ c s4 g | ],}|j rj| j kr|j| fqS rA )rÍ r r> )ro Zoname)ÚobjtypesÚ
searchnamerÝ rA rB ú
<listcomp>3 s
z)PythonDomain.find_obj.<locals>.<listcomp>r rÌ rÌ )r Ú object_typesZobjtypes_for_roler r> r )
rÝ rY r r rÁ rô r ÚmatchesZnewnamer rA )r r rÝ rB Úfind_obj sJ
zPythonDomain.find_obj)rY Ú fromdocnameÚbuilderrô rX rj r× rI c C sB |j d}|j d} |jdr"dnd}
| j||| |||
} | r\|dkr\| j||| |d|
} | r~|dkr~| j||| |d|
} | sd S t| dkrÜd d
| D } t| dkr²| } n*tjtd |d jd
d | D dd|d | d \}
}|d dkr| j|||
|S t |d}|r |j
}n|g}t |||d |d ||
S d S )Nz py:modulezpy:classrT rK r r} r r c S s g | ]}|d j s|qS )rK )r@ )ro r rA rA rB r a s z-PythonDomain.resolve_xref.<locals>.<listcomp>z5more than one target found for cross-reference %r: %sz, c s s | ]}|d V qdS )r NrA )ro rã rA rA rB rr f s z,PythonDomain.resolve_xref.<locals>.<genexpr>ÚrefÚpython)rô r rÙ r§ r0 r[ ) ra Úhasattrr rÎ r r r! rN Ú_make_module_refnoder+ rÉ r- )rÝ rY r r rô rX rj r× r rO r r Z
canonicalsrÁ rO rl rÉ rA rA rB Ú resolve_xrefH s4
zPythonDomain.resolve_xref)rY r r rX rj r× rI c
C s¸ |j d}|j d}g } | j||||d d}
x|
D ]~\} } | d dkrb| jd| j||| |f q2t|d}
|
rx|
j}n|g}| jd| j| d t||| d | d || f q2W | S )
Nz py:modulezpy:classrK r§ r0 zpy:modr[ zpy:r )ra r r r¡ r+ rÉ Zrole_for_objtyper- )rÝ rY r r rX rj r× r rO rå r rÁ rO rl rÉ rA rA rB Úresolve_any_xrefw s"
z PythonDomain.resolve_any_xref)r r rÁ r× rI c C sb | j | }|}|jr"|d|j 7 }|jr4|td7 }|jrL|d|j d 7 }t|||j|j||S )Nz: z
(deprecated)z (rw )r. rD rF r rE r- r< r= )rÝ r r rÁ r× r0 rU rA rA rB r¡ s
z!PythonDomain._make_module_refnodec c s x,| j j D ] \}}||d|j|jdfV q W xX| jj D ]J\}}|jdkr:|jrl|||j|j|jdfV q:|||j|j|jdfV q:W d S )Nr0 r rK rQ )r. r} r< r= r r> r@ )rÝ r r ZrefnamerO rA rA rB Ú get_objects¡ s
zPythonDomain.get_objects)rj rI c C sD |j d}|j d}|j d}|d kr*d S djtd |||gS d S )Nz py:modulezpy:classrG rJ )ra rN râ )rÝ rj r rO rX rA rA rB Úget_full_qualified_name¬ s
z$PythonDomain.get_full_qualified_name)FN)r )8r8 r9 r: r1 rÁ rõ r r r r r; r5 rB rE rG rP rQ rS rU rX rd r= rR r re ZrolesZ initial_datar
r rs ÚindicesrJ r7 r r? r' rC r. r] r r r r r r r r r r r¢ r£ r r¡ r r¤ r¥ rA rA rA rB r% ¦ sv
6-
" r% )rk rY rj r× rI c C s t tddd}|jddkr"dS |jdd
krB|jd
d krB|S |jddkr||jd
}tjtt|drp|S ||r||S dS )z1Do not emit nitpicky warnings for built-in types.)r rI c S s$ | j dr| jddd } | tjkS )Nztyping.rJ rK )rR rS ÚtypingÚ__all__)r rA rA rB Úistyping¹ s
z"builtin_resolver.<locals>.istypingr_ r^ NrV rP rO rG rN rÿ )rP rO )rP rO rÿ )r; r? ra ÚinspectÚisclassÚgetattrÚbuiltins)rk rY rj r× r© rG rA rA rB Úbuiltin_resolver¶ s
r® )rk rI c C sL | j d | jt | jddd | jdt | jdtdd d d
d d d S )
Nzsphinx.directivesrc FrY z object-description-transformzmissing-referencei )Úpriorityr6 rx T)ÚversionZ env_versionZparallel_read_safeZparallel_write_safe)Zsetup_extensionZ
add_domainr% Zadd_config_valueÚconnectrr r® )rk rA rA rB ÚsetupÏ s
r² )F)NF)N)N)tr1 r rª rà r r§ rª r r r r r r r r r
r r Zdocutilsr
Zdocutils.nodesr r Zdocutils.parsers.rstr Zdocutils.parsers.rst.statesr Zsphinxr Zsphinx.addnodesr r r Zsphinx.applicationr Zsphinx.buildersr Zsphinx.deprecationr r Zsphinx.directivesr Zsphinx.domainsr r r r Zsphinx.environmentr Z
sphinx.localer r! Zsphinx.pycode.astr" r# r¬ Z sphinx.rolesr$ Z sphinx.utilr% Zsphinx.util.docfieldsr& r' r( Zsphinx.util.docutilsr) Zsphinx.util.inspectr* Zsphinx.util.nodesr+ r, r- Zsphinx.util.typingr. r/ Ú getLoggerr8 r rá ÚVERBOSEr
r8 r7 rC r; r? rW rh r° r· rÊ rÒ rÓ rè ré rê rë r5 r= rB rE rG rP rQ rR rS rU rV rX rd re rr rs r% r® r² rA rA rA rB Ú<module> s 0
v23> h&% ? -3?H