Index of ModulesrQ zzBuilt-in Modulesr zf
pydoc by Ka-Ping Yee<ping@lfw.org>
zIndex of ModulesrQ ) r r r/ r r r r r r^ )r r r) namesr rY r r. s r
html_index _url_handler..html_index s = ,, =
#&":": (":$J& ": (##E5UT__ &3 3 4 88C OODJJs 1 2
' ( "2778#444(s
CCc >^ / m U 4S jn[ R " 5 [ R " S5 S n[ 5 R XUS9 SSS5 S n/ nT
R S5 nT H u pgUR
U" U5 U- 5 M! UT
R SU - S S
R U5 5 - nS U4$ ! , ( d f Nu= f) zSearch results page.c d > USS S:X a US S S- nTR X=( a SU- 45 g r^ r )r rq r
search_results r rA 3_url_handler..html_search..callback s; rs|{*!#2, 5 '+?D4K!@ Ar r c g r\ r! ra s r rD 2_url_handler..html_search..onerror s r rF Nc SU < SU < S3$ r r! r s r r 4_url_handler..html_search..bltinlink r r z-Search Resultszkey = %sr r zSearch Results) r r rc rH rI r r r r^ ) r rA rD r r r r) r r r r. s @r html_search!_url_handler..html_search s
B
$
$
& # #H -
O w ? ' = ,, ;
(JD NN9T?T1 2 (T__ gv{{7'; = = ))% '
&s 2C
Cc > S n TR S5 n[ [ R R 5 5 nTR X 5 nUTR
SSU5 - nSU4$ )z Index of topic texts available.c SU < SU < S3$ NzINDEXTopicsr )r r r6 r r r r )r r r r r. s r html_topics!_url_handler..html_topics
sl B ,, 2
v}}))+,##E5T__ gx ) )!!r c > TR S5 n [ [ R R 5 5 nS nTR X5 nU TR
SSU5 - nSU4$ )zIndex of keywords.r c SU < SU < S3$ r r! r s r r 6_url_handler..html_keywords..bltinlink
r r Keywordsr )r r r6 r r r r )r r r r r. s r
html_keywords#_url_handler..html_keywords
sl ,, 2
v++-. B ##E5T__ + +8##r c > [ R " 5 n[ X5 nUR U 5 u p4XR ; a SnOSnTR SU- 5 nSTR
U5 - nTR U SU5 nU( a@ [ UR 5 5 nS nTR XG5 nTR SSU5 nU< SU < 3S R XcU45 4$ )
zTopic or keyword help page.KEYWORDTOPICr z
%s
r c SU < SU < S3$ r r! r s r r 7_url_handler..html_topicpage..bltinlink8
s
:>EEr r( rB rQ )
rV rW r6 r6 r r r r r r# r r r^ ) r. bufhtmlhelpr r2 r r r r. s r html_topicpage$_url_handler..html_topicpage'
s kkm##",,U3 %% % EE,, /% 7
#T[[%::??57H= 5;;=)E
F $$U6ELL!8'5IE %(E235 5r c ~ > [ U SS9nUc U S:w a [ S5 e[ U5 nTR X5 nX#4$ )NrZ )r2 r8 zcould not find object)r ri r r? )r r? r contentr. s r html_getobj!_url_handler..html_getobj@
sE SA& ;3&= 45 5
--)~ r c > TR S5 nSR U4S j[ [ U5 U5 5 5 nUTR U SU5 - nSU - U4$ )Nz$Errorr c 3 F ># U H nTR U5 v M g 7fr\ )rv )r r r. s r r 3_url_handler..html_error..L
s% F D 6:t{{4 0 0 Ds !r z
Error - %s)r r^ r rI r )r r r r r. s r
html_error _url_handler..html_errorH
sf ,, 2
;; F 4T#Y D F FT__S'8 DDc!8++r c V > U nU R S5 ( a U SS n U S; a
T
" 5 u p#OU S:X a
T" 5 u p#OU S:X a
T " 5 u p#OuSU ; ad U R S5 u pEn US:X a T " U 5 u p#OJUS :X a T
" U 5 u p#O8US
:X a U S; a
T
" 5 u p#O" T " U 5 u p#O[ S 5 eT " U 5 u p# TR X#5 $ ! [ a
T " U 5 u p# N'f = f! [ a
T
" U 5 u p# NAf = f! [ a nT" X5 u p# SnAN^SnAff = f) z Generate an HTML page for url.r N)rQ r r r rw z
search?keyz topic?keyzget?keyz
bad pydoc url)r r9 ri r8 r )r complete_urlr r opr r r. r r r r r r r s r
get_html_page#_url_handler..get_html_pageQ
sc << cr(C ;m#!+ w !, w
"!. w ]]3 /
s %%0%5NE7;&:)7)<w 9_m+)3 wA-8-=NE7 %_55!,S!1w yy((% & :)4S)9w: * A-;C-@NE7A ; ' :NE7 ;sv D
D
D
*D
;D
C
D
$
C0 /D
C-*D
,C--D
0DD
DD
D(
D##D(rS rZ Nrh rQ ri zunknown content type z for url ) r r r r dirnamerealpathr r^ r readlinesrM )r rq r r path_herer fpr. r r r r r r r r s @@@@@@@@@r _url_handlerr s ?7 ?$ :DH650 *<"
$ 52 ,&) &)P ~~c!"gz!GGOOBGG$4$4X$>? 77<< /
(^r772<<>* ^ $ S!!
L#N
OO ^s + D55
ET localhost) open_browserr c SSK n[ [ X 5 nUR ( a [ UR 5 gUR
( a SnU( a UR
UR 5 [ SUR 5 [ U5 UR
( ab [ S5 nUR 5 nUS:X a O@US:X a UR
UR 5 O [ U5 UR
( a Mb UR
( a UR 5 [ S5 ggg! [ [ 4 a
[ 5 NKf = f! UR
( a UR 5 [ S5 f f = f) 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 rc zServer stopped)
webbrowserr r r r# r r r r r r r r )r r r r serverthreadserver_help_msgcmds r browser
s0 x>L
l !> OOL , , - ( #\%5%5 6 / " &&J'iik#:CZ OOL$4$45/* &&& ## !!#&' $' "8, G ## !!#&' $s1 2AD5 E >D5 5EE EE /Fc t [ U [ 5 =( a" U R [ R 5 S: $ r )r4 rJ r@ r sep)r s r ispathr
s% a 5!&&.A"55r c SU ; d- [ R U ; d [ R " 5 U ; a g[ R R [
5 n[ R R U5 nU R
5 nX0; a5 [ R R X25 ( d UR U5 UR S[ R " 5 5 U$ )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.
rQ Nr )
r curdirgetcwdr r r copysamefileremoveinsert)
given_pathargv0
stdlib_dir
script_dir revised_paths r _get_revised_pathr
s
Z299
2biikZ6O *J 'J ??$L (8(8(P(PJ'299;' r c [ [ R [ R S 5 n U b U [ R SS& gg)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 s r _adjust_cli_sys_pathr
s4
%SXXsxx{;L " r c SSK n " S S[ 5 n[ 5 U R [ R SS S5 u p#SnSnSnSnSnU H@ u pU S :X a S
nS
nU S :X a
[ U
5 gU S :X a S
nU
nU S
:X a S
nU S:X d M< S
nU
nMB U( a [
XxUS9 gU( d UeU GH n [ U 5 ( aH [ R R U 5 ( d$ [ SU - 5 [ R " S5 [ U 5 ( a/ [ R R U 5 ( a [ U 5 n U( aN [ U 5 ( a1 [ R R U 5 ( a
[! U 5 M [# U 5 M [$ R% U S
S9 GM g! [& [( 4 a- n [ U 5 [ R " S5 Sn A GMC Sn A ff = f! U R* U4 az [ R R- [ R R/ [ R S 5 5 S n
[ SR1 U
[ R2 S95 gf = f)z@Command-line interface (looks at sys.argv to decide what to do).r Nc \ rS rSrSrg)cli..BadUsagei
r! N)r/ r! r" r r r! r r BadUsager"
s tr r# rZ zbk:n:p:wFr z-bTz-kz-pz-wz-n)r r zfile %r does not exist)r' a 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 )getoptr8 r r r rG r r r r existsr# r r r- r r4 r/ r r1 r r r' r& rh r )r$ r# optsr> writing start_serverr r r optvalargr r s r clir,
s #9#M!]]388AB<<
HCd{ # # d{ d{ # d{ d{ # 4 F 8^Cc{{277>>##6#6.45
#;;277>>##6#6$S/C c{{rww}}S'9'9!#
IIc$I/ !23
e
LL( # !gg rww / / <=a@
: FsF ; ! !si AG< 2G< G< &A'G< BF<G< F< G< "F<6G< <G9 !G4-G< 4G99G< r> si %L (
)
$
+C C
0d
! A
* %G jj5r}}E (
" J 8 89 (2
2 %NK K&+$ ! (X@ @H( t ( TN 7c N 7d :t :@Oc Ob G 6* y O y > KLC6 DE !2# ^ ^@
x; ;z
< VriPX (4+ (J68#T!l zE r