File: //proc/2/root/proc/2/task/2/root/proc/3/root/usr/lib/python2.4/pydoc.pyc
m
=5Dc @ s d Z d Z d Z d Z d Z d k Z d k Z d k Z d k Z d k Z d k
Z
d k Z d k l
Z
d k l Z l Z l Z l Z l Z l Z l Z l Z d k l Z d Z d
Z d Z d Z d
Z d Z d Z e i d e i! Z" d Z# d Z$ d Z% d Z& e' d Z( d Z) h d Z* d e+ f d YZ, d Z- d h d Z. d f d YZ/ d e
f d YZ0 d! e/ f d" YZ1 d# e
f d$ YZ2 d% e/ f d& YZ3 d' a4 d( Z5 d) Z6 d* Z7 d+ Z8 d, Z9 d- Z: d. Z; d d/ Z< e3 Z= e1 Z> d d0 Z? d1 d d2 Z@ d d3 ZA d4 e' d5 ZB d6 f d7 YZC eC e iD e iE ZF d8 f d9 YZG d: eG f d; YZH d< ZI e' e' d= ZJ d> ZK d? ZL d@ ZM eN dA j o eM n d S(B s Generate Python documentation in HTML or text for interactive use.
In the Python interpreter, do "from pydoc import help" to provide online
help. Calling help(thing) on a Python object documents the object.
Or, at the shell command line outside of Python:
Run "pydoc <name>" to show documentation on something. <name> may be
the name of a function, module, package, or a dotted reference to a
class or function within a module or module in a package. If the
argument contains a path segment delimiter (e.g. slash on Unix,
backslash on Windows) it is treated as the path to a Python source file.
Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
of all available modules.
Run "pydoc -p <port>" to start an HTTP server on a given port on the
local machine to generate documentation web pages.
Run "pydoc -w <name>" to write out the HTML documentation for a module
to a file named "<name>.html".
Module docs for core modules are assumed to be in
http://www.python.org/doc/current/lib/
This can be overridden by setting the PYTHONDOCS environment variable
to a different URL or to a local directory containing the Library
Reference Manual pages.
s Ka-Ping Yee <ping@lfw.org>s 26 February 2001s $Revision: 43347 $s Guido van Rossum, for an excellent programming language.
Tommy Burnette, the original creator of manpy.
Paul Prescod, for all his work on onlinehelp.
Richard Chamberlain, for the first implementation of textdoc.
N( s Repr( s
expandtabss finds joins lowers splits strips rfinds rstrip( s dequec C s g } g } xz t i D]o } t i i | p d } t i i | } | | j o1 t i i | o | i
| | i
| q q W| S( sA Convert sys.path into a list of absolute, existing, unique paths.t .N( t dirst normdirst syst patht dirt ost abspatht normcaset normdirt isdirt append( R R R R ( ( t /usr/lib/python2.4/pydoc.pyt pathdirs: s
c C sF t i | p
t i | } | o t i d d t | p d S( s- Get the doc string or comments for an object.s ^ *
t N( t inspectt getdoct objectt getcommentst resultt ret subt rstrip( R R ( ( R R F s c C s t t | d } t | d j o | d d f SnE t | d j o1 t | d o | d t | d d f Sn d t | d f S( s> Split a doc string into a synopsis line (if any) and the rest.s
i i R i N( t splitt stript doct linest lenR t join( R R ( ( R t splitdocK s % c C s2 | i } | i | j o | i d | } n | S( s@ Get a class name and qualify it with a module name if necessary.R N( R t __name__t namet
__module__t modname( R R! R ( ( R t classnameT s
c C s^ t i | pM t i | p= t i | p- t i | p t i | p
t i | S( s> Check if an object is of a type that probably means it's data.N( R t ismoduleR t isclasst isroutinet isframet istracebackt iscode( R ( ( R t isdata[ s c G s= x6 | o. t t | | d | d } | d } q W| S( s/ Do a series of global replacements on a string.i i i N( t pairsR R t text( R+ R* ( ( R t replacea s c C sg t | | j oP t d | d d } t d | d | } | | d | t | | Sn | S( sC Omit part of a string if needed to make it fit in a maximum length.i i i s ...N( R R+ t maxlent maxt pret post( R+ R- R/ R0 ( ( R t cramh s "s at 0x[0-9a-f]{6,16}(>+)$c C s. t i t t o t i d | Sn | S( s> Remove the hexadecimal id from a Python object representation.s \1N( t _re_stripidt searcht reprt ExceptionR R+ ( R+ ( ( R t stripidq s c C s t i | p
t i | S( N( R t ismethodt objt ismethoddescriptor( R8 ( ( R t _is_some_methodx s c C s h } x* t i | t D] \ } } d | | <q Wx$ | i D] } | i t
| q= Wx' | i D] } t | | | | <qg W| S( Ni (
t methodsR t
getmemberst clR: t keyt valuet __bases__t baset updatet
allmethodst keyst getattr( R= R; R? RA R> ( ( R RC { s
c C sR g } g } x9 | D]1 } | | o | i | q | i | q W| | f S( s Split sequence s via predicate, and return pair ([true], [false]).
The return value is a 2-tuple of lists,
([x for x in s if predicate(x)],
[x for x in s if not predicate(x)])
N( t yest not st xt predicateR ( RH RJ RI RF RG ( ( R t _split_list s
c C s| | d d d d d d g j o d Sn | i d o | i d o d Sn | d j o | | j Sn | i d
Sd S( s3 Decide whether to show documentation on a variable.t __builtins__t __doc__t __file__t __path__R R i t __i t _N( R t
startswitht endswitht allt None( R RT ( ( R t visiblename s
c C sc t i i | oL xI d d d g D]4 } t i i t i i | d | o t Sq# q# Wn t S( s3 Guess whether a path refers to a package directory.s .pys .pycs .pyot __init__N( R R R
t extt isfileR t Truet False( R RX ( ( R t ispackage s &c C s t i | i } | i | d \ } } | | j ot
i | } y t
| } Wn t j
o d Sn X| oj d | d j oY y t i d | | | d } Wn d Sn Xt | i p d d d } t i d =n| i } x< | d d j p t | o | i } | p Pq q Wt | } | d d
j o | d } n | d d j os | d } | d
d j o | d
} n x* t | p | i } | p PqqWt t | d d } n d } | i | | f | | <n | S( s. Get the one-line summary out of a module file.i t bi t __temp__i R s
t #i s r"""i s """is \N( i N( R t statt filenamet st_mtimet mtimet cachet getRU t
lastupdateR R t
getmoduleinfot infot opent filet IOErrort impt load_modulet moduleR RM R t modulest readlinet lineR t close( Ra Rd Rh Rf Rn R Rj Rc Rq ( ( R t synopsis sN
t ErrorDuringImportc B s t Z d Z d Z d Z RS( sE Errors that occurred while trying to import something to document it.c C s7 | \ } } } | | _ | | _ | | _ | | _ d S( N( t excR? t tbRa t self( Rw Ra t .4Ru R? Rv ( ( R RW s c C sC | i } t | t i j o
| i } n d | i | | i f S( Ns problem in %s - %s: %s( Rw Ru t typet typest ClassTypeR Ra R? ( Rw Ru ( ( R t __str__ s
( R R RM RW R| ( ( ( R Rt s c C s t i } t | d } | i t | | j o
t i } n
t i
} | i t i i
| } t i i | \ } } t | d } y% t i | | | | d | f } Wn t | t i n X| i | S( s< Import a Python source file or compiled file given its path.t rN( Rl t get_magict magicRi R Rj t readR t PY_COMPILEDt kindt PY_SOURCERr R t basenameRa t splitextR RX Rm Rn Rt R t exc_info( R R R R Ra RX Rn Rj ( ( R t
importfile s
%
i c
C s y | o | t i j o | t i j os g } t i D]% }
|
i | d o | |
q8 q8 ~ } x4 | g | D]! } t i | | | <t i | =qt Wq n t | } Wn t i
\ } } } } | t i j o t t i | i | qt| t j o t | i | qt| t j o1 t t t | d d d g j o d Sqtt | t i
n XxH t | d d D]3 } y t | | } Wqt j
o d SqXqW| S( s Import a module; handle errors; return None if the module isn't found.
If the module *is* found but an exception occurs, it's wrapped in an
ErrorDuringImport exception and reraised. Unlike __import__, if a
package path is specified, the module at the end of the path is returned,
not the package at the beginning. If the optional 'forceload' argument
is 1, we reload the module from disk (unless it's a dynamic extension).R i RG Rn i N( t forceloadR R Ro t builtin_module_namest _[1]t mRR t subsR> Rd t
__import__Rn R Ru R? Rv Rh Rt RN t SyntaxErrorRa t ImportErrorR t lowert strRU t partRE t AttributeError(
R R Rd R Rn Rv R R> Rh Ru R R? R ( ( R t
safeimport s4 <
6
t Docc B s; t Z d d Z d d Z e Z Z Z Z d Z RS( Nc G s | | f | } yg t i | o | i | Sn t i | o | i | Sn t i | o | i
| Sn Wn t j
o n Xt | t
o | i | Sn | i | S( s% Generate documentation for an object.N( R R t argsR R# Rw t docmoduleR$ t docclassR% t
docroutineR t
isinstancet propertyt docpropertyt docother( Rw R R R ( ( R t document$ s c G s7 d | o d t | t | i f } t | d S( s+ Raise an exception for unimplemented types.s. don't know how to document object%s of type %st N( R R4 Ry R R t messaget TypeError( Rw R R R R ( ( R t fail4 s *c C s y t i | } Wn t j
o
d } n Xt i i d d } t i i
t i d d t i
d d ! } t | t t o | i d j p0 | i | os | i t i i
| d oS d | i } | i d o d | i d | f } q t i i
| | } n d } | S( s* Return the location of module docs or Nones
(built-in)t
PYTHONDOCSs% http://www.python.org/doc/current/libt libt pythoni i t errnot
exceptionst gcRl t marshalt posixt signalR t threadt zipimports
site-packagess module-%s.htmls http://s %s/%st /N(
s errnos
exceptionsR s imps marshals posixs signals sysR s zipimport( R t
getabsfileR Rj R R t environRe t doclocR R R t exec_prefixt versiont basedirR Ry R RR t htmlfileR RU ( Rw R R R Rj R ( ( R t getdocloc< s V
(
R R RU R R R R R R R ( ( ( R R # s t HTMLReprc B sP t Z d Z d Z d Z d Z d Z d Z e Z d Z e Z
RS( sB Class for safely making an HTML representation of a Python object.c C s: t i | d | _ | _ d | _ d | _ | _ d S( Ni i
id ( t ReprRW Rw t maxlistt maxtuplet maxdictt maxstringt maxother( Rw ( ( R RW [ s
c C s t | d d d d d d S( Nt &s &t <s <t >s >( R, R+ ( Rw R+ ( ( R t escapea s c C s t i | | S( N( R R4 Rw R ( Rw R ( ( R R4 d s c C s t t | d oP d t t t | i d } t | | o t | | | | Sqf n | i
t t t
| | i S( NR t repr_RQ ( t hasattrRy RI R R R t
methodnameRw RE t levelR R1 R6 R4 R ( Rw RI R R ( ( R t repr1g s
" c C s t | | i } t | } d | j o> d t | d d j o% d | d | i | | d Sn t i
d d | i | S( Ns \s \\R R} i s- ((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)s <font color="#c040c0">\1</font>( R1 RI Rw R t testR4 t testreprR, R R R ( Rw RI R R R ( ( R t repr_stringn s &% c C sN y) | i t t t | | i SWn | i d | i i Sn Xd S( Ns
<%s instance>( Rw R R1 R6 R4 RI R t __class__R ( Rw RI R ( ( R t
repr_instance{ s )( R R RM RW R R4 R R t repr_strR t repr_unicode( ( ( R R Y s t HTMLDocc B s= t Z d Z e Z e i Z e i Z d Z d d Z d d e d d Z
d Z d Z d d
Z
d Z d Z d
Z d Z d Z e h h h d Z e d Z e e d Z e e h h d Z d Z e e h h h e d Z d Z e e e d Z e e d Z e d Z RS( s' Formatter class for HTML documentation.c C s d | | f S( s Format an HTML page.s
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: %s</title>
</head><body bgcolor="#f0f0f8">
%s
</body></html>N( t titlet contents( Rw R R ( ( R t page s R c C s d | | | | | p d f S( s Format a page heading.s'
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="%s">
<td valign=bottom> <br>
<font color="%s" face="helvetica, arial"> <br>%s</font></td
><td align=right valign=bottom
><font color="%s" face="helvetica, arial">%s</font></td></tr></table>
s N( t bgcolt fgcolR t extras( Rw R R R R ( ( R t heading s i s c
C s~ | d j o d d | d } n d | | | f } | o | d | | | | f } n | d | | | f } | d | S( s Format a section with a heading.s <tt>s s </tt>s <p>
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="%s">
<td colspan=3 valign=bottom> <br>
<font color="%s" face="helvetica, arial">%s</font></td></tr>
sR
<tr bgcolor="%s"><td rowspan=2>%s</td>
<td colspan=2>%s</td></tr>
<tr><td>%s</td>s(
<tr><td bgcolor="%s">%s</td><td>%s</td>s'
<td width="100%%">%s</td></tr></table>N(
t
marginaliaRU t widthR R R R t preludet gapR (
Rw R R R R R R R R R ( ( R t section s
c G s d | } | i | | S( s$ Format a section with a big heading.s <big><strong>%s</strong></big>N( R Rw R R ( Rw R R ( ( R t
bigsection s
c
C s7 | i t | } t | d d d d d d d d S( s! Format literal preformatted text.s
s
R s s
s <br>
N( Rw R t
expandtabsR+ R, ( Rw R+ ( ( R t preformat s i c C s d } t | | d | } x t | D]w } | d d | } xR t | | | | | D]5 } | t | j o | | | | d } q_ q_ W| d } q+ Wd | S( s0 Format a list of items into a multi-column list.R i s <td width="%d%%" valign=top>id s <br>
s </td>s7 <table width="100%%" summary="list"><tr>%s</tr></table>N( R R t listt colst rowst ranget colt it format( Rw R R R R R R R ( ( R t multicolumn s
c C s d | S( Ns <font color="#909090">%s</font>( R+ ( Rw R+ ( ( R t grey s c G s8 x1 | D]) } | | j o d | | | f Sq q W| S( s: Make a link for an identifier, given name-to-URL mappings.s <a href="%s">%s</a>N( t dictst dictR ( Rw R R R ( ( R t namelink s
c C ss | i t i i | i } } t | | o7 t | | | j o! d | i | t
| | f Sn t
| | S( s Make a link for a class.s <a href="%s.html#%s">%s</a>N( R R R Ro Re R R Rn R RE R" R! ( Rw R R! R Rn ( ( R t classlink s
&!c C s d | i | i f S( s Make a link for a module.s <a href="%s.html">%s</a>N( R R ( Rw R ( ( R t
modulelink s c C sx | \ } } } } | o | i | Sn | o d | | f } n d | } | o d | } n | } d | | f S( s; Make a link for a module or package to display in an index.s
%s.%s.htmls %s.htmls" <strong>%s</strong> (package)s <a href="%s">%s</a>N( R R R\ t shadowedRw R t urlR+ ( Rw t .2R R R\ R R R+ ( ( R t
modpkglink s
c C s | p | i } g } d } t i d } xt o| i | | }
|
p Pn |
i \ } } | i | | | | ! |
i \ } } } }
} } | o3 | | i d d } | i d | | f n | o1 d t | } | i d | | | f n |
o1 d t |
} | i d | | | f nq | | | d !d j o# | i | i | | | | n6 | o | i d
| n | i | i | | | } q. W| i | | | t | d S(
s Mark up some plain text, given a context of symbols to look for.
Each context dictionary maps object names to anchor names.i sD \b((http|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?(\w+))t "s "s <a href="%s">%s</a>s' http://www.rfc-editor.org/rfc/rfc%d.txts( http://www.python.org/peps/pep-%04d.htmli t (s self.<strong>%s</strong>R N( R Rw t resultst hereR t compilet patternRZ R3 R+ t matcht spant startt endR t groupsRT t schemet rfct pept selfdotR R, R t intR R; t funcst classesR ( Rw R+ R R R R; RT R R R R R R R R R R R R ( ( R t markup s< !!# c
C s d } x| D] } t | t f j o | \ } } | d } | | i | | } | o_ | | f j oO g } x' | D] } | i | i | | q| W| d t
| d d } n | d } q
t | t g j o! | d | i | | | } q
q
Wd | S(
sA Produce HTML for a class tree as given by inspect.getclasstree().R s" <dt><font face="helvetica, arial">R s , t )s
</font></dt>s
<dd>
%s</dd>
s
<dl>
%s</dl>
N( R t treet entryRy t ct basesRw R R! t parentt parentsRA R R t
formattree(
Rw R R! R R R R R RA R ( ( R R
s$
%c $ G sy | i } y
| i } Wn t j
o
d } n Xt | d } g } xJ t
t | d D]2 } | i
d t | | d d | | f q^ Wt | | d d } d | }
yU t i | } | }" t i d j o d k } | i | }" n d |" | f } Wn t j
o
d } n Xg } t | d
oj t | i } | d d d
j o( | d d j o t | d d ! } n | i
d | i" | n t | d o# | i
| i" t | i# n | o |
d t | d }
n | i$ | }! |! d j o d t& }! n d }! | i' |
d d d | |! }
t i) | t i* } g h }# } x t i) | t i. D]w \ } } | d j p t i1 | p | | j oA t2 | | o- |# i
| | f d | | | <| | <qqqWx |# D] \ } } x | i3 D] } | i | i5 } } t i+ i7 | } | | j o` | oY t | | oI t9 | | | j o/ | | j o | d | | | <| | <qqq q WqWg h } } x t i) | t i< D] \ } } | d j p& t i= | p t i1 | | j o[ t2 | | oG | i
| | f d | | | <t i> | o | | | | <qwq{qqWg } xG t i) | t@ D]3 \ } } t2 | | o | i
| | f qqW| iA tB | | iC | | } | o d | } |
d | }
t | d og } g } x tG iH | iI d D] } tG i i | iI d | } t iK | } | d j ol | o7 | | j o* | i
| | d d f | i
| qtL | o | i
| | d d f qqBqBW| iM | iN | | iO } |
| iQ d d d | }
n@ | o8 | iN | | d! } |
| iQ d" d# d | }
n |# o tR d$ |# } | iT t iU | d | g } x6 |# D]. \ } } | i
| iV | | | | | qW|
| iQ d% d d& t | }
n | oe g } x6 | D]. \ } } | i
| iV | | | | | qW|
| iQ d' d d( t | }
n | o_ g } x- | D]% \ } } | i
| iV | | qW|
| iQ d) d d* t | d+ }
n t | d, o> | iA t | iW | iC } |
| iQ d- d d | }
n t | d. o> | iA t | iX | iC } |
| iQ d/ d d | }
n |
S(0 s/ Produce HTML documentation for a module object.R i s5 <a href="%s.html"><font color="#ffffff">%s</font></a>is) <big><big><strong>%s</strong></big></big>t win32Ns <a href="file:%s">%s</a>s
(built-in)t __version__i t $s
Revision: s
version %st __date__s (%s)s , s( <br><a href="%(docloc)s">Module Docs</a>R s #ffffffs #7799ees <a href=".">index</a><br>R_ s .html#s #-s <tt>%s</tt>s
<p>%s</p>
RO i RW s Package Contentss #aa55ccc C s | \ } } | i | S( N( R> R? RH R ( t .0RH R> R? ( ( R t <lambda> s t Moduless #fffffc C s | \ } } | S( N( R> R? ( R R> R? ( ( R R s t Classess #ee77aat Functionss #eeaa77t Datas #55aa55s <br>
t
__author__t Authort __credits__t Credits(Y R R R t __all__RT R RU R t partst linksR R R R R t
linkednamet headR R R R R t platformt
nturl2patht pathname2urlt filelinkR Rh R R R R R Rw R R R R t localsR R R< R# Ro R t cdictR$ R> R? t getmoduleRV R@ RA R R! Re Rn RE R t fdictR% t isbuiltint
isfunctiont dataR) R R R R t modpkgst modnamesR t listdirRO Rj t
getmodulenameR\ t sortR R R R t mapt classlistR
t getclasstreeR R R ($ Rw R R t modt ignoredR> RT R R R/ R Rn R* R Rj R) R R! R R R RA R? R R% R R( Rh R! R R R# Ro R R R ( ( R R ) s
0
& #
*"
$
.
3 !
%
! && && ) c s i } | p | } i }
g } | i d f d Y} | t t i
} t | d j oP i d x+ | D]# } d i | i q W d n d } d } d } t d
t i } h xg | D]_ \ } } } } d | d | | <} t! | } y | | <WqDt" j
o qDXqDWxM| oE| o | i# n | d
d t% | d \ } } t' i j o
| } qn1 j o
d } n d i i } | d 7} | i) d d | d | | d } | d | | d } | d | | d } | d | | d } | d | | d } | g j p t* | } qWd i+ | } | | j o d | | f } n d | | | f } |
oN g } x* |
D]" } | i i | i qNW| d! t+ | d" } n i. t/ i0 } | o d# | } i4 | d$ d% | d& | S(( s. Produce HTML documentation for a class object.t HorizontalRulec s t Z d Z d Z RS( Nc C s
d | _ d S( Ni ( Rw t needone( Rw ( ( R RW s c s% | i o d n d | _ d S( Ns <hr>
i ( Rw R4 t push( Rw ( R5 ( R t maybe s
( R R RW R6 ( ( R5 ( R R3 s i s& <dl><dt>Method resolution order:</dt>
s <dd>%s</dd>
s </dl>
c
s t | | \ } } | om i | xV | D]J \ } } } } i
t | | d q7 Wn | S( Ns
( RK t attrsRJ t okt hrR6 R5 t msgR R t homeclsR? Rw R RE R R1 R R t mdict( R: R7 RJ R8 R R R? R; ( R R< R9 Rw R R5 R R1 ( R t spill s
c sn t | | \ } } | oN i | x7 | D]+ \ } } } } i
| | q7 Wn | S( N( RK R7 RJ R8 R9 R6 R5 R: R R R; R? Rw t _docpropertyR1 ( R: R7 RJ R8 R R R? R; ( R9 Rw R5 R1 ( R t spillproperties s
!c
s t | | \ } } | o i | x | D] \ } } } } i
t | | } t | p t i | o t | d d } n d } | d j o d | nC i t | i } d | } d | | f d q7 Wn | S( NRM s <dl><dt>%s</dl>
s <dd><tt>%s</tt>s <dl><dt>%s%s</dl>
s
( RK R7 RJ R8 R9 R6 R5 R: R R R; R? Rw R RE R R1 RA t callableR t isdatadescriptorRU R R R R R R R< (
R: R7 RJ RA R; R R8 R R R? ( R R< Rw R R9 R1 R R5 ( R t spilldata s$
c C s | \ } } } } t | S( N( R R t clsR? RV ( R R R RC R? ( ( R R s R_ t -i c s | d j S( Ni ( t tt thisclass( RE ( RF ( R R s s defined heres inherited from %ss :<br>
R> c C s | d S( Ni ( RE ( RE ( ( R R s s
Methods %sc C s | d d j S( Ni t method( RE ( RE ( ( R R s s Class methods %sc C s | d d j S( Ni s class method( RE ( RE ( ( R R s s Static methods %sc C s | d d j S( Ni s
static method( RE ( RE ( ( R R s s
Properties %sc C s | d d j S( Ni R ( RE ( RE ( ( R R s s Data and other attributes %sc C s | d d j S( Ni R( ( RE ( RE ( ( R R s R s* <a name="%s">class <strong>%s</strong></a>s/ <strong>%s</strong> = <a name="%s">class %s</a>s (%s)s , s <tt>%s<br> </tt>s #000000s #ffc8d8i N(5 R R t realnameR R@ R R R R5 R3 R9 t dequeR t getmrot mroR R6 RA Rw R R R= R? RB t filtert classify_class_attrsR7 R< R> R R; R? t anchorRE R t popleftRF RK t inheritedt __builtin__t tagR- t AssertionErrorR R R R R R R R R R ( Rw R R R1 R R R2 RR R7 R< RF R R R R3 RP R R? RH R9 RA R> RK R R; R= R RB R? R5 RN ( ( Rw R R1 R R R9 R5 R< RF R R s
! !
$c C s | i d | i | S( s) Format an argument default value as text.t =N( Rw R R4 R ( Rw R ( ( R t formatvalue5 s c C s] | i } | p | } | o
| i p d d | } d } d } t i | o | i
} | o+ | | j o d | i
| | } q nA | i o d | i
| i i | } n d | i
| | } | i } n | | j o d | | f }
nj | oI | | i j o9 | i | | j o% d | i d | | f } d } n | } d
| | | f }
t i | oh t i | \ }
} } } t i |
| | | d | i } | d j o d
| }
| d d !} qn d } |
| | o | i d | } | o d | SnD | i t! | | i" | | | } | o d | } d | | f Sd S( s; Produce HTML documentation for a function or method object.R RD i s from s method of %s instances unbound %s methods$ <a name="%s"><strong>%s</strong></a>s <a href="#%s">%s</a>i s) <a name="%s"><strong>%s</strong></a> = %sRU s <lambda>s$ <strong>%s</strong> <em>lambda</em> is (...)s' <font face="helvetica, arial">%s</font>s <dl><dt>%s</dt></dl>
s <dd><tt>%s</tt></dd>s <dl><dt>%s</dt>%s</dl>
N(' R R RH R R= RN t notet skipdocsR R7 t im_classt imclassRw R R1 t im_selfR t im_funcR t __dict__t reallinkR' t
getargspecR t varargst varkwt defaultst
formatargspecRU t argspecR t declR R R R R R; R ( Rw R R R1 R R R; R= Rd RW R RV R` R RH R_ R] RY Rc Ra R RN ( ( R R 9 sF
+
!
" $c C s g } | i } | o | d | n | i d j o- | i t | | i
} | d | n x` d d
d g D]O \ } } t | | } | d j o' | i | | | }
| d |
qu qu W| d
d i | S( Ns! <dl><dt><strong>%s</strong></dt>
s <dd><tt>%s</tt></dd>
t fgets <em>get</em>t fsets <em>set</em>t fdels <em>delete</em>s <dd>%s</dd>
s </dl>
R ( Re s <em>get</em>( Rf s <em>set</em>( Rg s <em>delete</em>( R R R5 R R? RM RU Rw R R R R t attrRR RE t funcR R1 RA R ( Rw R R? R1 R R RR Ri Rh R5 RA ( ( R R> o s
c C s | i | | | S( s* Produce html documentation for a property.N( Rw R> R R R1 ( Rw R R R1 R= ( ( R R s c G s) | o d | p d } | | i | S( s- Produce HTML documentation for a data object.s <strong>%s</strong> = R N( R t lhsRw R4 R ( Rw R R R1 R2 Rj ( ( R R s c C s! g } | d j o
h } n h } t i | } | | | d } xA | D]9 } t i
i | | }
t |
o | | d qK qK Wxa | D]Y } t i
i | | }
t i
i
|
o+ t i | } | o | | d q q q W| i | i | | i } | i | d d | S( s2 Generate an HTML index for a directory of modules.c C sH | | j o7 | i | d | | | j f d | | <d | | <n d S( NR i ( R t seenR) R R\ R ( R R\ R) R Rk ( ( R t found s
i i s #ffffffs #ee77aaN( R) R RU Rk R R+ R t filesRl Rj R R R\ RY R R, R! R- Rw R R R R ( Rw R R Rm R R) R! Rj Rl Rk R ( ( R t index s,
( R R RM R t _repr_instanceR4 R R R RU R R R R R R R R R R R
R R RU R R> R R Rn ( ( ( R R s2 & 6 t TextReprc B s8 t Z d Z d Z d Z d Z e Z d Z RS( sA Class for safely making a text representation of a Python object.c C s: t i | d | _ | _ d | _ d | _ | _ d S( Ni i
id ( R RW Rw R R R R R ( Rw ( ( R RW s
c C s t t | d oP d t t t | i d } t | | o t | | | | Sqf n t
t t | | i
S( NR R RQ ( R Ry RI R R R R Rw RE R R1 R6 R4 R ( Rw RI R R ( ( R R s
" c C sd t | | i } t | } d | j o5 d t | d d j o d | d | | d Sn | S( Ns \s \\R R} i ( R1 RI Rw R R R4 R R, ( Rw RI R R R ( ( R R s
& c C s< y t t t | | i SWn d | i i Sn Xd S( Ns
<%s instance>( R1 R6 R4 RI Rw R R R ( Rw RI R ( ( R R s ( R R RM RW R R R R ( ( ( R Rp s t TextDocc B s t Z d Z e Z e i Z d Z d d Z d Z e d d Z
e e d Z e e d Z d Z
e e e d
Z d Z e e e d Z e e e e e d
Z RS( s' Formatter class for text documentation.c C s t t d | d S( s( Format a string in bold by overstriking.c C s | d | S( Ns ( t ch( Rr ( ( R R s R N( R R. R+ ( Rw R+ ( ( R t bold s s c C s_ | p d Sn t | d } t | d | } | o t | d | d <n t | d S( s6 Indent text by prepending a given prefix to each line.R s
c C s | | S( N( t prefixRq ( Rq Rt ( ( R R s iN( R+ R R R. Rt R R ( Rw R+ Rt R ( ( R t indent s c C s( | i | d t | i | d S( s& Format a section with a given heading.s
s
N( Rw Rs R R Ru R ( Rw R R ( ( R R s R c
C s d } x | D] } t | t f j ox | \ } } | | t | | } | o@ | | f j o0 t
| d | } | d t | d } n | d } q
t | t g j o$ | | i | | | | d } q
q
W| S( sB Render in text a class tree as returned by inspect.getclasstree().R c C s
t | | S( N( R" R R ( R R ( ( R R s s (%s)s , s
s N( R R R Ry R R Rt R" R! R R. R R Rw R
(
Rw R R! R Rt R R R R R ( ( R R
s (c C s | i } t t | \ } }
| i d | | o d | } y
| i
} Wn t j
o
d } n Xy t i | } Wn t j
o
d } n X| | i d | } | i | } | d j o | | i d | } n |
o | | i d |
} n g } xx t i | t i D]a \ } } | d j p t i | p | | j o+ t | | o | i | | f qq#q#Wg } x t i | t i D]j \ } } | d j p& t i | p t i | | j o+ t | | o | i | | f qqqWg } xG t i | t D]3 \ } } t | | o | i | | f q+q+Wt! | d o g }
x t# i$ | i% d D] } t# i& i' | i% d | } t i( | } | d j oK | o | |
j o |
i | qt* | o |
i | d
qqqW|
i+ | | i d t' |
d } n | o t, d
| } | i. t i/ | d | g } x0 | D]( \ } } | i | i1 | | | qW| | i d t' | d } n | o\ g } x0 | D]( \ } } | i | i1 | | | qW| | i d t' | d } n | ob g } x6 | D]. \ } } | i | i2 | | | d d qPW| | i d t' | d } n t! | d of t3 | i4 } | d d d j o( | d d j o t6 | d d ! } n | | i d | } n t! | d o# | | i d t3 | i7 } n t! | d o# | | i d t3 | i8 } n t! | d o# | | i d t3 | i9 } n | S(! s5 Produce text documentation for a given module object.t NAMEs - s
(built-in)t FILEs MODULE DOCSt DESCRIPTIONRO i RW s
(package)s PACKAGE CONTENTSs
c C s | \ } } | S( N( R> R? ( R R> R? ( ( R R . s i t CLASSESt FUNCTIONSR- iF t DATAR i R
s
Revision: it VERSIONR t DATER t AUTHORR t CREDITSN(: R R R R R t synopt descRw R R R RT R RU R R Rj R R R R R< R$ R> R? R$ RV R R R% R& R( R) R R) R R+ RO R R R, R! R\ R- R. R/ R
R0 R R R R R R R R R R ( Rw R R R1 R RT R/ R Rj R R) R R R R> R R( R! R? R R ( ( R R s !
* 3
#! # # &#&###c s< i } | p | } i } i d } | | j o d i | } n i | d | } | o* t | | }
| d t
|
d } n t } | o | d g p g } | i t t i } t | d j o= d x" | D] } d | | qW d
n d f d Y} | d
} d }
d } t d t i } xG| o?| o | i! n | d d t# | d \ } } t% i j o
| } qn. j o
d } n d t' i } t d | | i( | d | | d } | d | | d } | d | | d } |
d | | d } | d | | d } | g j p t) | } qWd i
| } | p | d Sn | d i* t+ | d d S(" s4 Produce text documentation for a given class object.c C s
t | | S( N( R" R R ( R R ( ( R t makenameT s s class s = class s (%s)s , s
i s Method resolution order:s R R3 c s t Z d Z d Z RS( Nc C s
d | _ d S( Ni ( Rw R4 ( Rw ( ( R RW m s c s) | i o d d n d | _ d S( NRD iF i ( Rw R4 R5 ( Rw ( R5 ( R R6 o s
( R R RW R6 ( ( R5 ( R R3 l s c sz t | | \ } } | oZ i | xC | D]7 \ } } } } i
t | | q7 Wn | S( N( RK R7 RJ R8 R9 R6 R5 R: R R R; R? Rw R RE R R1 ( R: R7 RJ R8 R R R? R; ( R9 Rw R R5 R1 ( R R= u s
c sn t | | \ } } | oN i | x7 | D]+ \ } } } } i
| | q7 Wn | S( N( RK R7 RJ R8 R9 R6 R5 R: R R R; R? Rw R> R1 ( R: R7 RJ R8 R R R? R; ( R9 Rw R5 R1 ( R R? s
!c
s t | | \ } } | o i | x | D]w \ } } } } t | p t
i | o t | } n d } i t | | d d d | d q7 Wn | S( NR- iF R s
( RK R7 RJ R8 R9 R6 R5 R: R R R; R? R@ R RA R R RU Rw R RE R R1 ( R: R7 RJ R8 R R R R? R; ( R R9 Rw R5 R1 ( R RB s
%c C s | \ } } } } t | S( N( R R RC R? RV ( R R R RC R? ( ( R R s i c s | d j S( Ni ( RE RF ( RE ( RF ( R R s s defined heres inherited from %sc C s | d i d S( Ni RQ ( RE RR ( RE ( ( R R s s Methods %s:
c C s | d d j S( Ni RG ( RE ( RE ( ( R R s s Class methods %s:
c C s | d d j S( Ni s class method( RE ( RE ( ( R R s s Static methods %s:
c C s | d d j S( Ni s
static method( RE ( RE ( ( R R s s Properties %s:
c C s | d d j S( Ni R ( RE ( RE ( ( R R s s Data and other attributes %s:
c C s | d d j S( Ni R( ( RE ( RE ( ( R R s s | N(, R R RH R R@ R R R Rw Rs R R. R R R R R R R5 RI R RJ RK R RA R3 R9 R= R? RB RL RM R7 RO RF RK RP RQ RR R" R- RS Ru R ( Rw R R R1 RR R7 RF R R R R RP R3 R? RH R9 RA R R= R RB RK R5 ( ( Rw R R1 R9 R5 RF R R N sv
c C s d | i | S( s) Format an argument default value as text.RT N( Rw R4 R ( Rw R ( ( R RU s c C s | i } | p | } d } d } t i | o | i }
| o( |
| j o d t |
| } q n; | i
o d t | i
i | } n d t |
| } | i } n | | j o | i | } nM | o. | | i j o | i | | j o
d } n | i | d | } t i | oq t i | \ } }
} } t i | |
| | d | i } | d j o$ | i | d
} | d d !} qn d } | | | } | o | d
Sn: t | p d } | d
| o t | i! | d
Sd S( s; Produce text documentation for a function or method object.R i s from s method of %s instances unbound %s methodi s = RU s <lambda>s lambda is (...)s
N(" R R RH R RV RW R R7 RX RY R= R" R1 RZ R R[ Rw Rs R R\ R' R^ R R_ R` Ra Rb RU Rc Rd R R R Ru ( Rw R R R1 R= Rd R RW R RV RY Rc Ra R_ R R` RH ( ( R R s>
+
!
c C s g } | i }
| o |
| n d } t | p d } | o |
| i | d } n x d d d
g D]o \ } } t | | } | d j oG | o |
d d } n | i | | | } |
| i | qq qq Wd
i | S( Ni R i Re s <get>Rf s <set>Rg s <delete>s
( s fgets <get>( s fsets <set>( s fdels <delete>( R R R5 R t need_blank_after_docR R? R Rw Ru Rh RR RE Ri RU R R1 RA R ( Rw R R? R1 R R R RR Ri Rh R5 RA ( ( R R> s&
c C s | i | | | S( s* Produce text documentation for a property.N( Rw R> R R R1 ( Rw R R R1 R= ( ( R R s c
C s | i | } | oO | o | d p d | } | t | } | d j o | | d } qe n | o | i | d p d | } | d j o! | d | i t | 7} n | S( s- Produce text documentation for a data object.s = R i s ...s
N(
Rw R4 R R- R Rq R t chopRs R RU Ru R (
Rw R R R1 R R- R R4 R Rq ( ( R R
s
%
!( R R RM Rp Ro R4 Rs Ru R RU R
R R RU R R> R R ( ( ( R Rq s Zq + c C s t a t | d S( sC The first time this is called, determine what kind of pager to use.N( t getpagert pagerR+ ( R+ ( ( R R s c C s t t i t i j o t Sn t i i p t i i o t Sn t i i
d d d g j o t Sn d t i j oP t i d j o d Sq t i i
d d d g j o d Sq d Sn t i d j p t i i d o d
Sn t
t d o! t i d d
j o d Sn d k } | i \ } } t i | z= t
t d o% t i d | d
j o d Sn t SWd t i | Xd S( s2 Decide what method to use for paging through text.t TERMt dumbt emacst PAGERR c C s t t | t i d S( NR ( t
tempfilepagert plainR+ R R ( R+ ( ( R R ( s c C s t t | t i d S( NR ( t pipepagerR R+ R R ( R+ ( ( R R * s c C s t | t i d S( NR ( R R+ R R ( R+ ( ( R R , s t os2c C s t t | d S( Ns more <( R R R+ ( R+ ( ( R R . s t systems (less) 2>/dev/nulli c C s
t | d S( Nt less( R R+ ( R+ ( ( R R 0 s Ns more %sc C s
t | d S( Nt more( R R+ ( R+ ( ( R R 7 s ( Ry R t stdoutRz t FileTypet
plainpagert stdint isattyR R Re R RR R R t tempfilet mkstempt fdRa Rr t ttypagert unlink( R Ra R ( ( R R s4 " # &
* c C s t i d d | S( s% Remove boldface formatting from text.s .R N( R R R+ ( R+ ( ( R R = s c C sG t i | d } y | i | | i Wn t j
o n Xd S( s3 Page through text by feeding it to another program.t wN( R t popent cmdt pipet writeR+ Rr Rk ( R+ R R ( ( R R A s
c C si d k } | i } t | d } | i | | i z t i | d | Wd t i | Xd S( s< Page through text by invoking a program on a temporary file.NR R ( R t mktempRa Ri Rj R R+ Rr R R R R ( R+ R R Ra Rj ( ( R R J s
c C s t t | d } yA d k } t i i } | i | } | i | d } Wn( t
t f j
o d } d } n XzXt i i d d d } } t i i t | | d d x| | ot i i d t i i | } | d d
g j o t i i d PnA | d d g j o- t i i d | | d | d } q n | d
d d g j o) | | | } | d j o
d } qn t i i d t | | | | !d d | | } q WWd | o | i | | i | n Xd S( s% Page through text on a text terminal.s
Nc C s t i i d S( Ni ( R R R ( ( ( R R ^ s c C s t i i d d S( Nii ( R R Rp ( ( ( R R a s t LINESi i s
-- more --t qt Qs
s
R] t Bs i ( R R R+ R t ttyR R t filenoR t tcgetattrt oldt setcbreakt getcharR R RU R R Re R} t incR R R t flushR t tcsetattrt TCSAFLUSH( R+ R R R R R} R R R ( ( R R V sF
!
, c C s t i i t | d S( s> Simply print unformatted text. This is the ultimate fallback.N( R R R R R+ ( R+ ( ( R R | s c C s t i | oP | i t i j o d | i Sn t | d o d | i Sq` d | i Sn t i | o d | i Sn t i | o d | i Sn t i | o d | i Sn t i
| o d | i Sn t | t i
j o d | i i Sn t | i S( s/ Produce a short description of the given thing.s built-in module RO s package s module s built-in function s class s function s method s instance of N( R R# t thingR R R R R& R$ R' R7 Ry Rz t InstanceTypeR ( R ( ( R t describe s$ c C s g } t | d D] } | o | | q q ~ } d \ } } xU | t | j oA t t
| | d d | } | o | | d } } qD PqD W| oP | } x? | | D]3 } y t | | } Wq t j
o d Sq Xq W| Sn" t t | o t t | Sn d S( s@ Locate an object by name or dotted path, importing as necessary.R i i N( Ni ( R R R R R RU Rn t nR R R R t
nextmoduleR RE R R RQ ( R R R R R Rn R R R ( ( R t locate s( 5
c C s_ t | t o5 t | | } | p t d | n | | f Sn | t | d d f Sd S( sD Given an object or a path to an object, get the object and its name.s$ no Python documentation found for %rR N( R R R R R R R RE RU ( R R R ( ( R t resolve s s Python Library Documentation: %sc C s3 y t | | \ } } t | } t i | } | o, d | j o | d | | i
d 7} n* | o" | | j o | d | i 7} n t i | p- t i
| p t i | p
t | t p t | } | d 7} n t | | d t i | | Wn t t f j
o } | GHn Xd S( sC Display text documentation, given an object or a path to an object.R s in s in module s objects
N( R R R R R R R R R$ Rn t rfindR R# R$ R% R R Ry R R R+ R R Rt R? ( R R R R R Rn R? R ( ( R R s @ &c C s yt t | | \ } } t i t | t i | | } t | d d } | i | | i d G| d GHWn t
t f j
o } | GHn Xd S( s< Write HTML documentation to a file in the current directory.s .htmlR t wroteN( R R R R R t htmlR R R Ri Rj R Rr R Rt R? ( R R R R R? Rj R ( ( R t writedoc s $
R c C s | d j o
h } n x t i | D] } t i i | | } t | o t | | | d | q' t i i | oh t i
| } | oN | d j o | d } n | | } | | j o d | | <t | q q q' q' Wd S( sA Write out HTML documentation for all modules in a directory tree.R RW ii N( t doneRU R R+ R Rj R R R\ t writedocst pkgpathRY R R, R! R ( R R R R! Rj R ( ( R R s"
t Helperc B s8 t Z h d d <d d d f <d d d f <d d
d f <d d
d f <d d d f <d d d f <d d <d d d f <d d <d d d f <d d <d d d f <d d <d! d" d# f <d d d$ f <d d% d& f <d' d( d) f <d* d+ <d, d- d. f <d/ d <d0 d <d1 d2 d f <d3 d4 d f <d5 d6 d7 f <d8 d9 d. f <d d: d7 f <d; d< d= f <d> d? d f <Z h d@ dA dB f <dC dD dE f <dF dG dH f <dI dJ dK f <dL dD dM f <dN dO dP f <dQ dR dS f <dT dU dV f <dW dX dY f <dZ d[ d\ f <d] d^ <d. d_ d` f <da db dc f <dd de df f <dg dh di f <dj d@ <dk d@ <dl dm d f <dn do dp f <dq dr d f <ds dt d f <du dA dv f <d& dw d f <dx d <dy dz d{ f <dK dy <d| dy <d} d~ d@ f <d d d f <d d d f <d d d f <d d d f <d d d f <d) d d f <d d d f <d d d f <d d d f <d# d d f <d d d f <d d# <d d# <d7 d d f <d d d f <d d d f <d d d f <d d d f <d d d f <d d d f <d dZ <d d d f <d d d f <d d d f <d^ d d f <d d d f <d d d f <d d d f <d d d f <dp d d) f <d d dy f <d d dy f <d d dy f <d d dy f <d d dy f <d d dy f <d+ d( d f <d d d f <d d <d d d f <d d d f <d d <d d3 <d d8 <d d <d d <d d d f <d$ d d f <d d d f <Z d Z d Z e d Z d Z d Z d Z
d Z d d d Z d Z
d Z d Z d d Z RS( Nt andt BOOLEANt asserts
ref/assertR t breaks ref/breaks while fort classs ref/classs CLASSES SPECIALMETHODSt continues ref/continuet defs ref/functiont dels ref/delt BASICMETHODSt elift ift elses ref/ift exceptt tryt execs ref/exect finallyt fors ref/fors break continue whilet fromt importt globals
ref/globalt
NAMESPACESt
TRUTHVALUEs
ref/importt MODULESt ins ref/comparisonst SEQUENCEMETHODS2t ist
COMPARISONt lambdas ref/lambdasRz t nott ort passs ref/passt prints ref/printt raises ref/raiset
EXCEPTIONSt returns
ref/returns ref/tryt whiles ref/whiles break continue if TRUTHVALUEt yields ref/yieldt TYPESs ref/typessR STRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspectt STRINGSs ref/stringss4 str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPESt
STRINGMETHODSs lib/string-methodss STRINGS FORMATTINGt
FORMATTINGs lib/typesseq-stringst OPERATORSt UNICODEs: encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPESt NUMBERSs ref/numberss INTEGER FLOAT COMPLEX TYPESt INTEGERs ref/integerss int ranget FLOATs ref/floatings
float matht COMPLEXs
ref/imaginarys
complex cmatht SEQUENCESs lib/typesseqs% STRINGMETHODS FORMATTING xrange LISTSt MAPPINGSt DICTIONARIESs lib/typesfunctionss def TYPESt METHODSs lib/typesmethodss class def CLASSES TYPESt CODEOBJECTSs lib/bltin-code-objectss compile FUNCTIONS TYPESt TYPEOBJECTSs lib/bltin-type-objectss types TYPESt FRAMEOBJECTSt
TRACEBACKSt NONEs lib/bltin-null-objectt ELLIPSISs lib/bltin-ellipsis-objectt SLICINGSt FILESs lib/bltin-file-objectst SPECIALATTRIBUTESs lib/specialattrsRy s! class SPECIALMETHODS PRIVATENAMESs lib/typesmodulest PACKAGESt EXPRESSIONSs ref/summarys lambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIES BACKQUOTESt
PRECEDENCEt OBJECTSs ref/objectst SPECIALMETHODSs ref/specialnamesst BASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS1 MAPPINGMETHODS SEQUENCEMETHODS2 NUMBERMETHODS CLASSESs ref/customizations cmp hash repr str SPECIALMETHODSt ATTRIBUTEMETHODSs ref/attribute-accesss ATTRIBUTES SPECIALMETHODSt CALLABLEMETHODSs ref/callable-typess CALLS SPECIALMETHODSt SEQUENCEMETHODS1s ref/sequence-typess) SEQUENCES SEQUENCEMETHODS2 SPECIALMETHODSs ref/sequence-methodss) SEQUENCES SEQUENCEMETHODS1 SPECIALMETHODSt MAPPINGMETHODSs MAPPINGS SPECIALMETHODSt
NUMBERMETHODSs ref/numeric-typess* NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODSt EXECUTIONs
ref/execmodels% NAMESPACES DYNAMICFEATURES EXCEPTIONSs
ref/namings* global ASSIGNMENT DELETION DYNAMICFEATURESt DYNAMICFEATURESs ref/dynamic-featurest SCOPINGt FRAMESs ref/exceptionss try except finally raiset COERCIONSs ref/coercion-rulest CONVERSIONSs ref/conversionst IDENTIFIERSs ref/identifierss keywords SPECIALIDENTIFIERSt SPECIALIDENTIFIERSs ref/id-classest PRIVATENAMESs ref/atom-identifierst LITERALSs ref/atom-literalssH STRINGS BACKQUOTES NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALSt TUPLESt
TUPLELITERALSs
ref/exprlistss TUPLES LITERALSt LISTSs lib/typesseq-mutablet LISTLITERALSs ref/listss LISTS LITERALSs lib/typesmappingt DICTIONARYLITERALSs ref/dicts DICTIONARIES LITERALSt
BACKQUOTESs ref/string-conversionss repr str STRINGS LITERALSt
ATTRIBUTESs ref/attribute-referencess( getattr hasattr setattr ATTRIBUTEMETHODSt
SUBSCRIPTSs ref/subscriptionss ref/slicingst CALLSs ref/callst POWERs ref/powert UNARYs ref/unaryt BINARYs
ref/binaryt SHIFTINGs ref/shiftingt BITWISEs ref/bitwises EXPRESSIONS BASICMETHODSs ref/Booleanss EXPRESSIONS TRUTHVALUEt ASSERTIONt
ASSIGNMENTs ref/assignmentt AUGMENTEDASSIGNMENTs
ref/augassignt DELETIONt PRINTINGt RETURNINGt IMPORTINGt CONDITIONALt LOOPINGs ref/compounds for while break continues lib/truths if while and or not BASICMETHODSt DEBUGGINGs lib/module-pdbt pdbc C s4 | | _ | | _ d | _ t i i t i } t i i d } x t i i d | o t i i | d d t t i d t i i | d d t t i d d t t i d d t i d d t i d t i i t i d g D]< } | o/ t i i t i i | d
o
| | _ q q Wd S( Nt
PYTHONHOMER R s" /usr/share/doc/python-docs-%s/htmli s /usr/doc/python-docs-s /usr/doc/python-i s% Resources/English.lproj/DocumentationR ( t inputRw t outputRU t docdirR R t dirnameR t
executablet execdirR Re t homedirR R R Rt R R
( Rw R) R* R/ R R. ( ( R RW [ s )c C s. t i d d d j o | d Sn d S( Ni i t ?R s <pydoc.Helper instance>( R t stackRw ( Rw ( ( R t __repr__m s c C sF | d j o | i | n% | i | i | i i d d S( Ns
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.
( t requestRU Rw t helpt introt interactR* R ( Rw R3 ( ( R t __call__s s
c C s | i i d x t o y | i d } | p Pn Wn t t f j
o Pn Xt t | d d d d } t
| d d g j o Pn | i | q Wd S( Ns
s help> R R t 'R t quit( Rw R* R RZ t getlineR3 t KeyboardInterruptt EOFErrorR R, R R4 ( Rw R3 ( ( R R6 s c C sO | i t i j o t | Sn+ | i i | | i i | i i Sd S( s. Read one line, using raw_input when available.N(
Rw R) R R t raw_inputt promptR* R R Rp ( Rw R> ( ( R R: s
c C sK t | t d j o | d j o | i q7| d j o | i q7| d j o | i q7| d j o | i q7| d d j o | i t | d q7| | i j o | i | q7| | i
j o | i | q7| o t | d q7n) t | t
o | n t | d | i i d
d S( NR R4 t keywordst topicsRo i s modules i s Help on %s:s
( Ry R3 Rw R5 t listkeywordst
listtopicst listmodulesR R? t showtopicR@ R R R R* R ( Rw R3 ( ( R R4 s*
c C s | i i d t i d d S( Ns
Welcome to Python %s! This is the online help utility.
If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://www.python.org/doc/tut/.
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, or topics, type "modules",
"keywords", or "topics". Each module also comes with a one-line summary
of what it does; to list the modules whose summaries contain a given word
such as "spam", type "modules spam".
i ( Rw R* R R R ( Rw ( ( R R5 s i iP c C s | } | i | | } t | | d | } x t | D] } x t | D]~ } | | | } | t | j oW | i i
| | | | d j o. | i i
d d | d t | | q qS qS W| i i
d q@ Wd S( Ni R s
( t itemsR- R t columnst colwR R R t rowR R Rw R* R ( Rw RE RF R R R RG R RH ( ( R R s
6c C s* | i i d | i | i i d S( NsN
Here is a list of the Python keywords. Enter any keyword to get more help.
( Rw R* R R R? RD ( Rw ( ( R RA s c C s* | i i d | i | i i d S( NsN
Here is a list of available topics. Enter any topic name to get more help.
( Rw R* R R R@ RD ( Rw ( ( R RB s c C s | i p | i i d d Sn | i i | | i i | }
|
p" | i i d t | d Sn t
|
t
d j o | i |
Sn |
\ } } | i d | d } y t | } Wn | i i d | d Sn Xt i d t i t i B } t i d t i t i B }
t i |
d t i | d | i } | i d k } d k } d k } | i } | i | i | i | } | i" | _# | d | _$ | i% | _& | d
| _' | _( | i) | t* | i+ d d d
d } t, d t- | d
| oW | i } | i | i. d t/ t0 | d d
| i i d | i+ n d S( Ns
Sorry, topic and keyword documentation is not available because the Python
HTML documentation files could not be found. If you have installed them,
please set the environment variable PYTHONDOCS to indicate their location.
s no documentation found for %s
R R s .htmls could not read docs from %s
s <div[^>]*navigat.*?</div.*?>s <address.*?>.*?</address.*?>c C s
| i h S( N( t parsert do_p( RI ( ( R R s c C s
| i d S( Ns ( R] R ( t aR] ( ( R R s s R s
s
s s Related help topics: s , s
%s
(1 Rw R+ R* R R@ Re t topicR? t targetR4 Ry RD Ra t xrefsRi Rj R R t It St divpatt addrpatR R R Rr t htmllibt formattert StringIOt buffert
HTMLParsert AbstractFormattert
DumbWriterRI RJ t start_tablet end_tablet do_brt start_trt start_tdt start_tht feedR, t getvalueR R t send_flowing_dataR R ( Rw RL RI Rj Ra RT RN RV RQ R RM RU RS RR ( ( R RD sD
! *
!
-c C s~ | o | i i d t | nV | i i d h } | d } t i | | i | i
| i i d d S( NsO
Here is a list of matching modules. Enter any module name to get more help.
sI
Please wait a moment while I gather a list of all available modules...
c C sR | o# | d d j o | d d } n t | d d j o d | | <n d S( Nis .__init__s
(package)R i i ( R! t findRo ( R R! R Ro ( ( R t callback s s
Enter any module name to get more help. Or, type "modules spam" to search
for modules whose descriptions contain the word "spam".
( R> Rw R* R t aproposRo Rd t
ModuleScannert runR RD ( Rw R> Ro Rd ( ( R RC s ( R R R? R@ RW R2 RU R7 R6 R: R4 R5 R RA RB RD RC ( ( ( R R s& 3P
-t Scannerc B s t Z d Z d Z d Z RS( s A generic tree iterator.c C s) | | _ g | _ | | _ | | _ d S( N( t rootsRw t statet childrent descendp( Rw Ri Rk Rl ( ( R RW s
c C s | i pC | i p d Sn | i i d } | | i | f g | _ n | i d \ } } | p | i i | i Sn | i d } | i
| o# | i i | | i | f n | S( Ni i( Rw Rj Ri RU t popt rootRk t nodet nextt childRl R ( Rw Ro Rq Rn Rk ( ( R Rp ! s
#( R R RM RW Rp ( ( ( R Rh s Rf c B s8 t Z d Z d Z d Z d Z e e d Z RS( s7 An interruptible scanner that searches module synopses.c C sJ t d t } t i | | | i | i t d | | _ d S( Nc C s
| d f S( NR ( R ( R ( ( R R 3 s c C s | \ } } t i | i S( N( R t pkgR R` t st_ino( R R Rr ( ( R R 5 s ( R. R
Ri Rh RW Rw t
submodulest isnewpackaget inodes( Rw Ri ( ( R RW 2 s c C s | \ } } g } xr t i | D]a } t i i | | } t | o& | i | | | o d | f q" | i | | f q" W| i
| S( NR ( R t packageRk R R+ Rj R R R\ R R- ( Rw R R Rw Rj R Rk ( ( R Rt 7 s
&
c C sv | \ } } t i i | o t i | i } t i i | o
| | i
j p | i
i | t | Sn t
S( N( R Rw R R t existsR` Rs t inodet islinkRw Rv R R\ R[ ( Rw R R Rw Ry ( ( R Ru B s
%#c
C s | o t | } n t | _ h } x t i D] } | d j o d | | <| d j o | d | d q t t | i
p d d d } t t | d | | d j o | d | | q q0 q0 Wx | i p | i } | p Pn | \ } } t i | } t i i | o | o | | o d | } | | j oz d | | <| d j o | | | d qt | p d } t t | d | | d j o | | | | qqq q W| o | n d S( Nt __main__i R s
i s - R ( R> R R[ Rw R9 Rk R R R! RU Rd R R RM R Rc Rp Ro R Rw R R, R RY Rs t completer(
Rw Rd R> R| Ro Rw R! R Rk R ( ( R Rg I s>
#$
$! ( R R RM RW Rt Ru RU Rg ( ( ( R Rf 0 s
c C sP d } y
d k } Wn t j
o n X| i d t i | | d S( sA Print all the one-line module summaries that contain a substring.c C s; | d d j o | d d } n | G| o d | GHd S( Nis .__init__s
(package)s - ( R! R ( R R! R ( ( R Rd k s Nt ignore( Rd t warningsR t filterwarningsRf Rg R> ( R> Rd R~ ( ( R Re i s
c C s d k } d k } d k } d | i f d Y} d | i f d Y} d | i f d Y} | i | _ | | _ | | _
z: y | | | i
Wn t | i f j
o n XWd | o | n Xd S( Nt Messagec B s t Z d d Z RS( Ni c C sf | i } | i d i d i | | | | i d | _ | i d | _ | i
| i d S( Ni s content-transfer-encodings content-type( Rw R R R@ RW t fpt seekablet getheadert encodingheadert
typeheadert parsetypet
parseplist( Rw R R R ( ( R RW { s !
( R R RW ( ( ( R R z s t
DocHandlerc B s# t Z d Z d Z d Z RS( Nc C sa yG | i d | i d d | i | i i t i | | Wn t
j
o n Xd S( Ni s Content-Types text/html( Rw t
send_responset send_headert end_headerst wfileR R R R R Rk ( Rw R R ( ( R t
send_document s
c C s | i } | d d j o | d } n | d d j o | d } n | o | d j o y t | d d } Wn8 t j
o, } | i | t i t | d Sn X| o& | i t
| t i | | q| i | d t | n t i
d d d
} d } t d t i }
t i |
| } d
t i d d d | g } h } x* t D] } | i t i | | qkW| t | d } | i d | d S( Nis .htmli R R R s$ no Python documentation found for %ss? <big><big><strong>Python: Index of Modules</strong></big></big>s #ffffffs #7799eec C s d | | f S( Ns <a href="%s.html">%s</a>( R ( R ( ( R t bltinlink s c C s
| d j S( NR{ ( RI ( RI ( ( R R s s <p>s Built-in Moduless #ee77aas <p align=right>
<font color="#909090" face="helvetica, arial"><strong>
pydoc</strong> by Ka-Ping Yee <ping@lfw.org></font>s Index of Modules( Rw R R R8 Rt R? R R R R R R R4 R R RL R R t namesR R R t indicesRk R
R R Rn R ( Rw R8 R? R R Rk R R R R R ( ( R t do_GET s8 &
c G s d S( N( ( Rw R ( ( R t log_message s ( R R R R R ( ( ( R R s #t DocServerc B s# t Z d Z d Z d Z RS( Nc C sh t i d j o d p d } d | f | _ d | | f | _ | | _ | i i | | i | i
d S( Nt macs 127.0.0.1t localhostR s
http://%s:%d/( R R t hostt portRw t addressR Rd RA RW t handler( Rw R Rd R ( ( R RW s
c C sj d k } t | _ xQ | i pF | i | i i g g g d \ } } } | o | i q q Wd S( Ni (
t selectR[ Rw R9 t socketR t rdt wrt ext handle_request( Rw R R R R ( ( R t serve_until_quit s
- c C s/ | i i | | i o | i | n d S( N( Rw RA t server_activateRd ( Rw ( ( R R s
( R R RW R R ( ( ( R R s ( t BaseHTTPServert mimetoolsR R t BaseHTTPRequestHandlerR t
HTTPServerR RA R t MessageClassR Rd R R; t errorR| ( R Rd R| R R R R R R ( ( R t servev s . c C sn d f d Y} d k } y8 | i } z | | } | i Wd | i XWn t j
o n Xd S( sE Graphical interface (starts web server and pops up a control window).t GUIc B s t Z d d Z d Z d d d Z d d Z d d Z d Z d d Z d Z
d d
Z d d Z d Z
d
Z d d Z RS( Ni( c
C s | | _ d | _ d | _ d k } | i | | _ | i | i d d | _ | i
| i d d d | i d d | _ | i
| i d d d | i
d d | _ | i | | _ | i | i d d | _ | i | i | _ | i i d | i | i
| i d d
d d d | i d d | _ t i d
j o | i i d d n | i i d | i i d | i
| i i d d d d | i i d d d d d d | i i d d d d d d | i i d d d d | i i d d | i i d d d d d d | i i d d d d | i i d t i d
j o d p d f } | i | d | d d | _ | i i d | i | i i d | i! | i" | d d! d | i i# | _$ | i i% d" | i$ i& | i | | _' | i
| i' d d# d | i! | _( | i
| i' d d$ d | i) | _* | i( i d d d d d d | i* i d d d d d d | i i+ | i i, | _- | i i. | _/ | i i0 | i i0 | i i0 | i' i0 | _1 | i- | i1 | _2 | _3 d | _4 | i i5 d% | i- | i/ f | i i6 | i- | i/ | i i7 i8 d k9 } | i: d& t; d' | | i= | i
f i> d S(( NR+ s Starting server...
s open browsert commandRj t disableds quit servings
Search fors <Return>t stopt padyi R t sidet rightt pydoct WM_DELETE_WINDOWt topt fillRI t leftt expandi t helveticai i
t fontt heighti s
<Button-1>s <Double-Button-1>t orientt verticalt yscrollcommands go to selecteds hide resultss %dx%dRM R (? t windowRw RU t servert scannert Tkintert Framet
server_frmt Labelt title_lblt ButtonRi t open_btnR9 t quit_btnt
search_frmt
search_lblt Entryt
search_entt bindR3 R t stop_btnR R t packR t protocolt focus_setR t Listboxt
result_lstR t gotot Scrollbart yviewt
result_scrt configt sett
result_frmt goto_btnt hidet hide_btnRB t winfo_widtht minwidtht winfo_heightt minheightt winfo_reqheightt bigminheightt bigwidtht bigheightt expandedt wm_geometryt
wm_minsizet tkt willdispatcht threadingt ThreadR R t readyR ( Rw R R R R R ( ( R RW sl $
#
9 c C sM | | _ | i i d d | i | i i d d | i i d d d S( NR+ s Python documentation server at
Rj t normal( R Rw R R R R R ( Rw R ( ( R R s c C s | p
| i i } y d k } | i | Wn t j
o t i d j o t i d | q t i d j o4 y
d k
} Wn t j
o q X| i | q t i d | } | o t i d | q n Xd S( NR s
start "%s"R s netscape -remote "openURL(%s)" &s netscape "%s" &(
R Rw R t
webbrowserRi R R R R R t ict launchurlt rc( Rw t eventR R R R ( ( R Ri s
c C s+ | i o d | i _ n | i i d S( Ni ( Rw R R9 R ( Rw R ( ( R R9 0 s
c C s | i i } | i i d d | i i d d | i i d d | | i i | i i d d | i i
d d | i i d d
| i d k
} | i o d | i _ n t | _ | i d | i i d
| i | | i f i d S( NR R Rj R R+ s Searching for "%s"...R i R R i RM R ( Rw R Re R> R R R R t forgetR t deleteR R R R R9 Rf R Rg RB R R ( Rw R R R> ( ( R R3 5 s
c C sI | d d j o | d d } n | i i d | d | p d d S( Nis .__init__s
(package)R s - s (no description)( R! Rw R t insertR ( Rw R R! R ( ( R RB G s c C s' | i o d | i _ d | _ n d S( Ni ( Rw R R9 RU ( Rw R ( ( R R M s
c C s d | _ | i i d d | i i d d | i i d d d d d d t i d
j o | i i
n | i i d d d S(
NR+ s
Search forR R R R RI R i R Rj R ( RU Rw R R R R R R R R R ( Rw ( ( R R R s c C s | i i d d d S( NRj R ( Rw R R ( Rw R ( ( R R Z s c C s\ | i i } | oB t | i i | d d } | i d | i i | d n d S( Ni R s .html(
Rw R t curselectiont selectionR Re R! Ri R R ( Rw R R R! ( ( R R ] s c C s | i p d Sn | i i | i i | i i | i i | _ | i i | _
| i i d | i | i
f | i i | i | i
d | _ d S( Ns %dx%di ( Rw R R R R R R R R R R R R R R ( Rw ( ( R t collapsec s
c C s | i o d Sn | i i d d d d | i i d d d d | i i d d d d d d
| i i d | i | i f | i i
| i | i d
| _ d S( NR t bottomR RI R t yR t bothR i s %dx%d(
Rw R R R R R R R R R R R R ( Rw ( ( R R n s
c C s | i | i d S( N( Rw R R ( Rw R ( ( R R w s
( R R RW R RU Ri R9 R3 RB R R R R R R R ( ( ( R R s E N( R R t TkRn t guit mainloopt destroyR; ( Rn R R R ( ( R R s c C s& t | t o t | t i d j S( Ni ( R RI R Rc R t sep( RI ( ( R t ispath s c C s d k } d f d Y} t i i t i d } | t i j o t i i | n t i i d d y| i t i d d \ }
} d } x |
D] \ } } | d j o t | d Sn | d j oV y t | } Wn t j
o
| n Xd
} d } t | | | d Sn | d j o
d } q q W| p
| n x | D] } t | o" t i i | o d
| GHPn y t | o# t i i | o t | } n | o< t | o! t i i | o t | qt | n t i | Wq\t j
o } | GHq\Xq\WWnV | i! | f j
oA t i i" t i d }
d |
t i$ |
|
|
t i$ f GHn Xd S( s@ Command-line interface (looks at sys.argv to decide what to do).Nt BadUsagec B s t Z RS( N( R R ( ( ( R R s i R i s gk:p:ws -ks -pc C s d | i GHd S( Ns pydoc server ready at %s( R R ( R ( ( R R s c C s d GHd S( Ns pydoc server stopped( ( ( ( R t stopped s s -ws file %r does not existsc pydoc - the Python documentation tool
%s <name> ...
Show text documentation on something. <name> 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 <name> contains a '%s', 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.
%s -k <keyword>
Search for a keyword in the synopsis lines of all available modules.
%s -p <port>
Start an HTTP server on the given port on the local machine.
%s -w <name> ...
Write out the HTML documentation for a module to a file in the current
directory. If <name> contains a '%s', it is treated as a filename; if
it names a directory, documentation is written for all the contents.
(% t getoptR R R R, R t argvt scriptdirt removeR t optsR t writingt optt valRe R R t
ValueErrorR R R t argR Rx RY R R
R R R4 Rt R? R R R R ( R R? R R R R
R R R R R R R R ( ( R t cli s\
! R{ (O RM R R R R R Rl R R Rz R RQ R4 R t stringR Rc R R R R R R t collectionsRI R
R R R" R) R, R1 R t
IGNORECASER2 R6 R: RC RK RU RV R\ Rs R5 Rt R R R R R Rp Rq R R R R R R R R R R+ R R R R R R R R R4 Rh Rf Re R R R R
R (C R Rp R4 R) R R R+ Rt RQ R, R" R Re R R R Rc R R R
Rl R R R R R R R R R1 R R6 R RI R R\ R R R R R R Rq Rf R
Rz R R R R Rh R RK RV R R R R R: Rs R R R2 R RC R R ( ( R R0 sz ?
7
# 26* ) O &
.9
[ K