JedZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z m Z ddlmZmZddlmZddlmZmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#GddeZ$d d Z%d Z&y) z PyDoc patchN)_DEV)is_dark_interfaceget_font)to_text_string) classnameclassify_class_attrsdescribeDocformat_exception_onlyHelperHTMLRepr_is_bound_method ModuleScannerlocatereplace visiblenameisdatagetdocdeque _split_listceZdZdZeZej ZejZdZddZ ddZ dZ dZ ddZ d Zd Zd Zd Zd ZdZdiiifdZddZddZddiifdZdZddiiidfdZdZddZddZddZddZy) CustomHTMLDocz Formatter class for HTML documentation. See: https://github.com/aroberge/mod_pydoc/blob/master/mod_pydoc/pydoc.py cd|d|dS)Format an HTML page.z+ Python: z. z )selftitlecontentss G/usr/lib/python3/dist-packages/spyder/plugins/onlinehelp/pydoc_patch.pypagezCustomHTMLDoc.page.sH & &c.dj||xsdS)zFormat a page heading.z`
{}{}
 format)rrextrass r headingzCustomHTMLDoc.heading8s uf() *r"Ncdj||}|r|dj|||z}n|r|dj||z}dj|}|dz|zS)z Format a section with a heading.z; zI z z{}
{}
{} {}
{}
{}{}

z r%) rrrwidthprelude marginaliagap css_classresults r html_sectionzCustomHTMLDoc.html_section?s  y%  6*gs34F$fZ56F.44X>44x??r"cPdj|}|j|g|i|S)z$Format a section with a big heading.z%{})r&r0)rrargskwargss r bigsectionzCustomHTMLDoc.bigsectionVs/7>>uE t  8888r"c f|j|j}t|dddddddd S)z!Format literal preformatted text.z z  r$ 
)escape expandtabsrrtexts r preformatzCustomHTMLDoc.preformat[s7{{4??,-tVWfg (D(< dr8zz.%s
)lenrange)rlistr&colsr/rowscolis r multicolumnzCustomHTMLDoc.multicolumnasD $q 4'; &CJ9 48T#Xd]3 As4y=#fT!Wo5@F Ag%F &@&HHr"c d|zS)z Grey span.z%srr;s r greyzCustomHTMLDoc.greyos -44r"c8|D]}||vsd||d|dcS|S)z:Make a link for an identifier, given name-to-URL mappings. r)rnamedictsdicts r namelinkzCustomHTMLDoc.namelinkss0 BDt|04T DAA B r"c |jtjj|j}}t ||r.t |||ur d|jd|dt||dSt||S)zMake a link for a class.rM.html#rNrO)__name__sysmodulesget __module__hasattrgetattrr)robjectmodnamerPmodules r classlinkzCustomHTMLDoc.classlinkzse 8I8I(Jf 64 WVT%:f%Dy'AC C))r"c<d|jd|jdS)zMake a link for a module.rM.html">rO)rVrr]s r modulelinkzCustomHTMLDoc.modulelinks OOV__. .r"c||\}}}}|r|j|S|r |d|d}nd|z}|rd|z}n|}d|d|dS)z;Make a link for a module or package to display in an index...htmlz%s.htmlz%s (package)rMrNrO)rK)r modpkginforPpath ispackageshadowedurlr<s r modpkglinkzCustomHTMLDoc.modpkglinksV*4'dIx 99T? " "&-Cd"C &-DD(+T22r"cd|d|dS)zMake a link to source file.z 0Cc7DSk))#x8SAB?#c(JVC[IJ@3s8KVC[IJc#a%C'MM$@By4/0t}}T7;<D12 vd45k*+wwwr"cd}|D]}t|tdurq|\}}|dz}||j||z}|rJ||fk7rDg}|D]#} |j|j| |%|dzdj|zdz}|dz}t|tgus|d|j ||zz}d |zS) zS Produce HTML for a class tree as given by inspect.getclasstree(). r?rz
rs, )z
z
%s
z
%s
)typer`rxr{ formattree) rtreer^parentr/entrycbasesparentsbases r rzCustomHTMLDoc.formattrees 'EE{d2h& 5&$..G"<<Uvi/ G %Ft~~dG'DEF#c\DIIg,>>DF)+eR("3doo7A7'#'' '3V;;r"c  |j} |j}|jd}g}t t |dz D];}|j djdj|d|dz||=dj||ddz} tj|} | } tjdk(rddl } | j| } j| | } g}t#|d r[t%|j&}|dd d k(r|ddd k(r|d dj)}|j d j+|zt#|dr3|j j+t%|j,|r| ddj|zz} j/|}|dt1z}nd}d| z|z}j3| |}tj4|tj6}gi}}tj4|tj8D]Q\}}|tj:|xs||us$t=|||s2|j ||fd|zx||<||<S|D]\}}|j>D]s}|j|j@}}tjBjE|}||k7s@|sCt#||sPtG|||us_||vsd|dz|zx||<||<ugi}}tj4|tjHD]{\}}|-tjJ|stj:||us5t=|||sC|j ||fd|z||<tjL|st||||<}g}tj4|tND]&\}}t=|||s|j ||f(jQtS|jT||}|xrdj|}|d|zz}t#|drg}tWjX|jZD]\} }}!|j |||!df|j]j_|j`}"|jcd|"dz}n.|r,j_|fd}"|jcd|"dz}|r|Dcgc]\}}| }#}}jetjf|#d|g}"|D])\}}|"j ji|||||+|jcd d!j|"d"z}|rVg}"|D])\}}|"j ji|||||+|jcd#d!j|"d$z}|rSg}"|D]&\}}|"j ji||(|jcd%d&j|"d'z}t#|d(rFjQt%|jjjT}"|jcd)|"d*z}t#|d+rFjQt%|jljT}"|jcd,|"d-z}|S#t$rd}YwxYw#t $rd} YwxYwcc}}w).z/Produce HTML documentation for a module object.Nrfr@z/{}win32rz (built-in) __version__ z $Revision: $z version %s__date__z (%s)rz-
Module Referencer?zindex
#rUz#-z{}z

