| %s | %s |
| %s | ||
| %s | %s | |
| %s | z(||
| %s | %s | z'%s |
%s
rZ r zPackage Contentsz#aa55ccc s j | d S )Nr )r )t)r> r r rr s z#HTMLDoc.docmodule.s z HTMLDoc.index.. r r z#ffffffz#ee77aa)r9 r: anyr ru r r r )r> r r rB rC r( rD r r r r index s z HTMLDoc.index)r )r r Nr )r )N)NN)NNN)NN)NNN)N) r% r& r[ rU r _repr_instancer r r r r r r r r r r r r r r& r( r r rb r rK r r r ro 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 j| d | _| _d| _d | _| _d S )Nr r r )r rz r r r r r )r> r r r rz s zTextRepr.__init__c C sT t t|dr@ddjt|jj }t | |r@t| |||S ttt|| j S )Nr% r r_ ) rc r r! r% r r< r3 r5 r r )r> rN 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> rN 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> rN r r r r r s zTextRepr.repr_instanceN) r% r& r[ rU rz r r r r r r r r rq s rq 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 dj dd |D S )z(Format a string in bold by overstriking.r c s s | ]}|d | V qdS )Nr )rk rl r r r rm ( s z TextDoc.bold. . )r! )r> r. r r r bold& s z TextDoc.bold c s> |sdS fdd|j dD }|r4|d j |d< dj|S )z6Indent text by prepending a given prefix to each line.r c s g | ] } | qS r r )rk r )prefixr r r - s z"TextDoc.indent. . r r r r )r r r! )r> r. rv r# r )rv r indent* s zTextDoc.indentc C s$ | j |j }| j|d | d S )z&Format a section with a given heading.r z )rw r rt )r> r r Zclean_contentsr r r r 1 s zTextDoc.sectionNr c s d}x|D ]}t |t f krt|\}}|| t| }|rj||fkrj fdd|D } |ddj| }|d }q t |t g kr || j| ||d }q W |S )zBRender in text a class tree as returned by inspect.getclasstree().r c 3 s | ]}t | V qd S )N)r) )rk r, )r' r r rm @ s z%TextDoc.formattree. . z(%s)z, r z )r r) r! r( ) r> r) r' r* rv r r+ r, r- r. r )r' r r( 8 s zTextDoc.formattreec C sD |j }tt|\}}| jd||o(d| }t|dd}| j|}|dk r`|| jd|d }|rt|| jd| }g } xNtj|tjD ]<\} } |dk stj | p||krt | ||r| j | | f qW g } xXtj|tj D ]F\} } |dk stj | stj | |krt | ||r| j | | f qW g } x6tj|tD ]&\} } t | ||r8| j | | f q8W g }t }t|drxFtj|jD ]6\}}}|j| |r|j |d n |j | qW |j || jd d j| }g }xBtj|tjD ]0\} } | j j|d r| |kr|j | qW |rJ|j || jd d j| }| rdd | D }| jtj|d|g}x&| D ] \} } |j | j| | | qzW || jdd j| }| rg }x&| D ] \} } |j | j| | | qW || jdd j| }| rFg }x*| D ]"\} } |j | j | | |dd q W || jdd j| }t|drt |j }|dd d#kr|d$d dkr|dd% j }|| jd| }t|dr|| jd t |j }t|d r|| jd t |j! }t|d r|| jd t |j" }ytj#|}W n t$k r. d!}Y nX || jd"| }|S )&z5Produce text documentation for a given module object.NAMEz - r3 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 DESCRIPTIONrZ z (package)zPACKAGE CONTENTSr r Z SUBMODULESc S s g | ] \}}|qS r r )rk rG rH r r r r s z%TextDoc.docmodule. . r CLASSES FUNCTIONSF )r2 ZDATAr] r/ r0 z Revision: VERSIONrT ZDATErP ZAUTHORrS ZCREDITSz (built-in)ZFILEz $Revision: r r )%r% r$ r r r< r r r@ r+ r8 re r r, r8 r- setrc r9 r: rZ addru r! r* ra r( r; r r r6 r] r rT rP rS r rt )r> r r( r< Zsynopdescr rd r r rG rH r rA rB Z modpkgs_namesrC r' rD Z submodulesrE r r@ r r r r r H s $ zTextDoc.docmodulec sf j }|p |}j}jfdd}||kr:dj| }nj|d | }|rlt||} |ddj| }t} | r| d gpg } | jtt j } t | dkrԈd x | D ]} d || qW d G fd d d }| fdd} fdd} fdd}fddt D }x|r0| rT| j n |d d t|fdd\}}tjkr|}q>n krd}ndtj }t| |d| |d d }|d | |d d }|d | |d d }|d!| |d"d }|d#| |d$d }|g ks(t|}q>W dj| } | sJ|d S |d j| j 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, r r zMethod resolution order:z r c s e Zd Zdd Z fddZdS )z(TextDoc.docclass. .HorizontalRulec S s d| _ d S )Nr )rF )r> r r r rz s z1TextDoc.docclass. .HorizontalRule.__init__c s | j r dd d| _ d S )NrU r{ r )rF )r> )rG r r rH s z.TextDoc.docclass. .HorizontalRule.maybeN)r% r& r[ rz rH r )rG r r rI s rI c s t ||\}}|r j | x^|D ]V\}}}}yt|}W n& tk rh j|| Y q(X j|| q(W |S )N)rO rH r< rJ rK r )rL rv rK rM r( ri rN rH )rO r< r rG r> r r rQ s z TextDoc.docclass. .spillc sN t ||\}}|rJ j | x&|D ] \}}}}j|| q(W |S )N)rO rH rK )rL rv rK rM r( ri rN rH )rO r< rG r> r r rR s z*TextDoc.docclass. .spilldescriptorsc s t ||\}}|r j | x~|D ]v\}}}}t|sFtj|rPt|}nd }yt|} W n tk r |j| } Y nX j | |d|dd q(W |S )Nr{ )r2 r" r ) rO rH rS r rg r r< r __dict__r ) rL rv rK rM r( ri rN rH r" r9 )rO r< r rG r> r r rT s z#TextDoc.docclass. .spilldatac s, g | ]$\}}}}t | d r||||fqS ))r9 )re )rk r( ri rj rH )r r r r s z$TextDoc.docclass. . r c s | d kS )Nr r )r1 )rV r r rr s z"TextDoc.docclass. . z defined herezinherited from %sz Methods %s: c S s | d dkS )Nr rW r )r1 r r r rr s zClass methods %s: c S s | d dkS )Nr z class methodr )r1 r r r rr s zStatic methods %s: c S s | d dkS )Nr z static methodr )r1 r r r rr s zData descriptors %s: c S s | d dkS )Nr zdata descriptorr )r1 r r r rr s z Data and other attributes %s: c S s | d dkS )Nr rA r )r1 r r r rr s z | )r% rA r& rt mapr! r r r r rX r rf rY rO rZ r r) rw r[ rw r )r> r r( r< r= r\ r- r r r. r" r r] rI rI rQ rR rT rv r_ r` r )rO r< r rG r> rV r r sn zTextDoc.docclassc C s d| j | S )z)Format an argument default value as text.ra )r )r> r r r r rb * s zTextDoc.formatvaluec C sr |j }|p |}d}d}t|rn|jj}|rB||k rndt|| }n,|jdk r`dt|jj| }ndt|| }||kr| j|} n,|rtj||g |krd}| j|d | } d} tj|r ytj |} W n t t fk r d} Y nX | r t | } |d kr | j|d } | dd } | s&d } | | | } |r@| d S t |pLd} | d | oj| j| j 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 z(...)r r )r% r? r; r r) rt r rc r, rd re rt r6 r rw r )r> r r( r< rE r\ rf rg rh r ri rd rj r" r r r r . sH zTextDoc.docroutinec C sT g }|j }|r$|| j| |d t|p.d}|rJ|| j| |d dj|S )Nr r )r rt r rw r! )r> r( rH r< rh rG r" r r r rK _ s zTextDoc._docdescriptorc C s | j |||S )z*Produce text documentation for a property.)rK )r> r r( r< rE r r r r l s zTextDoc.docpropertyc C s | j |||S )z1Produce text documentation for a data descriptor.)rK )r> r r( r< rE r r r r p s zTextDoc.docdatac C s | j |}|rF|r|d p d| }|t| } | dk rF|d| d }|rX| j|d pZd| }|dk r~|d| jt| 7 }|S )z-Produce text documentation for a data object.z = r r Nz...r )r r rt rw r6 ) r> r r( r< r* r2 r" r r Zchopr r r r t s zTextDoc.docother)ru )Nr )NN)NN)NNN)NNN)NNN)NNNNN)r% r& r[ rU rq rp r rt rw r r( r r rb r rK r r r r r r r rr s e } 1 rr c @ s e Zd ZdZdd ZdS ) _PlainTextDocz2Subclass of TextDoc which overrides string stylingc C s |S )Nr )r> r. r r r rt s z_PlainTextDoc.boldN)r% r& r[ rU rt r r r r r s r 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 r s r c s< t tjdstS t tjds tS tjj s8tjj r . ZTERMdumbemacsc s t t| S )N) pipepagerr )r. )r r r rr s c s t | S )N)r )r. )r r r rr s c S s t t| dS )Nzmore <)r r )r. r r r rr s systemz(less) 2>/dev/nullr c S s t | dS )NZless)r )r. r r r rr s Nz more "%s"c S s t | dS )NZmore)r )r. r r r rr s )r r )r r )rc r stdin plainpagerstdoutr r r ro platformr tempfileZmkstempclosettypagerunlink)r fdr r )r r r s6 r c C s t jdd| S )z%Remove boldface formatting from text.z.r )r r )r. r r r r s r c C s ddl }|j|d|jd}yDtj|jdd*}y|j| W n tk rP Y nX W dQ R X W n tk rr Y nX x(y|j 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 }|j }t|ddd}|j| W dQ R X ztj|d | d W dtj| X dS )z . c S s t jj d d d d S )Nr r )r r r r r r r rr s ZLINESr z -- more --qQz bB)r r )r r )r r r )r r r ttyr r filenoZ tcgetattrZ setcbreakr r r UnsupportedOperationr r r ro re r r r! flushZ tcsetattrZ TCSAFLUSH) r. r# r r oldZgetcharhr Zincr, r r r r sL &r c C s t jjtt| dS )z>Simply print unformatted text. This is the ultimate fallback.N)r r r r r )r. r r r r s r c C s t j| r>| jtjkr d| j S t| dr4d| j S d| j S t j| rRd| j S t j| rtd| jj | jj| jf S t j | rd| jj | jj| jf S t j | rd| j S t j | rd | j S t j | rd | j S t| jS ) z/Produce a short description of the given thing.zbuilt-in module rZ zpackage zmodule zbuilt-in function zgetset descriptor %s.%s.%szmember descriptor %s.%s.%szclass z function zmethod )r r* r% r r rc r8 r __objclass__r& r r+ r6 r7 r )thingr r r describe s. r c C s dd | j dD }d\}}xB|t|k r^tdj|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 )rk r r r r r ' s zlocate. . r Nr r )Nr )r r r r! rZ r< r )r r r> r nZ nextmoduler r r r r locate% 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 r6 r r r< )r r r r( r r r resolve> s r Python Library Documentation: %sc C s |dkr t }t| |\}}t|}tj|}|rTd|krT|d|d|jd 7 }n|rn||k rn|d|j 7 }tj|ptj|ptj |ptj |ptj |pt |t st|}|d7 }|| d |j|| 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 r8 rfindr% r* r+ r, r r r r r r )r r r Zrendererr r( r r r r r render_docL s$ r c C sf y2|dkr t t| || n|jt| ||t W n. ttfk r` } zt| W Y dd}~X nX dS )zCDisplay text documentation, given an object or a path to an object.N)r r r plaintextr r print)r r r outputrH r r r r" e s r" c C s y`t | |\}}tjt|tj||}t|d ddd}|j| W dQ R X td|d W n. tt fk r } zt| W Y dd}~X nX dS )z d?d@ddAdBd d!dd dCdDdEdFdʜIZ dGdd̈́Z eddτ Zeddτ Zdd҄ Ze ZefddԄZddք Zdd Zddڄ Zdd܄ ZdHddZdd Zdd Zdd Z dIddZ dJddZ dd Z dKddZ dS (L Helperr BOOLEANwithassertbreak while forclassCLASSES SPECIALMETHODScontinuefunctiondel BASICMETHODSifelsetryforbreak continue whileimportglobalnonlocal NAMESPACES TRUTHVALUEMODULESinSEQUENCEMETHODS COMPARISONlambdarz nonlocalglobal NAMESPACESpassraise EXCEPTIONSreturnwhile break continue if TRUTHVALUE CONTEXTMANAGERS EXCEPTIONS yieldyield)!FalseNoneTrueandasr r r r defr elifr exceptfinallyr fromr r r r isr r notorr r r r r r r c C s g | ]}dD ] }|| q qS )'r )r r r )rk pr r r r r s zHelper. r fr ur '''r """+rU ***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 typesRSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspectstrings4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPESstring-methodsSTRINGS FORMATTING formatstringsr :encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPESnumbersINTEGER FLOAT COMPLEX TYPESintegers int rangefloating float math imaginary complex cmathtypesseq$STRINGMETHODS FORMATTING range LISTS DICTIONARIEStypesfunctions def TYPES typesmethodsclass def CLASSES TYPESbltin-code-objectscompile FUNCTIONS TYPESbltin-type-objects types TYPESTYPESbltin-null-objectbltin-ellipsis-objectSLICINGS specialattrs!class SPECIALMETHODS PRIVATENAMES typesmodulesoperator-summarylambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIES EXPRESSIONSobjects specialnamesbBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSES customization hash repr str SPECIALMETHODSattribute-accessATTRIBUTES SPECIALMETHODScallable-typesCALLS SPECIALMETHODSsequence-types(SEQUENCES SEQUENCEMETHODS SPECIALMETHODSMAPPINGS SPECIALMETHODS numeric-types*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS execmodel%NAMESPACES DYNAMICFEATURES EXCEPTIONSnaming3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURESdynamic-features NAMESPACESr try except finally raise conversions identifierskeywords SPECIALIDENTIFIERS id-classesatom-identifiers atom-literals=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALS SEQUENCES exprlistsTUPLES LITERALStypesseq-mutable LISTLITERALSlistsLISTS LITERALS typesmappingDICTIONARYLITERALSr DICTIONARIES LITERALSattribute-references(getattr hasattr setattr ATTRIBUTEMETHODS subscriptionsslicingscallspowerunarybinaryshiftingbitwise comparisonsEXPRESSIONS BASICMETHODSbooleansEXPRESSIONS TRUTHVALUE assignmentr augassign NUMBERMETHODScompoundfor while break continuetruth if while and or not BASICMETHODSdebuggerpdbcontext-managers)IrG r Z STRINGMETHODSZ FORMATTINGUNICODEZNUMBERSZINTEGERZFLOATr" rm ZMAPPINGSrz ZMETHODSZ CODEOBJECTSZ TYPEOBJECTSZ FRAMEOBJECTSZ TRACEBACKSZNONEr$ ZSPECIALATTRIBUTESry r ZPACKAGESrP r Z PRECEDENCEZOBJECTSZSPECIALMETHODSr ZATTRIBUTEMETHODSZCALLABLEMETHODSr ZMAPPINGMETHODSr Z EXECUTIONrd ZDYNAMICFEATURESZSCOPINGZFRAMESr Z CONVERSIONSZ IDENTIFIERSZSPECIALIDENTIFIERSr% ZLITERALSZTUPLESZ TUPLELITERALSZLISTSrq r> ru Z ATTRIBUTESZ SUBSCRIPTSrJ 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 rz / s zHelper.__init__c C s | j p tjS )N)r r r )r> r r r rr 3 s zHelper. c C s | j p tjS )N)r r r )r> r r r rr 4 s c C s2 t j d d dkr | dS d| jj| jjf S )Nr r0 ?r z<%s.%s instance>)r stackr r& r[ )r> r r r __repr__6 s zHelper.__repr__c C s6 || j k r| j| n | j | j | jjd 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__> s zHelper.__call__c C s | j jd xy| jd}|s P W n ttfk r< P Y nX |j }t|dkr|d |d kold kn r|d |dd kr|dd }|j dkrP |d kr| j q| j | qW d S )Nr zhelp> r r r r r r quitr r )r r r r )r r ) r r getliner EOFErrorr r r r r )r> r r r r r K s" , zHelper.interactc C s8 | j tjkrt |S | jj| | jj | 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|j }|dkr,| j n|dkr>| j n|dkrP| j n|dkrb| j n|d d dkr| j|j d n|| jkr| j| nj|dkrt t |d nR|| j kr| j | n<|| j kr| j | n&|rt |d | jd nt td | jd n$t|tr | nt |d | jd | jjd d S )Nr keywordssymbolstopicsr zmodules r r r r z Help on %s:)r r )r r r )r r listkeywords listsymbols listtopics listmodulesr r showsymbolr" evalr showtopicr r r6 r r r r )r> r r r r r i s6 z Helper.helpc C s$ | j jdjdtjd 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@| jj|| ||d k r@| jjdd|d t|| q@W | jjd q2W d S )Nr r r )r sortedr r r r ) r> itemscolumnsr Zcolwr rowr rl r r r r s (z Helper.listc C s | j jd | j| jj 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 jd | j| jj 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 jd | j| jj 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, | jjd d S X | jj|| jj|}|s`| jjdt| d S t|tdkr|| j ||S |\}}y|jj| }W n( t k r | jjdt| d S X |j d }|r|pdd | }|r dd l }ddj |j d } |j| d } |d dj | 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 ro r r r r KeyErrorr textwrapr! r Zwrapr ) 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 | jj|| jj|}|sDtdt|trZ| j||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 Nt 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 r ro r re r r6 _gettopic)r> r r r r r r r" r r r r s zHelper._gettopicc C s* | j | }|jd\}}}| j|| d S )Nr )r partitionr )r> symbolr r r_ r r r r r s zHelper.showsymbolc sv |r | j jdj| t| nR| j jd i }|fdd fdd}t j |d | j|j | j jd 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 }|j ddk r:d||< d S ) N z .__init__z (package)r r r ii)find)r r' r r r r r callback s z$Helper.listmodules. .callbackc s d | d d S )Nr )r' )r 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 )r r r s zHelper.listmodules)r r )r r )r r )r r )r r )r r )r r )r r )r r )r r )r r )r r )r rz )r r )r r )r r )r rz )r r )r r )r r )r r )r r r r )r r r r )r rU r r r r r r r r r r r r r r r r r r )r r r r r r r )rU r ) r r r r r r r r r r r r )r r r r r r )r r )r, r- )r. r/ )r0 r1 )r2 r )r. r3 )r4 r5 )r6 r7 )r8 r9 )r: r; )r< r= )r? r@ )rA rB )rC rD )rE rF )rH r )rI rJ )rK r )r, rL )rM r )rN rO )rQ rG )rR rS )rT rU )rV rW )rX rY )rZ r[ )rZ r\ )r] r^ )r_ r` )ra rb )rc r )r re )rf r )rg rh )ri r )rj r )rk rl )rn ro )rp rq )rr rs )rt ru )r rv )rw rx )ry r )rz r )r{ rP )r| rP )r} rP )r~ rP )r rP )r rP )r r )r r )r r )r r )r r )r r )r r )r r )NN)r r )r )r )r )!r% r& r[ r Z _strprefixesZ_symbols_inverser r r Zsymbols_r ro r rz r r r r r r r r r r r r r r r r r 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 |j }d| _i }xztjD ]p}|dkr d||< |d krH|d |d q t|jpTd}|jdd }|d | }|j j|dkr |d || q W xdtj |dD ]R\} }} | jrP |d kr|d |d qytj | |} W n t k r wY nX | j } t | d rny| j|} W n& tk r: |r4|| wY nX ttj| pNd}t | d rh| j|}nd }n^ytjj| }W n& tk r |r|| wY nX |jr|jj d nd}t|d d }|d | }|j j|dkr|||| qW |r| d S ) NF__main__r r r r z - )r get_source get_filenamerV )r r r r r rU r r r9 r _get_specr r rc r rJ r r StringIOr r r r r r r< )r> r rG Z completerr seenr' r( r rC rD r r sourcer r r r r r s` zModuleScanner.run)NNN)r% r& r[ rU r r r r r r s r c C sD dd }dd }t j " t jd 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 )Nr z .__init__z (package)z- ii)r )r r' r r r r r O s zapropos. .callbackc S s d S )Nr )r' r r r r S s zapropos. .onerrorignore)r N)warningscatch_warningsfilterwarningsr r )rG r r r r r r M s r c s ddl ddlddlddlG dd djj G fdddjjG fdddj}|| |}|j x |j r|j rt j d q~W |S ) a7 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.time() >>> timeout = 1 #seconds This is a short timeout for testing purposes. >>> while serverthread.serving: ... time.sleep(.01) ... if serverthread.serving and time.time() - 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 jdrd}nd}| jd | jdd| | j | jj| j| j |jd 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 rb 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& r[ r r r r r r DocHandler s r c s( e Zd Zdd Z fddZdd ZdS )z _start_server. .DocServerc S s6 d| _ | j |f| _|| _| jj| | j| j d| _d S )NZ localhostF)hostZaddressr rI rz handlerr )r> portr r r r rz s z)_start_server. .DocServer.__init__c sB x4| j s4 j| jj gg g d\}}}|r| j qW | j d S )Nr )r selectZsocketr Zhandle_requestZ server_close)r> ZrdwrZex)r r r serve_until_quit s z1_start_server. .DocServer.serve_until_quitc S s | j j| | jr | j| d S )N)rI server_activater )r> r r r r s z0_start_server. .DocServer.server_activateN)r% r& r[ rz r r r )r r r DocServer s r c s: e Zd ZfddZ fddZdd Zdd Zd S ) z#_start_server. .ServerThreadc s, || _ t|| _ jj| d| _d | _d S )NF)r r r Threadrz servingerror)r> r r ) threadingr r rz s z,_start_server. .ServerThread.__init__c st yFj j_ _jj _t| j _| j | j }|| _ |j W n( t k rn } z || _W Y dd}~X nX dS )zStart the server.N)server HTTPServerrI r r ZMessageZ MessageClass staticmethodr r ready docserverr rJ r )r> Zdocsvre)r r emailhttpr r r s z'_start_server. .ServerThread.runc S s, d| _ |j| _|j| _d| j| jf | _d S )NTz http://%s:%d/)r r Z server_portr r )r> r r r r r s z)_start_server. .ServerThread.readyc S s& d| j _| j d| _ d| _d| _dS )z&Stop the server and this thread nicelyTNF)r r r! r r )r> r r r stop s z(_start_server. .ServerThread.stopN)r% r& r[ rz r r r r )r r r r r r r ServerThread s r g{Gz?) Z http.serverZ email.messager r r ZBaseHTTPRequestHandlerr r r# r r timeZsleep)r r r Zthreadr )r r r r r r r _start_server[ s 8 & r text/htmlc s G fdddt }| fdd fdd fdd fd d fd d fd d fdd fdd fdd}| jdr| dd } |dkrtjjtjjt}tjj|| }t|}dj|j 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& r[ r r )r r r _HTMLDoc s r c s> j dtj tj d tj f } d| j tjddf S )Nz %s [%s, %s]r aZ Python %sT)Zterse)r r Zpython_versionZ python_buildZpython_compiler)r@ )r r r r s z!_url_handler.
%s.html_navbarc s dd } j ddd}dd tjD } j|| }|d jd dd | g}i }x tjD ]}|j j|| qVW |jd d d j|fS )zModule Index page.c S s d| | f S )Nz%sr )r( r r r bltinlink+ s z3_url_handler. .html_index. .bltinlinkz7Index of Modulesz#ffffffz#7799eec S s g | ]}|d kr|qS )r r )rk r( r r r r 1 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 ro r! )r r namesr r r )r r r html_index( s z _url_handler.
.html_indexc s g fdd}t j * t jd dd }t j|| |d W dQ R X dd }g }jd d d }x" D ]\}}|j||| qhW |jd | d ddj| }d|fS )zSearch results page.c s: |dd dkr |d d d } j ||o0d| f d S )Nr z .__init__z (package)z- ii)r )r r' r ) search_resultr r r F s z3_url_handler. .html_search. .callbackr c S s d S )Nr )r' r r r r M s z2_url_handler. .html_search. .onerror)r Nc S s d| | f S )Nz%sr )r( r r r r R s z4_url_handler. .html_search. .bltinlinkz5Search Resultsz#ffffffz#7799eezkey = %sz#ee77aaz
zSearch Results) r r r r r r r r r! ) rG r r r rh r r( r r )r )r r html_searchA s z!_url_handler..html_searchc sL dd } j ddd}ttjj } j|| }| jddd| }d|fS )z Index of topic texts available.c S s d| | f S )Nz %sr )r( r r r r b s z4_url_handler. .html_topics. .bltinlinkz,INDEXz#ffffffz#7799eeZTopicsz#ee77aa)r r r r rD r r )r r r r )r r r html_topics_ s z!_url_handler. .html_topicsc sL j ddd} ttjj }dd } j||}| jddd| }d|fS )zIndex of keywords.z,INDEXz#ffffffz#7799eec S s d| | f S )Nz %sr )r( r r r r v s z6_url_handler. .html_keywords. .bltinlinkZKeywordsz#ee77aa)r r r r rD r r )r r r r )r r r html_keywordso s z#_url_handler. .html_keywordsc s t j }t||}|j| \}}| |jkr0d}nd} jd| dd}d j| } j| dd|}|rt|j }dd } j ||} j d dd|}d || f d j |||ffS ) zTopic or keyword help page.ZKEYWORDZTOPICz)%sz#ffffffz#7799eez %sz#ee77aac S s d| | f S )Nz %sr )r( r r r r s z7_url_handler..html_topicpage. .bltinlinkzRelated help topics: z%s %sr ) r r r r r r r& r r r r r r! )r ZbufZhtmlhelpr r r r r )r r r html_topicpage~ s& z$_url_handler. .html_topicpagec s@ t | dd}|d kr$| dkr$tdt|} j|| }||fS )Nr )r r zcould not find object)r re r r )r r9 r content)r r r html_getobj s z!_url_handler. .html_getobjc sP j ddd}dj fddtt||D }| j| dd| }d| |fS ) Nz,Errorz#ffffffz#7799eez
c 3 s | ]} j |V qd S )N)r )rk r )r r r rm 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 st | }| j dr| dd } y| dkr4 \}} n| dkrH \}}n| dkr\ \}}nd| kr&| jd\}}} |d kr| \}}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 rf } z||\}}W Y dd}~X nX j||S )z Generate an HTML page for url.z.htmlN r ro r r ra z search?keyz topic?keyzget?keyz bad pydoc url)r ro )r ro )rb r re rJ r )r Z complete_urlr r opr_ r )r r r r r r r r 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 ra r r dirnamerealpathrV r! r readlinesrt )r r r r Z path_herer fpr ) r r r r r r r r r r _url_handler s* ( r T) open_browserc C s ddl }tt| }|jr&t|j dS |jrd}|r@|j|j zy^td|j t| xD|jrtd}|j }|dkr|P qZ|dkr|j|j qZt| qZW W n t t fk r t Y nX W d|jr|j 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) webbrowserr r r r r r r r r r r r )r r r Z serverthreadZserver_help_msgr r r r browse s2 r c C s t | to| jtjdkS )Nr )r r6 r r sep)rN r r r ispath s r c C s ddl } G dd dt}dtjkrXtjjtjd }|tjkrJtjj| tjjdd yp| j tjdd d\}}d }d }d }d}xP|D ]H\} } | d krd }d }| d krt | dS | d krd }| }| dkrd }qW |r|dkrd}t ||d dS |s|x|D ]} t | r4tjj | r4t d| P y`t | rVtjj| rVt| } |rt | r~tjj| r~t| nt| n tj| W n, tk r } zt | W Y dd} ~ X nX qW W nN | j|fk r tjjtjjtjd 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& r[ r r r r BadUsage s r r r r zbk:p:wFz-bTz-kz-pz-w)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} -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. The -p option can be used with the -b option to explicitly specify the server port. {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 )getoptrJ r r r r argvremoveinsertr r r existsr r{ r r r r r r r r r r r )r r Z scriptdirZoptsr ZwritingZ start_serverr r optvalargrH r r r r cli sd $ r r )NN)r )r )r r N)r r N)r )r N)r )r )XrU r3 rP rT rS rZ Zimportlib._bootstrapr Z importlib._bootstrap_externalimportlib.machineryimportlib.utilr r r r9 r r r r r Z urllib.parser4 r collectionsr reprlibr tracebackr r r r$ r) r- r/ r3 r IGNORECASEr4 r5 r: r? rC rO re rf rw r} r r rJ r r r r r r rq rr r r r r r r r r r r r r. r r r r r" r r r r r r r r r r r r% r r r r # s ' 0>* - d" , = n%V