| %s | %s |
| %s | ||
| %s | %s | |
| %s | z(||
| %s | %s | z'%s |
%s
rP r zPackage Contentsz#aa55ccc s | d S )Nr )r )t)r> r r rp rq z#HTMLDoc.docmodule.s z HTMLDoc.index.. r r z#ffffffz#ee77aa)r, r- anyr rt r r r )r> r r r5 r6 r( r7 r r r r index s z HTMLDoc.index)r )r r Nr )r| )N)NN)NNN)NN)NNN)N) r% r& rX rN r _repr_instancer r r r r r r r r r r r r r r r r r rX r r> r r r ra r r r r r s< + y $: r c @ s4 e Zd ZdZdd Zdd Zdd ZeZdd Zd S ) TextReprzAClass for safely making a text representation of a Python object.c C s, t | d | _| _d| _d | _| _d S )Nr r r )r rw r r r r r )r> r r r rw s zTextRepr.__init__c C sT t t|dr@ddt|j }t | |r@t| |||S ttt|| j S )Nr% r r] ) ra r r! r% r r< r3 r5 r r )r> rL r r r r r r s zTextRepr.repr1c C sH t || j}t|}d|krDdt|ddkrDd|d | |d S |S )Nr~ z\\r r r )r3 r r r/ )r> rL r r r r r r r s zTextRepr.repr_stringc C s, yt tt|| jS d|jj S d S )Nz <%s instance>)r3 r5 r r r r% )r> rL r r r r r ( s zTextRepr.repr_instanceN) r% r& rX rN rw r r r r r r r r rc s rc c @ s e Zd ZdZe ZejZdd Zd ddZdd Z d d d Z d d dZ d ddZ dd Z d!ddZdd Zd"ddZd#ddZd$dd Zd S )%TextDocz'Formatter class for text documentation.c C s d dd |D S )z(Format a string in bold by overstriking.r c s s | ]}|d | V qdS )Nr )ri r^ r r r r_ 8 s z TextDoc.bold. . )r! )r> r. r r r bold6 s z TextDoc.bold c s> |sdS fdd| dD }|r4|d |d< d|S )z6Indent text by prepending a given prefix to each line.r c s g | ] } | qS r r )ri r )prefixr r r = s z"TextDoc.indent. . r r} )r r r! )r> r. rh r# r )rh r indent: s zTextDoc.indentc C s$ | | }| |d | d S )z&Format a section with a given heading.r z )ri r rf )r> r r Zclean_contentsr r r r A s zTextDoc.sectionNr c s d}x|D ]}t |t dkrt|\}}|| t| }|rj||fkrj fdd|D } |dd| }|d }q t |t g kr || | ||d }q W |S ) zBRender in text a class tree as returned by inspect.getclasstree().r r c 3 s | ]}t | V qd S )N)r) )ri r )r' r r r_ P s z%TextDoc.formattree. . z(%s)z, r z )r r) r! r ) r> r r' r rh r r r r! r" r )r' r r H s zTextDoc.formattreec C sD |j }tt|\}}| d||o(d| }t|dd}| |}|dk r`|| d|d }|rt|| d| }g } xNt|tjD ]<\} } |dk st | p||krt | ||r| | | f qW g } xXt|tj D ]F\} } |dk st | st | |krt | ||r| | | f qW g } x6t|tD ]&\} } t | ||r8| | | f q8W g }t }t|drxFt|jD ]6\}}}|| |r| |d n | | qW | || d d | }g }xBt|tjD ]0\} } | j |d r| |kr| | qW |rJ| || d d | }| rdd | D }| t|d|g}x&| D ] \} } | | | | | qzW || dd | }| rg }x&| D ] \} } | | | | | qW || dd | }| rFg }x*| D ]"\} } | | j | | |dd q W || dd | }t|drt |j }|dd dkr|dd dkr|dd }|| d| }t|d r|| d t |j }t|d r|| d t |j! }t|d r|| d!t |j" }yt#|}W n t$k r. d"}Y nX || d#| }|S )$z5Produce text documentation for a given module object.NAMEz - r& NzMODULE REFERENCEa. The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above. Z DESCRIPTIONrP z (package)zPACKAGE CONTENTSr r Z SUBMODULESc S s g | ] \}}|qS r r )ri rG rH r r r r s z%TextDoc.docmodule. . r CLASSES FUNCTIONSF )r2 ZDATArY r# z $Revision: r} r$ ZVERSIONrZ ZDATErW ZAUTHORrO ZCREDITSz (built-in)ZFILE)%r% r$ r r r< r r r@ r+ r+ rc r r, r8 r- setra r, r- rP addrt r! r* r_ r r. r r r) rY r rZ rW rO r rs )r> r r( r/ Zsynopdescr rb r r rG rH r r4 r5 Z modpkgs_namesr6 r' r7 Z submodulesr8 r r3 r r r r r X s $ zTextDoc.docmodulec s j }|p |}j}jfdd}||kr:d| }n|d | }|rlt||} |dd| }g } | jyt} W n t t fk r d} Y nX | rt | } | r| dkrʈ|| d t } | r| d t t}t|d kr.d x |D ]}d || q W d G fddd}| fdd} fdd} fdd}fddtD }x|r||r| n |d d t|fdd\}}tjkr|}qn krd}nd tj }t| |d | |d d }|d | |d d }|d!| |d"d }|d#| |d$d }|d%| |d&d }|}qW d | } | s|d S |d | d' d S )(z4Produce text documentation for a given class object.c S s t | |S )N)r) )r r r r r makename s z"TextDoc.docclass. .makenamezclass z = class z(%s)z, Nz()r r zMethod resolution order:z r c s e Zd Zdd Z fddZdS )z(TextDoc.docclass. .HorizontalRulec S s d| _ d S )Nr )r9 )r> r r r rw s z1TextDoc.docclass. .HorizontalRule.__init__c s | j r d d| _ d S )NzF----------------------------------------------------------------------r )r9 )r> )r: r r r; s z.TextDoc.docclass. .HorizontalRule.maybeN)r% r& rX rw r; r )r: r r r< s r< c s t ||\}}|r | x^|D ]V\}}}}yt|}W n& tk rh || Y q(X || q(W |S )N)rM r; r< r= r> r )r? ru rK r@ r( rg rA rH )rB r/ r r: r> r r rD s z TextDoc.docclass. .spillc sN t ||\}}|rJ | x&|D ] \}}}}|| q(W |S )N)rM r; r> )r? ru rK r@ r( rg rA rH )rB r/ r: r> r r rE s z*TextDoc.docclass. .spilldescriptorsc s t ||\}}|r | x~|D ]v\}}}}t|sFt|rPt|}nd }yt|} W n tk r |j| } Y nX j | |d|dd q(W |S )Nrm )r2 r" r ) rM r; rF r re r r< r __dict__r ) r? ru rK r@ r( rg rA rH r" r9 )rB r/ r r: r> r r rG s z#TextDoc.docclass. .spilldatac s, g | ]$\}}}}t | d r||||fqS ))r9 )rc )ri r( rg rh rH )r r r r s z$TextDoc.docclass. . r c s | d kS )Nr r )r% )rI r r rp % rq z"TextDoc.docclass. . z defined herezinherited from %sz Methods %s: c S s | d dkS )Nr rJ r )r% r r r rp 4 rq zClass methods %s: c S s | d dkS )Nr z class methodr )r% r r r rp 6 rq zStatic methods %s: c S s | d dkS )Nr z static methodr )r% r r r rp 8 rq zData descriptors %s: c S s | d dkS )Nr zdata descriptorr )r% r r r rp : rq z Data and other attributes %s: c S s | d dkS )Nr r4 r )r% r r r rp < rq z | )r% rA r& rf mapr! r r rN rO rs r) r r rK r rd rL rM rM r r) rv ri r )r> r r( r/ r0 rP r! rq r r" r rN rV r" rQ rI r< rD rE rG ru rS rT r )rB r/ r r: r> rI r r s zTextDoc.docclassc C s d| | S )z)Format an argument default value as text.rW )r )r> r r r r rX F s zTextDoc.formatvaluec C sr |j }|p |}d}d}t|rn|jj}|rB||k rndt|| }n,|jdk r`dt|jj| }ndt|| }||kr| |} n,|rt||g |krd}| |d | } d} t|r yt |} W n t t fk r d} Y nX | r t | } |d kr | |d } | dd } | s&d } | | | } |r@| d S t |pLd} | d | oj| | d S dS )z;Produce text documentation for a function or method object.r r z from Nz method of %s instancez unbound %s methodr z = z z lambda r} z(...)r )r% r? r; r r) rf r rY r, rN rO rs r) r ri r )r> r r( r/ rE rP rZ r[ r\ r rV rN rU r" r r r r J sH zTextDoc.docroutinec C sT g }|j }|r$|| | |d t|p.d}|rJ|| | |d d|S )Nr r )r rf r ri r! )r> r( rH r/ rf r: r" r r r r> { s zTextDoc._docdescriptorc C s | |||S )z*Produce text documentation for a property.)r> )r> r r( r/ rE r r r r s zTextDoc.docpropertyc C s | |||S )z1Produce text documentation for a data descriptor.)r> )r> r r( r/ rE r r r r s zTextDoc.docdatac C s | |}|rF|r|d p d| }|t| } | dk rF|d| d }|rX| |d pZd| }|dk r~|d| t| 7 }|S )z-Produce text documentation for a data object.z = r r Nz...r )r r rf ri r) ) r> r r( r/ r r2 r" r r Zchopr r r r s zTextDoc.docother)rg )Nr )NN)NN)NNN)NNN)NNN)NNNNN)r% r& rX rN rc rb r rf ri r r r r rX r r> r r r r r r r rd . s e 1 rd c @ s e Zd ZdZdd ZdS ) _PlainTextDocz2Subclass of TextDoc which overrides string stylingc C s |S )Nr )r> r. r r r rf s z_PlainTextDoc.boldN)r% r& rX rN rf r r r r rt s rt c C s t at| dS )zCThe first time this is called, determine what kind of pager to use.N)getpagerpager)r. r r r rv s rv c s8 t tjdstS t tjds tS tj r4tj s8tS tjdpNtjd rtj dkrj fddS tjddkr fd dS fd dS tjddkrtS tj dkrd d S t td rt d dkrdd S ddl } | \}}t | z0t td r t d| dkr dd S tS W dt| X dS )z2Decide what method to use for paging through text.isattyZMANPAGERZPAGERZwin32c s t t| S )N) tempfilepagerplain)r. ) use_pagerr r rp rq zgetpager. . ZTERM)ZdumbZemacsc s t t| S )N) pipepagerry )r. )rz r r rp rq c s t | S )N)r{ )r. )rz r r rp rq c S s t t| dS )Nzmore <)rx ry )r. r r r rp rq systemz(less) 2>/dev/nullr c S s t | dS )NZless)r{ )r. r r r rp rq Nz more "%s"c S s t | dS )NZmore)r{ )r. r r r rp rq )ra r stdin plainpagerstdoutrw r r rm platformr| tempfileZmkstempclosettypagerunlink)r fdr r )rz r ru s6 ru c C s t dd| S )z%Remove boldface formatting from text.z.r )r r )r. r r r ry s ry c C s ddl }|j|d|jd}yDtj|jdd*}y|| W n tk rP Y nX W dQ R X W n tk rr Y nX x(y| P W qv tk r Y qvX qvW dS )z3Page through text by feeding it to another program.r NT)shellr} backslashreplace)errors) subprocessPopenPIPEio TextIOWrapperr} writeKeyboardInterruptr wait)r. cmdr procpiper r r r{ s r{ c C s` ddl }| }t|ddd}|| W dQ R X zt|d | d W dt| X dS )z . c S s t j d d d d S )Nr} r )r r} r r r r r rp rq ZLINESr z -- more --)qQz ) r )bB)ry r r ttyr r} filenoZ tcgetattrZ setcbreakr r r UnsupportedOperationr r r rm rO r r r! flushZ tcsetattrZ TCSAFLUSH) r. r# r r oldZgetcharhr Zincr r r r r sL &r c C s t jtt| dS )z>Simply print unformatted text. This is the ultimate fallback.N)r r r ry r )r. r r r r~ " s r~ c C s t | r>| jtjkr d| j S t| dr4d| j S d| j S t | rRd| j S t | rtd| jj | jj| jf S t | rd| jj | jj| jf S t | rd| j S t | rd | j S t | rd | j S t| jS ) z/Produce a short description of the given thing.zbuilt-in module rP zpackage zmodule zbuilt-in function zgetset descriptor %s.%s.%szmember descriptor %s.%s.%szclass z function zmethod )r r* r% r r ra r8 r __objclass__r& r r+ r6 r7 r )thingr r r describe& s. r c C s dd | dD }d\}}xB|t|k r^td|d|d |}|rZ||d }}q P q W |rj|}nt}x8||d D ](}yt||}W q| tk r dS X q|W |S )z@Locate an object by name or dotted path, importing as necessary.c S s g | ] }|r|qS r r )ri r r r r r C s zlocate. . r )Nr Nr )r r r r! rM r< r )r r r1 r nZ nextmoduler r r r r locateA s r c C sV t | tr0t| |}|dkr(td| || fS t| dd}| t |trL|ndfS dS )zDGiven an object or a path to an object, get the object and its name.Nz~No Python documentation found for %r. Use help() to get the interactive help utility. Use help(str) for help on the str class.r% )r r) r r r< )r r r r( r r r resolveZ s r Python Library Documentation: %sc C s |dkr t }t| |\}}t|}t|}|rTd|krT|d|d|d 7 }n|rn||k rn|d|j 7 }t|st|st |st |st |st |t st|}|d7 }|| d ||| S )zBRender text documentation, given an object or a path to an object.Nr z in z in module z objectz )r. r r r r+ rfindr% r* r+ r, r r r r r r )r r r Zrendererr r( rp r r r r render_doch s$ r c C sf y2|dkr t t| || n|t| ||t W n. ttfk r` } z t| W dd}~X Y nX dS )zCDisplay text documentation, given an object or a path to an object.N)rv r r plaintextr r print)r r r outputrH r r r r" s r" c C s y`t | |\}}tt|t||}t|d ddd}|| W dQ R X td|d W n. tt fk r } z t| W dd}~X Y nX dS )z \ZZ x4e D ],Z e e eZ ee kre d< e Z e ee < qW qW d=d>d?d@dAdBdCdDdEdFdGdHdIdJdKdLdLdMdNdOdPdQddRdSdSdTdUdVdWdXdYdZd[d\d]d^d_d_d`dadbdcdddedfdgdhdidjdkdldmdndodpdqdrdsdtdudvdwdxdydzd{dd d|d}d~ddIZ dddZ edd Zedd Zdd Ze ZefddZdd Zdd Zdd Zdd ZdddZdd Zdd Zdd Z dddZ dddZ dd Z dddZ dS )Helperr BOOLEANwith)assertr )asyncr )awaitr )breakz while for)classzCLASSES SPECIALMETHODS)continuez while for)Zfunctionr )del BASICMETHODSif)elsez while fortry)forzbreak continue whileimport)globalznonlocal NAMESPACES)r TRUTHVALUE)r MODULES)inSEQUENCEMETHODS COMPARISON)lambdarl )nonlocalzglobal NAMESPACES)passr )raise EXCEPTIONS)returnrl )r r )whilez break continue if TRUTHVALUE)r z CONTEXTMANAGERS EXCEPTIONS yield)yieldr )#FalseNoneTrueandasr r r r r r defr elifr exceptfinallyr fromr r r r isr r notorr r r r r r r c C s g | ]}d D ] }|| q qS ))'r r )ri pr r r r r s zHelper. )r fr ur '''r """)+rH *z**r z//%z< >r |^~r r z<=z>=z==z!=z<>)r r z<=z>=z==z!=z<>)rH r ) z+=z-=z*=z/=z%=z&=z|=z^=z<<=z>>=z**=z//=)z< >r r r r )jJ)STRINGS OPERATORSr UNARYAUGMENTEDASSIGNMENTBITWISECOMPLEXzOPERATORS FORMATTINGPOWERzTUPLES LISTS FUNCTIONSz ATTRIBUTES FLOAT MODULES OBJECTSELLIPSISzSLICINGS DICTIONARYLITERALSz def classr PRIVATENAMESzPRIVATENAMES SPECIALMETHODSZ BACKQUOTESzTUPLES FUNCTIONS CALLSzLISTS SUBSCRIPTS SLICINGS)r z**,r z...:@r~ r] r\ `r r []r )typeszRSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect)stringsz4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPES)zstring-methodszSTRINGS FORMATTING)Z formatstringsr )r z:encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPES)ZnumberszINTEGER FLOAT COMPLEX TYPES)Zintegersz int range)Zfloatingz float math)Z imaginaryz complex cmath)Ztypesseqz$STRINGMETHODS FORMATTING range LISTS DICTIONARIES)Ztypesfunctionsz def TYPES)Z typesmethodszclass def CLASSES TYPES)zbltin-code-objectszcompile FUNCTIONS TYPES)zbltin-type-objectsz types TYPESTYPES)zbltin-null-objectr )zbltin-ellipsis-objectSLICINGS)Z specialattrsr )r z!class SPECIALMETHODS PRIVATENAMES)Z typesmodulesr )zoperator-summaryzlambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIES EXPRESSIONS)Zobjectsr )Z specialnameszbBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSES)Z customizationz hash repr str SPECIALMETHODS)zattribute-accesszATTRIBUTES SPECIALMETHODS)zcallable-typeszCALLS SPECIALMETHODS)zsequence-typesz(SEQUENCES SEQUENCEMETHODS SPECIALMETHODS)zsequence-typeszMAPPINGS SPECIALMETHODS)z numeric-typesz*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS)Z execmodelz%NAMESPACES DYNAMICFEATURES EXCEPTIONS)Znamingz3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURES)zdynamic-featuresr NAMESPACES)r ztry except finally raise)Z conversionsr )Z identifierszkeywords SPECIALIDENTIFIERS)z id-classesr )zatom-identifiersr )z atom-literalsz=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALS SEQUENCES)Z exprlistszTUPLES LITERALS)ztypesseq-mutable LISTLITERALS)ZlistszLISTS LITERALS)Z typesmappingDICTIONARYLITERALS)r zDICTIONARIES LITERALS)zattribute-referencesz(getattr hasattr setattr ATTRIBUTEMETHODS)Z subscriptionsr )Zslicingsr )Zcallsr )Zpowerr )Zunaryr )Zbinaryr )Zshiftingr )Zbitwiser )Z comparisonszEXPRESSIONS BASICMETHODS)ZbooleanszEXPRESSIONS TRUTHVALUEr )Z assignmentr )Z augassign NUMBERMETHODSr r )Zcompoundzfor while break continue)truthz if while and or not BASICMETHODS)ZdebuggerZpdb)zcontext-managersr )Ir r Z STRINGMETHODSZ FORMATTINGUNICODEZNUMBERSZINTEGERZFLOATr r ZMAPPINGSrl ZMETHODSZ CODEOBJECTSZ TYPEOBJECTSZ FRAMEOBJECTSZ TRACEBACKSZNONEr ZSPECIALATTRIBUTESrk r ZPACKAGESr r Z PRECEDENCEZOBJECTSZSPECIALMETHODSr ZATTRIBUTEMETHODSZCALLABLEMETHODSr ZMAPPINGMETHODSr Z EXECUTIONr ZDYNAMICFEATURESZSCOPINGZFRAMESr Z CONVERSIONSZ IDENTIFIERSZSPECIALIDENTIFIERSr ZLITERALSZTUPLESZ TUPLELITERALSZLISTSr r r Z ATTRIBUTESZ SUBSCRIPTSr ZCALLSr r ZBINARYZSHIFTINGr r r Z ASSERTIONZ ASSIGNMENTr ZDELETIONZ RETURNINGZ IMPORTINGZ CONDITIONALZLOOPINGr Z DEBUGGINGZCONTEXTMANAGERSNc C s || _ || _d S )N)_input_output)r> inputr r r r rw M s zHelper.__init__c C s | j p tjS )N)r r r} )r> r r r r Q s z Helper.inputc C s | j p tjS )N)r r r )r> r r r r U s z Helper.outputc C s2 t d d dkr | dS d| jj| jjf S )Nr r0 ?r z<%s.%s instance>)r stackr r& rX )r> r r r __repr__Y s zHelper.__repr__c C s6 || j k r| | n | | | jd d S )Na You are now leaving help and returning to the Python interpreter. If you want to ask for help on a particular object directly from the interpreter, you can type "help(object)". Executing "help('string')" has the same effect as typing a particular string at the help> prompt. )_GoInteractiver introinteractr r )r> requestr r r __call__a s zHelper.__call__c C s | j d xy| d}|s P W n ttfk r< P Y nX | }t|dkr|d |d krndkrn n |d |dd kr|dd }| dkrP |d kr| q| | qW d S ) Nr zhelp> r r r} )r r r )r quitr ) r r getliner EOFErrorr r r r r )r> r r r r r n s" , zHelper.interactc C s8 | j tjkrt |S | j| | j | j S dS )z.Read one line, using input() when appropriate.N)r r r} r r r r )r> promptr r r r s zHelper.getlinec C s< t |t dkr| }|dkr,| n|dkr>| n|dkrP| n|dkrb| n|d d dkr| | d n|| jkr| | nj|d krt t |d nR|| j kr| | n<|| j kr| | n&|rt |d | jd nt td | jd n$t|tr | nt |d | jd | jd d S ) Nr keywordssymbolstopicsr zmodules r )r r r z Help on %s:)r r )r r listkeywords listsymbols listtopics listmodulesr r showsymbolr" evalr showtopicr r r) r r r r )r> r r r r r s6 z Helper.helpc C s$ | j ddtjd d d S )Na Welcome to Python {0}'s help utility! If this is your first time using Python, you should definitely check out the tutorial on the Internet at https://docs.python.org/{0}/tutorial/. Enter the name of any module, keyword, or topic to get help on writing Python programs and using Python modules. To quit this help utility and return to the interpreter, just type "quit". To get a list of available modules, keywords, symbols, or topics, type "modules", "keywords", "symbols", or "topics". Each module also comes with a one-line summary of what it does; to list the modules whose name or summary contain a given string such as "spam", type "modules spam". z%d.%dr )r r r r r )r> r r r r s z Helper.intror| P c C s t t|}|| }t|| d | }xt|D ]z}xht|D ]\}|| | }|t|k r@| j|| ||d k r@| jdd|d t|| q@W | jd q2W d S )Nr r r )r sortedr r r r ) r> itemscolumnsr Zcolwr rowr rj r r r r s (z Helper.listc C s | j d | | j d S )NzN Here is a list of the Python keywords. Enter any keyword to get more help. )r r r r rD )r> r r r r s zHelper.listkeywordsc C s | j d | | j d S )Nzx Here is a list of the punctuation symbols which Python assigns special meaning to. Enter any symbol to get more help. )r r r r rD )r> r r r r s zHelper.listsymbolsc C s | j d | | j d S )NzN Here is a list of available topics. Enter any topic name to get more help. )r r r r rD )r> r r r r! s zHelper.listtopicsc C s, y dd l }W n tk r, | jd d S X | j|| j|}|s`| jdt| d S t|tdkr|| ||S |\}}y|jj| }W n( t k r | jdt| d S X | d }|r|pdd | }|r dd l }dd | d } || d } |d d | 7 }t| d S ) Nr zt Sorry, topic and keyword documentation is not available because the module "pydoc_data.topics" could not be found. z no documentation found for %s r r r zRelated help topics: z, H z %s )pydoc_data.topicsr r r r rm r r r r% KeyErrorr textwrapr! r Zwraprv ) r> topic more_xrefs pydoc_datatargetlabelxrefsr" r. r. Z wrapped_textr r r r% s6 zHelper.showtopicc C s y ddl }W n tk r dS X | j|| j|}|sDtdt|trZ| ||S |\}}|jj| }|r|pxdd | }||fS )a* Return unbuffered tuple of (topic, xrefs). If an error occurs here, the exception is caught and displayed by the url handler. This function duplicates the showtopic method but returns its result directly so it can be formatted for display in an html page. r N)zt Sorry, topic and keyword documentation is not available because the module "pydoc_data.topics" could not be found. r zcould not find topicr r ) r, r r rm r rO r r) _gettopic)r> r/ r0 r1 r2 r3 r4 r" r r r r5 s zHelper._gettopicc C s* | j | }|d\}}}| || d S )Nr )r partitionr% )r> symbolr2 r/ r] r4 r r r r# s zHelper.showsymbolc sv |r | j d| t| nR| j d i }|fdd fdd}t j |d | | | j d d S ) Nzy Here is a list of modules whose name or summary contains '{}'. If there are any, enter a module name to get more help. zI Please wait a moment while I gather a list of all available modules... c S s> |r$|dd dkr$|d d d }| ddk r:d||< d S )Niz .__init__z (package)r r r )find)r r' rp r r r r callback# s z$Helper.listmodules. .callbackc s d | d d S )Nr )r' )r9 r r onerror( s z#Helper.listmodules. .onerror)r: z Enter any module name to get more help. Or, type "modules spam" to search for modules whose name or summary contain the string "spam". )r r r apropos ModuleScannerrunr rD )r> rG r r: r )r9 r r" s zHelper.listmodules)r r r r )NN)r| r& )r )r )r )!r% r& rX r Z _strprefixesZ_symbols_inverser r( r/ Zsymbols_r7 rm r rw r r r r r r r r r r r r r r r! r% r5 r# r" r r r r r s6 r c @ s e Zd ZdZdddZdS )r< z7An interruptible scanner that searches module synopses.Nc C s |r | }d| _i }xztjD ]p}|dkr d||< |d krH|d |d q t|jpTd}|dd }|d | }| |dkr |d || q W xdtj |dD ]R\} }} | jrP |d kr|d |d qyt | |} W n t k r wY nX | j } t | d rny| |} W n& tk r: |r4|| wY nX tt| pNd}t | d rh| |}nd }n^ytj| }W n& tk r |r|| wY nX |jr|j d nd}t|d d }|d | }| |dkr|||| qW |r| d S ) NF__main__r r r r z - )r: get_source get_filenamerR )r r r r r rN r r8 r, r _get_specr r ra r? r= r r StringIOr@ r r r r r r< )r> r9 rG Z completerr: seenr' r( rp r6 r7 r r sourcer r r r r r= 6 s` zModuleScanner.run)NNN)r% r& rX rN r= r r r r r< 3 s r< c C sD dd }dd }t " t d t j|| |d W dQ R X dS )zAPrint all the one-line module summaries that contain a substring.c S s6 |dd dkr |d d d }t ||o.d| d S )Niz .__init__z (package)z- )r )r r' rp r r r r9 r s zapropos. .callbackc S s d S )Nr )r' r r r r: v s zapropos. .onerrorignore)r: N)warningscatch_warningsfilterwarningsr< r= )rG r9 r: r r r r; p s r; c s ddl ddlddlddlG dd djj G fdddjjG fdddj}|| ||}| x|j s|j st d qW |S ) aA Start an HTTP server thread on a specific port. Start an HTML/text server thread, so HTML or text documents can be browsed dynamically and interactively with a Web browser. Example use: >>> import time >>> import pydoc Define a URL handler. To determine what the client is asking for, check the URL and content_type. Then get or generate some text or HTML code and return it. >>> def my_url_handler(url, content_type): ... text = 'the URL sent was: (%s, %s)' % (url, content_type) ... return text Start server thread on port 0. If you use port 0, the server will pick a random port number. You can then use serverthread.port to get the port number. >>> port = 0 >>> serverthread = pydoc._start_server(my_url_handler, port) Check that the server is really started. If it is, open browser and get first page. Use serverthread.url as the starting page. >>> if serverthread.serving: ... import webbrowser The next two lines are commented out so a browser doesn't open if doctest is run on this module. #... webbrowser.open(serverthread.url) #True Let the server do its thing. We just need to monitor its status. Use time.sleep so the loop doesn't hog the CPU. >>> starttime = time.monotonic() >>> timeout = 1 #seconds This is a short timeout for testing purposes. >>> while serverthread.serving: ... time.sleep(.01) ... if serverthread.serving and time.monotonic() - starttime > timeout: ... serverthread.stop() ... break Print any errors that may have occurred. >>> print(serverthread.error) None r Nc @ s e Zd Zdd Zdd ZdS )z!_start_server. .DocHandlerc S sX | j drd}nd}| d | dd| | | j| | j |d dS ) 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.cssztext/cssz text/html z Content-Typez%s; charset=UTF-8zutf-8N) r r` Z send_responseZ send_headerZ end_headersZwfiler urlhandlerr )r> content_typer r r do_GET s z(_start_server. .DocHandler.do_GETc W s d S )Nr )r> r r r r log_message s z-_start_server. .DocHandler.log_messageN)r% r& rX rL rM r r r r DocHandler s rN c s( e Zd Zdd Z fddZdd ZdS )z _start_server. .DocServerc S s6 || _ | j |f| _|| _| j| | j| j d| _d S )NF)hostZaddressr9 rI rw handlerr )r> rO portr9 r r r rw s z)_start_server. .DocServer.__init__c sB x4| j s4 | j gg g d\}}}|r| qW | d S )Nr )r selectZsocketr Zhandle_requestZ server_close)r> ZrdZwrZex)rR r r serve_until_quit s z1_start_server. .DocServer.serve_until_quitc S s | j | | jr | | d S )N)rI server_activater9 )r> r r r rT s z0_start_server. .DocServer.server_activateN)r% r& rX rw rS rT r )rR r r DocServer s rU c s: e Zd ZfddZ fddZdd Zdd Zd S ) z#_start_server. .ServerThreadc s2 || _ || _t|| _ j| d| _d | _d S )NF)rJ rO r rQ Threadrw servingerror)r> rJ rO rQ ) threadingr r rw s z,_start_server. .ServerThread.__init__c sx yJj j_ _jj _t| j _| j | j | j }|| _ | W n( tk rr } z || _W dd}~X Y nX dS )zStart the server.N)server HTTPServerrI rP r ZMessageZ MessageClass staticmethodrJ rO rQ ready docserverrS r= rX )r> Zdocsvre)rN rU emailhttpr r r= s z'_start_server. .ServerThread.runc S s, d| _ |j| _|j| _d| j| jf | _d S )NTz http://%s:%d/)rW rO Z server_portrQ r )r> rZ r r r r] s z)_start_server. .ServerThread.readyc S s& d| j _| d| _ d| _d| _dS )z&Stop the server and this thread nicelyTNF)r^ r r! rW r )r> r r r stop s z(_start_server. .ServerThread.stopN)r% r& rX rw r= r] rb r )rN rU r` ra rY r r ServerThread s rc g{Gz?) Z http.serverZ email.messagerR rY rZ ZBaseHTTPRequestHandlerr[ rV r rX rW timeZsleep)rJ hostnamerQ rc Zthreadr )rN rU r` ra rR rY r _start_server~ s 8 ' rf text/htmlc s G fdddt }| fdd fdd fdd fd d fd d fd d fdd fdd fdd}| dr| dd } |dkrtjtjt}tj|| }t|}d| S Q R X n|dkr|| S t d|| f dS ) a The pydoc 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. c s e Zd Z fddZdS )z _url_handler. ._HTMLDocc s d}d| }d|| |f S )zFormat an HTML page.zpydoc_data/_pydoc.cssz1a Pydoc: %s %s%s%sr )r> r r css_pathZcss_link) html_navbarr r r ! s z#_url_handler.._HTMLDoc.pageN)r% r& rX r r )ri r r _HTMLDoc s rj c s> dt t d t f } d| tjddf S )Nz %s [%s, %s]r aZ Python %sT)Zterse)r r Zpython_versionZ python_buildZpython_compiler)r3 )r r r ri 1 s z!_url_handler.
%s.html_navbarc s dd } ddd}dd tjD } || }|d d dd | g}i }x tjD ]}| || qVW |d d d |fS )zModule Index page.c S s d| | f S )Nz%sr )r( r r r bltinlinkO s z3_url_handler. .html_index. .bltinlinkz7Index of Modulesz#ffffffz#7799eec S s g | ]}|d kr|qS )r> r )ri r( r r r r U s z4_url_handler. .html_index. . z zBuilt-in Modulesz#ee77aaz|
pydoc by Ka-Ping Yee<ping@lfw.org>zIndex of Modulesr ) r r r r r r r ra r! )rk r namesr rC r )r r r html_indexL s z _url_handler.
.html_indexc s g fdd}t * t d dd }t j|| |d W dQ R X dd }g }d d d }x" D ]\}}|||| qhW |d | d dd| }d|fS )zSearch results page.c s: |dd dkr |d d d } ||o0d| f d S )Niz .__init__z (package)z- )r )r r' rp ) search_resultr r r9 j s z3_url_handler. .html_search. .callbackrE c S s d S )Nr )r' r r r r: q s z2_url_handler. .html_search. .onerror)r: Nc S s d| | f S )Nz%sr )r( r r r rk v s z4_url_handler. .html_search. .bltinlinkz5Search Resultsz#ffffffz#7799eezkey = %sz#ee77aaz
zSearch Results) rF rG rH r< r= r r r r! ) rG r9 r: rk rf r r( rp r )r )rn r html_searche s z!_url_handler..html_searchc sL dd } ddd}ttj } || }| ddd| }d|fS )z Index of topic texts available.c S s d| | f S )Nz %sr )r( r r r rk s z4_url_handler. .html_topics. .bltinlinkz,INDEXz#ffffffz#7799eeZTopicsz#ee77aa)r r' r r rD r r )rk r rl r )r r r html_topics s z!_url_handler. .html_topicsc sL ddd} ttj }dd } ||}| ddd| }d|fS )zIndex of keywords.z,INDEXz#ffffffz#7799eec S s d| | f S )Nz %sr )r( r r r rk s z6_url_handler. .html_keywords. .bltinlinkZKeywordsz#ee77aa)r r' r r rD r r )r rl rk r )r r r html_keywords s z#_url_handler. .html_keywordsc s t }t||}|| \}}| |jkr0d}nd} d| dd}d | } | dd|}|rt| }dd } ||} d dd|}d || f d |||ffS ) zTopic or keyword help page.ZKEYWORDZTOPICz)%sz#ffffffz#7799eez %sz#ee77aac S s d| | f S )Nz %sr )r( r r r rk s z7_url_handler..html_topicpage. .bltinlinkzRelated help topics: z%s %sr ) r rB r r5 r r r r r' r r r r! )r/ ZbufZhtmlhelpr r4 r r rk )r r r html_topicpage s& z$_url_handler. .html_topicpagec s@ t | dd}|d kr$| dkr$tdt|} || }||fS )Nr )r r zcould not find object)r rO r r )r r9 r content)r r r html_getobj s z!_url_handler. .html_getobjc sP ddd}d fddtt||D }| | dd| }d| |fS ) Nz,Errorz#ffffffz#7799eez
c 3 s | ]} |V qd S )N)r )ri r )r r r r_ s z3_url_handler..html_error. . z#bb0000z Error - %s)r r! r r r )r r r r )r r r html_error s z _url_handler. .html_errorc sr | }| dr| dd } y| dkr2 \}}n| dkrF \}}n| dkrZ \}}nd| kr$| d\}}} |dkr| \}}n|d kry| \}}W n tk r | \}}Y nX n\|d kr| dkr \}}n4y| \}}W n" tk r | \}}Y nX ntd n | \}}W n2 tk rd } z||\}}W dd}~X Y nX ||S ) z Generate an HTML page for url.z.htmlN)r ra r r rW z search?keyz topic?keyzget?keyz bad pydoc url)r` r6 rO r= r )r Z complete_urlr rs opr] r )r ru rt rm rq ro rr rp r r get_html_page s> z#_url_handler. .get_html_pager r Nztext/cssr z text/htmlz"unknown content type %r for url %s) r r_ r r dirnamerealpathrR r! r readlinesrs )r rK rj rx Z path_hererh fpr ) r ru rt rm rq ri ro rr rp r _url_handler s* ( r} T localhost) open_browserre c C s ddl }tt|| }|jr(t|j dS |jrd}|rB||j zy^td|j t| xD|jrtd}| }|dkr~P q\|dkr||j q\t| q\W W n t t fk r t Y nX W d|jr| td X dS ) zStart the enhanced pydoc Web server and open a Web browser. Use port '0' to start the server on an arbitrary port. Set open_browser to False to suppress opening a browser. r Nz"Server commands: [b]rowser, [q]uitzServer ready atzserver> r r zServer stopped) webbrowserrf r} rX r rW r r r r r r rb )rQ r re r Z serverthreadZserver_help_msgr r r r browse s2 r c C s t | to| tjdkS )Nr )r r) r8 r sep)rL r r r ispath( s r c C sv d| ks t j| ks t | kr"dS t jt}t j|}| }|| krbt j||sb|| | dt |S )zEnsures current directory is on returned path, and argv0 directory is not Exception: argv0 dir is left alone if it's also pydoc's directory. Returns a new path entry list, or None if no adjustment is needed. r Nr ) r curdirgetcwdr ry rR copysamefileremoveinsert)Z given_pathZargv0Z stdlib_dirZ script_dir revised_pathr r r _get_revised_path+ s r c C s, t tjtjd } | dk r(| tjdd< dS )zEnsures current directory is on sys.path, and __main__ directory is not. Exception: __main__ dir is left alone if it's also pydoc's directory. r N)r r r argv)r r r r _adjust_cli_sys_pathG s r c C s ddl } G dd dt}t yp| tjdd d\}}d}d}d}d}d}x`|D ]X\} } | d krnd }d }| d krt| dS | d krd }| }| d krd }| dkrVd }| }qVW |rt|||d dS |s|x|D ]} t| rtj | st d| P y`t| r tj | r t | } |rPt| rFtj | rFt| nt| n t| W q tk r } z t | W dd} ~ X Y qX qW W nN | j|fk r tj tj tjd d } t dj| tjd Y nX dS )z@Command-line interface (looks at sys.argv to decide what to do).r Nc @ s e Zd ZdS )zcli. .BadUsageN)r% r& rX r r r r BadUsageT s r r zbk:n:p:wFr~ z-bTz-kz-pz-wz-n)re r zfile %r does not exista pydoc - the Python documentation tool {cmd} ... Show text documentation on something. may be the name of a Python keyword, topic, function, module, or package, or a dotted reference to a class or function within a module or module in a package. If contains a '{sep}', it is used as the path to a Python source file to document. If name is 'keywords', 'topics', or 'modules', a listing of these things is displayed. {cmd} -k Search for a keyword in the synopsis lines of all available modules. {cmd} -n Start an HTTP server with the given hostname (default: localhost). {cmd} -p Start an HTTP server on the given port on the local machine. Port number 0 can be used to get an arbitrary unused port. {cmd} -b Start an HTTP server on an arbitrary unused port and open a Web browser to interactively browse documentation. This option can be used in combination with -n and/or -p. {cmd} -w ... Write out the HTML documentation for a module to a file in the current directory. If contains a '{sep}', it is treated as a filename; if it names a directory, documentation is written for all the contents. )r r )getoptr= r r r r; r r r r existsr rx r r r r r r rX r r r r )r r Zoptsr ZwritingZ start_serverr rQ re ZoptvalargrH r r r r cliQ s` " r r> )NN)r )r )r r N)r r N)r )r N)rg )r )[rN r& rW rZ rO rM Zimportlib._bootstrapr Z importlib._bootstrap_externalimportlib.machineryimportlib.utilr r r r, r r r r rd r Z urllib.parser' rF collectionsr reprlibr tracebackr r r r$ r) r- r/ r3 r IGNORECASEr4 r5 r: r? rC rM rc rd rv rz r r r= r r r r r r rc rd rt rv ru ry r{ rx r r r~ r r r. r r r r r" r r r r r< r; rf r} r r r r r r% r r r r & s ' 0<* ; p" , = n% U