%s

__path__zPackage Contentspackager.c,j|dSNr@)rd)trs r z)CustomHTMLDoc.docmodule..6s4??1Q4#8r"Modulesr_Classesr6r} Functions functionsDatar8data __author__Authorauthor __credits__Creditscredits)7rV__all__AttributeErrorsplitrCrBrxr&r{inspect getabsfilerWplatform nturl2path pathname2urlrp TypeErrorr[strrstripr9r getdocloclocalsr( getmembersismoduleisclass getmoduler __bases__rZrXrYr\ isroutine isbuiltin isfunctionrrrr=pkgutil iter_modulesrsortrIrmr4r getclasstreedocumentrr)$rr]rPmodignoredrpartslinksrHheadrirlrrpinfoversiondoclocr'r/rXr}cdictkeyvaluerr^r_r|fdictrdocmodpkgsimporterispkgr classlists$` r docmodulezCustomHTMLDoc.docmodules$ ..C 3s5z!|$ 7A LLAHHXXeDQqSk*E!H6 7 7xxbc *+ $%%f-DC||w&! --d3}}S$/H 6= )&,,-Gs|11gbclc6I!"R...0 KK t{{7';; < 6: & KK C$89 : 'DIIdO33D'  ?&(J F,x7&@dF+$$VW-=-=>R!,,VW__E :JC&&u-7FBsC0NNC<003c 9E#Ju  :" :JC :#}}dooW1d?v'Fvs+t3e+ '( 2S 8:E#Jt  : :2u!,,VW5F5FG 2JC%%e,%%e,6sC0LL#u.!%E#J))%0',Sze  2!,,VV< *JC3V, S%L) *kk&.$..%G3'..s3-#-- 6: &G,3,@,@OO-% :('5ua89 : LLN''AHdoo"H .CCF ''8:Hdoo8x.99F 3:;>JHdoo(h.88F 6= ){{3v'9'9#:DNNKHdoo8y.::F u C   $#H $X.HorizontalRulecd|_yNrneedoners r __init__z7CustomHTMLDoc.docclass..HorizontalRule.__init__gs   r"c<|jrdd|_y)Nz
r@r)rpushs r maybez4CustomHTMLDoc.docclass..HorizontalRule.maybejs<<N  r"N)rVrZ __qualname__rr)rsr HorizontalRulerfs  ! !r"rz&
Method resolution order:
z
%s

