zzBuilt-in Modulesr z|
pydoc by Ka-Ping Yee<ping@lfw.org>zIndex of ModulesrI ) rB r r rS rI r r
r rU )r rB namesr< r r r r r
html_index s"
z _url_handler..html_indexc s g fdd}t t d dd }t j|| |d W d n1 s)w Y dd }g }d
d d } D ]
\}}|||| q=|d
| d dd| }d|fS )zSearch results page.c s: |dd dkr|d d d } ||od| f d S r ry r
search_resultr r r} s z3_url_handler..html_search..callbackr c S r r r r r r r r r6 z2_url_handler..html_search..onerrorr Nc S r r r r r r r r r& z4_url_handler..html_search..bltinlinkz5Search Resultsr r zkey = %sr
zSearch Results) r r r r r rB r
rI rU ) rw r} r r r rB r' r$ r< r r r html_search s&
z!_url_handler..html_searchc sL dd } ddd}ttj } || }| ddd| }d|fS )z Index of topic texts available.c S r Nz %sr r r r r r
r& z4_url_handler..html_topics..bltinlink,INDEXr r Topicsr )rB r, r rY rt rS rI )r rB r r< r r r html_topics s z!_url_handler..html_topicsc sL ddd} ttj }dd } ||}| ddd| }d|fS )zIndex of keywords.r r r c S r r r r r r r r
r& z6_url_handler..html_keywords..bltinlinkKeywordsr )rB r, r rW rt rS rI )rB r r r< r r r
html_keywords
s z#_url_handler..html_keywordsc s t }t||}|| \}}| |jv rd}nd} d| dd}d | } | dd|}|rLt| }dd }
||} d
dd|}d || f d |||ffS )
zTopic or keyword help page.KEYWORDTOPICr} r r z
%s
r c S r r r r r r r r -
r& z7_url_handler..html_topicpage..bltinlinkrj z%s %srI )
rx r r rw rW rB rs rI r, r# rS rH rU )rp bufhtmlhelpr< ru r; rB r r r r html_topicpage
s,
z$_url_handler..html_topicpagec s@ t | dd}|d u r| dkrtdt|} || }||fS )NrQ )r r zcould not find object)r r r r )r] r; r; contentr r r html_getobj6
s z!_url_handler..html_getobjc sP ddd}d fddtt||D }| | dd| }d| |fS ) Nz,Errorr r r c 3 s | ]} |V qd S r )r$ r r r r r B
r z3_url_handler..html_error..z#bb0000z
Error - %s)rB rU r rC rI )r] r rB r< r r r
html_error>
s z _url_handler..html_errorc
s` | }| dr
| dd } z| dv r \}}nw| dkr" \}}nm| dkr, \}}ncd| v r| d\}}} |dkrC| \}}nL|d kr_z| \}}W n? ty^ | \}}Y n1w |d
kr| dv rm \}}n"z| \}}W n ty | \}}Y n w td | \}}W n ty } z
||\}}W Y d}~nd}~ww ||S ) z Generate an HTML page for url.r N)rI r rY rW r z
search?keyz topic?keyzget?keyz
bad pydoc url)r rx r r r= )r] complete_urlr; r opr r )r r r r r r r r r r
get_html_pageH
sH
z#_url_handler..get_html_pager rQ Nr rI r z"unknown content type %r for url %s) r8 r r r dirnamerealpathr rU r readlinesrF )r] r r r path_herer fpr ) r r r r r r r r r r _url_handler s,
(
"r T localhost) open_browserr c C s ddl }tt|| }|jrt|j dS |jr|d}|r!||j zMz.td|j t| |jrOtd}| }|dkr=n|dkrH||j nt| |js0W n t
t fy^ t Y nw W |jrm| td dS dS |jr{| td w w 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> rn rq zServer stopped)
webbrowserr r r r r r r] rH r
r^ rU r )r r r r serverthreadserver_help_msgr` r r r browse}
sD
r c C s t | to | tjdkS r )r rD r| r sep)r~ r r r ispath
s r c C sv d| v st j| v st | v rdS t jt}t j|}| }|| v r1t j||s1|| | 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.
rI Nr )
r curdirgetcwdr r r copysamefileremoveinsert)
given_pathargv0
stdlib_dir
script_dir revised_pathr r r _get_revised_path
s
r c C s0 t tjtjd } | dur| tjdd< dS 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_path
s r
c C s ddl } G dd dt}t z| tjdd d\}}d}d}d}d}d}|D ].\} }
| d kr5d
}d
}| d krAt|
W dS | d krId
}|
}| d
krOd
}| dkrWd
}|
}q)|rdt|||d W dS |sh||D ]W} t| rtj
| st d| W dS z+t| rtj | rt
| } |rt| rtj | rt| n
t| nt| W qj ty } z
t | W Y d} ~ qjd} ~ ww W dS | j|fy tj tj tjd d }
t dj|
tjd Y dS w )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
r r rQ zbk:n:p:wFr z-bTz-kz-pz-wz-n)r 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 r r r r r r r r r r r r )r r optsr writing start_serverr r r optvalargrx r` r r r cli
sl
r r r )r )r r N)rI N)r )`rA r r r r r importlib._bootstrapr importlib._bootstrap_externalimportlib.machineryimportlib.utilr rx r r rP rK r r r r r urllib.parser r collectionsr reprlibr tracebackr r r r( r@ r9 rH rO rW rY r_ rb ri rc
IGNORECASErj rl rn rs r r r r r r r r r r r r r r8 r r r5 r8 r7 r@ rF r? rk rU rN 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 *
3
'
0;* ; $ ,
=
n%
U