<>iYSrSSKrSSKrSSKrSSKrSSKJr SSKJr SSK J r J r SSK r SSK r Sr"SS5r"S S \5r\"S /S Q5r"S S\ 5rSr"SS\5r"SS\5r"SS\5rSSjrg)z=Extract reference documentation from the NumPy source tree. N)warn) namedtuple)CallableMappingcU(a<USR5(d$US U(aUSR5(dM$U(a<USR5(d$US U(aUSR5(dM$U$)z.is_emptyWszz|# #r)r0r:)rr?s r read_to_next_empty_lineReader.read_to_next_empty_lineTs& %%' $%%h//rc*SnURU5$)NczUR5=(a% [UR55[U5:H$r)r r4lstripr>s r is_unindented:Reader.read_to_next_unindented_line..is_unindented]s'JJLFc$++-&8CI&E Gr)r:)rrFs r read_to_next_unindented_line#Reader.read_to_next_unindented_line\s H%%m44rcrURU-[UR5:aXRU-$gNr)r3rs r peek Reader.peekas. 77Q;TYY '! $ $rc^SRUR5R5(+$rK)joinrr r%s r r?Reader.is_emptygs!77499%++---r)r$rN)r)__name__ __module__ __qualname____firstlineno____doc__rr!rr,r0r*r:rArHrLr?__static_attributes__rr rrs> )05  .rrc\rSrSrSrSrg) ParseErrorkclURSn[US5(aU<SUR<3nU$)Nr docstring in )argshasattrr\)rmessages r __str__ParseError.__str__ls/))A, 4 % %$+T^^r(S?r)S@r*SAr+SISBjr,SCr-g)JNumpyDocStringvz{Parses a numpydoc string to an abstract representation Instances define a mapping from section title to structured data. Signaturer)SummaryExtended Summary ParametersReturnsYieldsReceivesRaisesWarnsOther Parameters AttributesMethodsSee AlsoNotesWarnings ReferencesExamplesindexNcUn[R"U5RS5n[U5Ul[ R "UR5UlUR5 g![a nX4l eSnAff=f)Nr) textwrapdedentrr_doccopydeepcopysections _parsed_data_parserYr\)rr\configorig_docstringes r rNumpyDocString.__init__sg"OOI.44T: 9%  MM$--8  KKM (K  sA// B9BBc URU$r)r)rkeys r r!NumpyDocString.__getitem__s  %%rcfXR;aURSU-SS9 gX RU'g)NzUnknown section %sFerror)r_error_location)rrvals r __setitem__NumpyDocString.__setitem__s5 '' '  !5!;5 I%(  c "rc,[UR5$r)iterrr%s r __iter__NumpyDocString.__iter__sD%%&&rc,[UR5$r)r4rr%s r __len__NumpyDocString.__len__s4$$%%rcURR5 URR5(agURR5R 5nUR S5(agURRS5R 5n[ U5S:ar[U5S1S14;a_[ U5[ U5:waGSRURRSS 5S -nURS U<S U<S U<3SS9 UR S[ U5-5=(d UR S[ U5-5$)NF .. index::Tr(-=rz...z'potentially wrong underline length... z z in r) rr0r*rLr startswithr4setrOrr)rl1l2snips r _is_at_sectionNumpyDocString._is_at_sections  **, 99==?? YY^^  # # % == & & YY^^A  $ $ & r7a ! @}}SR[)GR]]3s2w;-GGrcSnSn[U5Hup$UR5(dM O [USSS25Hup4UR5(dM O X[U5U- $)Nrr) enumerater r4)rdocijr9s r _stripNumpyDocString._stripsh   ~GAzz||&!TrT+GAzz||,SXaZ  rcURR5nUR5(dURR5(dURR S5R 5(dUS/- nXRR5- nUR5(d!URR5(dMU$)Nrr))rrArr*rLr )rsections r _read_to_next_section$NumpyDocString._read_to_next_sections))335%%'' 99>>"%++--B4 yy88: :G %%''  rc#p# URR5(dUR5nUSR5nUR S5(a X!SS4v O/[ U5S:a [ v OX RUSS54v URR5(dMgg7f)Nr..r(r)rr*rr rr4 StopIterationr)rrrds r _read_sectionsNumpyDocString._read_sectionss))--//--/D7==?Dt$$Hn$TQ##KKQR111))--//s B0B64B6c[U5n[U5n/nUR5(dUR5R 5nSU;a2UR SSS9upgUR 5UR 5pvOU(aSUpvOUSpvUR 5n[U5n[U5nUR[XgU55 UR5(dMU$)Nz :r()maxsplitr)) dedent_linesrr*r,r rrHr appendrc) rcontentsingle_element_is_typerparamsheaderarg_namearg_typerfs r _parse_param_list NumpyDocString._parse_param_listsw' 7O%%''VVX^^%Fv~%+\\$\%C"%-^^%5x~~7G())+Vh)/h113D%D$T*D MM)H= >%%''" rz:(?P(py:)?\w+):z'`(?P(?:~\w+\.)?[a-zA-Z0-9_\.-]+)`z(?P[a-zA-Z0-9_\.-]+)(|)rolerolenextrdnamenextz/(?P\s*:(\s+(?P\S+.*))?)?\s*$z^\s*z\s*z^\s*(?Pz(?P([,]\s+z)*)z(?P[,\.])?rcl^^ [U5n/nU U4Sjn/nUGHm T R5(dMTRRT 5nSnU(aRUR S5nUR S5(a+U(a$TR SUR S5T 4-SS9 U(d7T RS5(a!URT R55 MU(a/nUR S 5nUR5(dOTU"U5upn URX45 XSR5nU(aUS S :XaUS SR5nMj[[SU/55nURXt45 GMTR S T <35 GM U$)z func_name : Descriptive text continued text another_func_name : Descriptive text func_name1, func_name2, :meth:`func_name`, func_name3 c >TRRU5nU(dTRST<35 URS5nU(aURS5OURS5nX2UR 54$)zMatch ':role:`name`' or 'name'.Error parsing See Also entry rrdname2) _func_rgxmatchrgroupend)textmrrdr9rs r parse_item_name7NumpyDocString._parse_see_also..parse_item_name-sh$$T*A$$'DTH%MN776?D&*1776?0@Dquuw& &rNrftrailingzGUnexpected comma or period after function list at index %d of line "%s"Fr allfuncsr,r(r) rr _line_rgxrrrrrrrfilter) rritemsrrest line_match descriptionfuncsrrdr match_endr9s ` @r _parse_see_alsoNumpyDocString._parse_see_also sw' 'D::<<--d3JK(..v6 ##J//K(($'1~~j'A4&HI#)%4??3#7#7 DJJL)!'' 3::<<,;D,A)D LL$. +113DQ3#ABx~~/F4+78 e]+$$'DTH%MN;< rc$Sn0nURS5n[U5S:a U"USRS55SUS'UHDnURS5n[U5S:dM%U"USRS55XES'MF U$) z< .. index: default :refguide: something, else, and more cLUVs/sHoR5PM sn$s snfrr )lstss r strip_each_in2NumpyDocString._parse_index..strip_each_in]s'*+s!GGIs+ ++s!z::r(rrdefault:r)rr4)rrrrr+r9s r _parse_indexNumpyDocString._parse_indexWs  ,--% w(NumpyDocString._parse..sF3Ea<<>>3Esrz The section z appears twice in r)rmrsrtru)rnrorqrrrpT)rrr{rv)rrrrrr ValueErrorrrrOgetrrrrr)rrrr section_names has_returns has_yieldsmsgs r rNumpyDocString._parses  ++-.XFX)9WXFG =0 . :ICS/ !jM9ICS/ !"* W%%d++F7==3EF((7+88G$$((,3TYYtyy~~5N*PQ&& $ 6 6w ? PP $ 6 6D!7!: ##L11 $ 1 1' CW J&#'#7#7#@Z 'W '#+GsG cx[US5(a UR$[US5(a UR$g)N_cls_f)r_rrr%s r _objNumpyDocString._objs2 4 99  T4 77NrcURbN[R"UR5nUSURR3- nX(aSUS3OS- nU(a [ U5e[ U5 g![a SnNYf=f)Nz in the docstring of r].r))rinspect getsourcefile TypeErrorrQrr)rrrfilenames r rNumpyDocString._error_locations 99  "00; *499+=+=*>? ?C T(1%r 9C S/ ! I  s A:: B B c"U[U5U-/$r)r4)rrdsymbols r _str_headerNumpyDocString._str_headersc$i&''rc>UVs/sH nSU-U-PM sn$s snf)NrrW)rrindentr9s r _str_indentNumpyDocString._str_indents#.12cdF T!c222scPUS(aUSRSS5/S/-$S/$)Nrj*z\*r))replacer%s r _str_signatureNumpyDocString._str_signatures3  %--c59:bTA At rc,US(a USS/-$/$)Nrkr)rWr%s r _str_summaryNumpyDocString._str_summarys  ? ?bT) ) rc,US(a USS/-$/$)Nrlr)rWr%s r _str_extended_summary$NumpyDocString._str_extended_summarys# " #*+rd2 2 rc/nX(aX RU5- nXHn/nUR(aURUR5 UR(aURUR5 USR U5/- nUR (dMSR UR 5R 5(dMX RUR 5- nM US/- nU$)Nz : r))rrdrrerOrfr r)rrdr+parampartss r _str_param_listNumpyDocString._str_param_lists : ##D) )C::LL,::LL, 5)**:::"''%**"5";";"="=++EJJ77C$ B4KC rc\/nX(a X RU5- nX U- nUS/- nU$rK)r)rrdr+s r _str_sectionNumpyDocString._str_sections; : ##D) )C : C B4KC rc"US(d/$/nX RS5- nUS/- nSnUSHupE[U[5(de/nUHAupxU(a SU<SU<S3n OU(a SU<SU<S3n OSU-n URU 5 MC SR U5n X)/- nU(a'X R S R U5/5- nSnMS nX R UR /5- nM U(aUS/- nUS/- nU$) Nrvr)Trz:``z`%s`_, rF)rrrrrOrempty_description) r func_roler+ last_had_descrrflinksfuncrlinks r _str_see_alsoNumpyDocString._str_see_alsosJI  ++ t   +KEeT** **E# )-t4D)2D9D"T>D T"$99U#D 6MC''$(899 $ % '')?)?(@AA%,(  B4KC t  rcUSn/nSnURSS5nU(aSnUSU-/- nUR5H,upVUS:XaM SnUSU<SS RU5<3/- nM. U(aU$g) Nr{Frr)Tz .. index:: %sz :z: r,)rrrO)ridxr+ output_index default_indexr referencess r _str_indexNumpyDocString._str_index s7m  2. L -/00#&99; G)#L GTYYz-BCD DC $/ Jrc/nX R5- nX R5- nX R5- nSHnX RU5- nM X R S5- nX R U5- nSHnX R U5- nM SHnX RU5- nM X R 5- nSRU5$)N)rmrnrorprsrqrrrx)rwryrz)rtrur)rrr r%r(r3r:rO)rr.r+ param_listrs r raNumpyDocString.__str__s ""$$   "" ))++BJ '' 3 3CB   ,, !!),,4A $$Q' 'C53J '' 3 3C4   yy~r)rrr)F)T)r))r)).rQrRrSrTrUrrr!rrrrrrrr_role _funcbacktick _funcplain _funcnamer _funcnamenext _descriptionrrrrr-rrrrpropertyrrrrrrr r%r(r3r:rarVrWrr rhrhvsI RB4 B b  2  "  B "  B b 2 B  B b!" B#$ %H* &) '&H$ !  2N %E>M/Ju },t3j@4GI%%fj9M!))&*=MEL 7Y.78I    ! !$1 14: :     I5n&D,$(L  (3    @"rrhcj[R"SRU55RS5$)z"Deindent a list of lines maximallyr)r}r~rOr)liness r rr.s% ??499U+ , 2 24 88rc8^\rSrSrSSjrSrU4SjrSrU=r$) FunctionDoci3cXlX lUc-Uc [S5e[R"U5=(d SnUc0n[ R XU5 g)NzNo function or docstring givenr))rr@rr getdocrhr)rr1rrrs r rFunctionDoc.__init__4sO ;| !ABB..&,"C >F62rc[URSURR5n[R "UR5(a.[URSURR 5nX!4$URnX!4$)NrQ__call__)getattrr __class__rQr isclassr)r func_namer1s r get_funcFunctionDoc.get_func@sjDGGZ1H1HI ??477 # #477J0@0@AD77Drc0>SnUR5up#SSS.nUR(aPURU;a[SUR-5 USURURS5<SU<S3- nU[TU]URS 9- nU$) Nr)functionmethod)r1methzWarning: invalid role %sz.. z:: z )r.)rTr@printrsuperra)rr+r1rSrolesrQs r raFunctionDoc.__str__Hs--/#!# ::zz&04::=> UYYtzz2-F-68 8C uw44 r)rr@)r1NN) rQrRrSrTrrTrarV __classcell__)rQs@r rJrJ3s 3rrJc\rSrSrSSjrSrg)ObjDociZNcBXlUc0n[RXUS9 g)Nr)rrhr)robjrrs r rObjDoc.__init__[s$ >F&9r)r)NN)rQrRrSrTrrVrWrr r`r`Zs:rr`cR\rSrSrS/rSS\S4Sjr\S5r\S5r Sr S r g) ClassDocibrONr)c [R"U5(dUb[SU-5eXlS[R ;aSSKJn O [5nUc0nURSS5Ul U(aURS5(dUS- nX0l Uc$Uc [S5e[R"U5n[R!X5 URS /5nXvLaSnURS /5nURS S5(aXLaS n S UR"4SUR$44HupX (aM/n ['U 5Hcn X;d U(aX;aM[R"[)URU 55nU R+[-U SU "U555 Me XU 'M ggg![.a Mf=f)Nz$Expected a class or None, but got %rsphinxr)ALLshow_inherited_class_membersTr z&No class or documentation string givenmemberszexclude-membersshow_class_membersc4U(d/$UR5$r) splitlines)rs r splitlines_x'ClassDoc.__init__..splitlines_xsI<<>)rrurtr))r rRrrsysmodulessphinx.ext.autodocriobjectrshow_inherited_membersendswith_modpydocrLrhrmethods propertiessortedrPrrcAttributeError)rclsr modulenamefunc_docrri_members_excluderofieldrdoc_listrddoc_items r rClassDoc.__init__fss##CcIJ J s{{ " .(C >F&,jj *D'2# j11#66 # J ;{ !IJJ,,s#C*::i, ?H::/4 ::*D 1 1h6I * #,T\\!:".!@!B {{!H &u  ,!)d.B$!',||GDIIt4L'MH$OO )$L4J KM !.#+K!B 7J 1$ .! !s0A G  GGcBURc/$[R"UR5VVs/sH]upURS5(aXR;dM,[ U[ 5(dMCURU5(dM[UPM_ snn$s snnfN_)rr  getmembersrextra_public_methodsrr_is_show_memberrrdr1s r ryClassDoc.methodss 99 I'.'9'9$))'D1'D--666tX.((. 'D1 11s+B"B9BBc`URc/$[R"UR5VVs/sHlupURS5(aMUb2[ U[ 5(d[R "U5(dMRURU5(dMjUPMn snn$s snnfr)rr rrrrFisdatadescriptorrrs r rzClassDoc.propertiess 99 I'.'9'9$))'D1'D,\Zh%?%?--d3((. 'D1 11sB*1B*B* B*c\UR(agXRR;agg)NTF)rur__dict__)rrds r rClassDoc._is_show_members$  & & yy)) )r)rrwru) rQrRrSrTrrJrrFryrzrrVrWrr rfrfbsG&< $k4+l1111rrfcNUcV[R"U5(aSnO8[R"U5(aSnO[U[5(aSnOSnUc0nUS:Xa[ U[ X#S9$US;a [ XUS9$Uc[R"U5n[XUS9$) NclassmodulerWrt)rrr)rWrX)rrrb) r rRismodulerrrfrJrxrLr`)rcwhatrrs r get_doc_objectrs | ??3  D   c " "D X & &DD ~ wksJJ ' '377 ;,,s#Ccv..r)NNN)rUr r}rrxwarningsr collectionsrcollections.abcrrrrqr r ExceptionrYrcrhrrJr`rfrrWrr rs "-  J.J.Z {$< = uWup 9 $.$N:^:S~Sl/r