c &t||\}}|rV j||D]9\}}}} t |}j||  d;|S#t$rj || Y0wxYw)Nr7)rrr\r Exception_docdescriptor)msgattrs predicateokrPkindhomeclsrr}r|hrmdictrr]rrs r spillz%CustomHTMLDoc.docclass..spillzs#E95IB S 24 .D$ % ' 5T]]!4eWe"$%J L%DT00ucBC Ds A++"BBct||\}}|r=j ||D] \}}}} j|| "|SN)rrr) rrrrrPrrrrrrrs r spilldescriptorsz0CustomHTMLDoc.docclass..spilldescriptorss\#E95IB S 24@.D$,,T5#>?@Lr"ct||\}}|r‰ j||D]\}}}}jt||}t |st j |rt|dd} nd} | d|zn;jt|j } d| z} d|| dd|S)N__doc__
%s

%s

z
r7) rrdocotherr\callablerisdatadescriptorrrr=)rrrrrPrrrrrr}r|rrrr]rrs r spilldataz)CustomHTMLDoc.docclass..spilldatas#E95IB S 24 .D$==)>cJD'*B*B5*I%eY="{>EF"kk&-*/%A83>4EFJ Lr")objr-rc|duS)Nrr)r thisclasss r rz(CustomHTMLDoc.docclass..s1!2r"z defined herezinherited from %sz:
c |dSrrrs r rz(CustomHTMLDoc.docclass..s QqTr")rz Methods %sc|ddk(S)Nr@methodrr s r rz(CustomHTMLDoc.docclass..sAaDH$4r"zClass methods %sc|ddk(S)Nr@z class methodrr s r rz(CustomHTMLDoc.docclass..sAaDN$:r"zStatic methods %sc|ddk(S)Nr@z static methodrr s r rz(CustomHTMLDoc.docclass..sAaDO$;r"zReadonly properties %sc|ddk(S)Nr@zreadonly propertyrr s r rz(CustomHTMLDoc.docclass..sqt7J/Jr"zData descriptors %sc|ddk(S)Nr@zdata descriptorrr s r rz(CustomHTMLDoc.docclass..sqt7H/Hr"zData and other attributes %sc|ddk(S)Nr@rrr s r rz(CustomHTMLDoc.docclass..s!r"r? class z = class z(%s)rz%s
 docclassr)rVrrxrrgetmrorBrr`rZr rr\rrpopleftrbuiltinsr]rr{rrr=r0) rr]rPrr|r}rrealnamerrrmrorrrrrclsrrrranchor inheritedtagrrrrrrr s `` ``` @@@@r rzCustomHTMLDoc.docclass[s??x   ! ! GNN6*+ s8a< HHJ : ; J_t~~d6<6G6G(IIJ J O  (   ,0DF/K33+T4e&1c5)33).  %Cw"%*s"2S"8 8E#J -   &e  KKM !!HQK *2 4 E9HOO+!f$$)DNNv00-22 9 C JJ>J *,,e46E,s2E:rz D D- * !  !s*F;;GGcg}|j}|r |d|z|j0|jt||j}|d|z|ddj |S)Nz
%s
z
%s
z
r?)rxrrrr=r{)rrPrrrrrs r rzCustomHTMLDoc._docdescriptor<si~~  $t+ , == $++fUmT^^z&CustomHTMLDoc.index..\s!@RFc"g///@s#%r?r@indexr) rranyrxrrBrIrmr4)rdirrkrrrPrrs r rBzCustomHTMLDoc.indexVs  H%,%9%93%%@  !HdE@4@@ NND"eTX-=> ?HTN     w<''AH??3G?D Dr")r?)r?Nr$r?)r)NN)NNN)rVrZrrr_repr_instancer"r9r!r(r0r4r=rIrKrSr`rdrmrprrrrr#r1rr6rr;rBrr"r rr sZN   D  " "F&**+-5@.9 < I5*. 38#'b"b' V<*B%)d"b];~2'+R<E|  6' 6r"rc | G fddt}|fd fd fdfd fdfd fd fd  fd  f d }|jd r|dd}|dk(rtjj tjj t }tjj||}t|5}dj|jcdddS|dk(r||Sttd||fz#1swY"xYw)aBPydoc url handler for use with the pydoc server. If the content_type is 'text/css', the _pydoc.css style sheet is read and returned if it exits. If the content_type is 'text/html', then the result of get_html_page(url) is returned. See https://github.com/python/cpython/blob/master/Lib/pydoc.py ceZdZfdZdZy)_url_handler.._HTMLDocc tdj}tdj}trd}nd}d|z}d|z}d|d ||d |d  d |d }|S)r rich_font)optionfontzstatic/css/dark_pydoc.csszstatic/css/light_pydoc.cssz2z'zY Pydoc: zM z, z*
z
)rfamilyr) rrrrich_text_fontplain_text_fontcss_pathcss_link code_style html_page html_navbars r r!z#_url_handler.._HTMLDoc.pagexs|%[9@@BN&f5<<>O "67E  :OK Hj. ]H.I r"cd|d|dS)Nz Python 
T)tersea )r9rpython_version python_buildpython_compiler)rhtmls r rVz!_url_handler..html_navbarsg++x/F/F/H/7/D/D/Fq/I/7/G/G/IKL(DKK(9(9(EF#H Hr"cd}jd}tjDcgc] }|dk7r| }}j||}|dj d|dzg}i}tj D]#}|j j||%|j dd d j|fScc}w) z Index page.cd|d|dSNrMrbrOrrPs r bltinlinkz3_url_handler..html_index..bltinlink 15t< Index of Modules__main__z

zBuilt-in Modulesbuiltin_modulesrzT

pydoc by Ka-Ping Yee<ping@lfw.org>

zIndex of Modulesr?) r(rWbuiltin_module_namesrIr4rirxrBr{)rer(rPnamesrseenrDr`s r html_indexz _url_handler..html_indexs =,,>?"%":":($J&((##E95UT__ 4E&5&GGH88 3C OODJJsD1 2 3  ' ("2778#444(sB?c g fd}tj5tjdd}tj |||dddd}g} j d} D]\}}|j |||z!| jdj|d j|d z}d|fS#1swY|xYw) zSearch results page.cZ|dddk(r|dddz}j||xrd|zfy)Niz .__init__z (package)z- )rx)rir^desc search_results r callbackz3_url_handler..html_search..callbacks=rs|{*!#2,5  '4+?D4K!@ Ar"ignorecyrr)r^s r onerrorz2_url_handler..html_search..onerrorsr")rtNcd|d|dSrcrrds r rez4_url_handler..html_search..bltinlinkrfr"zSearch Resultszkey = {}r[rvr) warningscatch_warningsfilterwarningsrrunr(rxr4r&r{) rrqrtrerr(rProrrpr`s @r html_searchz!_url_handler..html_searchs  B  $ $ & @  # #H -  O  #w  ?  @ =,,/0' 3JD$ NN9T?T1 2 3T__   c "FKK$8H-NN))# @ @s 5CCc@|jdd}tj|5}j|j }ddddz}j d}|j dj||dz}d |z|fS#1swYLxYw) z-Get and display a source file listing safely.z%20r6N 
%s
z File ListingzFile: {}getfilerz getfile %s)rtokenizeopenr9readr(r4r&)rifplinesbodyr(rr`s r html_getfilez"_url_handler..html_getfiles||E3' ]]4  +BKK *E +&,,~.T__Z->->t-Dd7@-BBd"H,, + +s BBcd}jddz}ttjj }j ||}|j d|dz}d|fS)zIndex of topic texts available.cd|d|dSNz.html_topicsst B,,01F:v}}))+,##E95T__ h(-44!!r"cjd}ttjj }d}j ||}|dzj d|dz}d|fS)zIndex of keywords.zIndex of Keywordscd|d|dSrrrds r rez6_url_handler..html_keywords..bltinlinkrr"r[Keywordskeywordsr)r(rr rrrIr4)r(rjrerr`s r html_keywordsz#_url_handler..html_keywordsst,,23v++-. B##E95V#doo J'6'888##r"ctj}t||}|j|\}}||jvrd}nd}j |}dj |z}j||d}|rBt|j}d}j||}jd|d}|d|d j|||ffS) zTopic or keyword help page.KeywordTopicr|rrcd|d|dSrrrds r rez7_url_handler..html_topicpage..bltinlinks :>EEr"zRelated help topics: r6r?) ioStringIOr _gettopicrr(rr4rrrIr0r{) topicbufhtmlhelprxrefsrr(rer`s r html_topicpagez$_url_handler..html_topicpage skkm#s#",,U3% H%% %EE,,u%"T[[%::??5(h?G 5;;=)E F$$UI6E%%&=u08&:E %((E235 5r"ct|d}||dk7rttdt|}j ||}||fS)Nr@) forceloadNoneziThere was an error while retrieving documentation for the object you requested: Object could not be found)rr)rr r)rlrrcontentr`s r html_getobjz!_url_handler..html_getobj!s]SA& ;3&=LMN N --S)g~r"cjd}tr.djfdtt ||D}ndt |z}|j ||dz}d|z|fS)NErrorr[c3@K|]}j|ywr)r9)r?liner`s r rAz3_url_handler..html_error...s #J4;;t#4#Jsz%serrorrz Error - %s)r(rr{r rrr4)rlexcr(rr`s r html_errorz _url_handler..html_error+sw,,w' {{#J#8cC#H#JJHnS11HT__S(g_NNc!8++r"c~ |}|jdr|dd} |dvr  \}}n|dk(r \}}n|dk(r  \}}nd|vr~|jd\}}}|dk(r  |\}}nc|d k(r  |\}}nR|d k(r |\}}n@|d k(r|dvr  \}}n,  |\}}nt|d |z |\}}j ||S#t$r |\}}Y(wxYw#t$r|\}}YBwxYw#t$r}||\}}Yd}~`d}~wwxYw) zGenerate an HTML page for url.rgN)r?rBrrr!z search?keyz getfile?keyz topic?keyzget?keyzZThere was an error while retrieving documentation for the object you requested: Bad URL %s)endswith partitionr)rr!)rl complete_urlrroprrr`rrrrlrrzrrs r get_html_pagez#_url_handler..get_html_page5s << cr(C$ ;m#!+w!,w "!.w ]]3/ As%%0%5NE7=(%1#%6NE7;&:)7)<w9_m+)3wA-8-=NE7%EFHKLMM"-S!1wyy(()&:)4S)9w: *A-;C-@NE7A ;' c:NE7 ;s`A/D C)D, D7 D)D=D?DDDDDD D<& D77D</r@Ntext/cssr? text/htmlzrThere was an error while retrieving documentation for the object you requested: unknown content type %r for url %s) r startswithosridirnamerealpath__file__r{r readlinesrr)rl content_typerXr path_hererRrr`rrrrlrrVrzrrs @@@@@@@@@@r _url_handlerrksC=CB :DH.5,*: - " $50,*)*)X ~~c!"gz!GGOOBGG$4$4X$>? 77<< 3/ (^ +r772<<>* + +  $S!!   M N 3   !!  + +s #D22D;c ddl ddlddl ddl ddl}Gdd j j G fdd j jG fdd j}||||}d |_ |j|js6|js*|jd |js |js*|S) z Start an HTTP server thread on a specific port. This is a reimplementation of `pydoc._start_server` to handle connection errors for 'do_GET'. Taken from PyDoc: https://github.com/python/cpython/blob/3.7/Lib/pydoc.py rNceZdZdZdZy)!_start_server..DocHandlercl|jjdrd}nd}|jd|jdd|z|j  |j j |j|j|jdy#t$rYyt$rYywxYw) zProcess a request from an HTML browser. The URL received is in self.path. Get an HTML page from self.urlhandler and send it. z.cssrrz Content-Typez%s; charset=UTF-8zutf-8N) rir send_response send_header end_headerswfilewrite urlhandlerencodeConnectionAbortedErrorBrokenPipeError)rrs r do_GETz(_start_server..DocHandler.do_GETs yy!!&)) *   s #    3l B D        II|"--3VG_>) "   sAB B3(B32B3cyrr)rr2s r log_messagez-_start_server..DocHandler.log_messages r"N)rVrZrrrrr"r DocHandlerrs  8 r"rc$eZdZdZfdZdZy) _start_server..DocServerc||_|j|f|_||_|jj ||j|j d|_yNF)hostaddressrqrrhandlerquit)rrportrqs r rz)_start_server..DocServer.__init__sEDI IIt,DL$DM II  tT\\4<< @DIr"c|jsPj|jjgggd\}}}|r|j |jsP|j yr)rselectsocketfilenohandle_request server_close)rrdwrexrs r serve_until_quitz1_start_server..DocServer.serve_until_quitsZii#]]DKK,>,>,@+A2r1M B'')ii    r"cv|jj||jr|j|yyr)rserver_activaterqrs r rz0_start_server..DocServer.server_activates, II % %d +}} d#r"N)rVrZrrrr)rsr DocServerrs   $r"rc4eZdZfdZfdZdZdZy)#_start_server..ServerThreadc||_||_t||_jj |d|_d|_yr)rrrzrThreadrservingr)rrrr threadings r rz,_start_server..ServerThread.__init__s>(DODID DI    % %d + DLDJr"cn jj__jj _t|j_|j|j|j}||_ |jy#t$r}||_Yd}~yd}~wwxYw)zStart the server.N)server HTTPServerrrmessageMessage MessageClass staticmethodrrrready docserverrrr)rdocsvrerremailhttps r ryz'_start_server..ServerThread.runs !%!7!7 $. !*/--*?*? '(4T__(E %"499diiD!''')   sBB B4#B//B4cd|_|j|_|j|_d|j|jfz|_y)NTz http://%s:%d/)rr server_portrrl)rrs r rz)_start_server..ServerThread.readys:DL DI**DI&$))TYY)??DHr"cpd|j_|jd|_d|_d|_y)z'Stop the server and this thread nicely.TNF)rrr{rrlrs r stopz(_start_server..ServerThread.stops."&DNN  IIK"DN DLDHr"N)rVrZrrryrr)rrrrrsr ServerThreadrs   @  r"rTg{Gz?) http.server email.messagerrtimerBaseHTTPRequestHandlerrrdaemonrrrsleep) rhostnamerrrthreadrrrrrrs @@@@@@r _start_serverrqs T[[77 D$DKK**$*%%y''%N*h 5FFM LLNll6>> 3ll6>> Mr")r)'rrrrrrrrtrWr~rvspyder.config.baserrspyder.config.guirrspyder.py3compatrpydocrr r r r r rrrrrrrrrrrrrrr"r r sh   &9+55555 H CH VC!Ltr"