python (3.11.7)
eO d Z dgZdZdZdZddlZddlZddlZddl Zddl
Zddl Zddl Z ddl
Z
ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlmZ ddlm Z dd l m Z d
Z d Z d Z!d
Z"d Z#d Z$d Z%d Z&d Z'd Z(d Z) ej* dej+ Z,d Z-d Z.d Z/d Z0 e1ej2 Z3dSdZ4d Z5d Z6d Z7d Z8i fd Z9 G d d!e: Z;d" Z<di fd#Z= G d$ d% Z> G d& d'e Z? G d( d)e> Z@ G d* d+e ZA G d, d-e> ZB G d. d/eB ZCd0 aDd1 ZEd2 ZFd3 ZGd4 ZHd5 ZId6 ZJd7 ZKd8 ZLdTd9ZM eB ZN eC ZO e@ ZPdTd:ZQ dUd<ZR dVd>ZSdTd?ZTdWdAZU G dB dC ZV eV ZW G dD dE ZXdF ZYdG ZZdXdIZ[dTdJdKdLdMZ\dN Z]dO Z^dP Z_dQ Z`eadRk r e` dS dS )Ya Generate Python documentation in HTML or text for interactive use.
At the Python interactive prompt, calling help(thing) on a Python object
documents the object, and calling help() starts up an interactive
help session.
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 -n <hostname>" to start an HTTP server with the given
hostname (default: localhost) on the local machine.
Run "pydoc -p <port>" to start an HTTP server on the given port on the
local machine. Port number 0 can be used to get an arbitrary unused port.
Run "pydoc -b" to start an HTTP server on an arbitrary unused port and
open a web browser to interactively browse documentation. Combine with
the -n and -p options to control the hostname and port used.
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
https://docs.python.org/X.Y/library/
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.
helpzKa-Ping Yee <ping@lfw.org>z26 February 2001zGuido 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)deque)Repr)format_exception_onlyc F g } g }t j D ]}t j |pd }t j | }||vrIt j | r*| | | | | S )zAConvert sys.path into a list of absolute, existing, unique paths..)syspathosabspathnormcaseisdirappend)dirsnormdirsdirnormdirs 9/BuggyBox/python/3.11.7/bootstrap/lib/python3.11/pydoc.pypathdirsr R s
DHx % %goocjS))'""3'' ( " "rw}}S'9'9 " KK OOG $ $ $ K c t j | j }|d S | j d d d D ]}t
|| }t j | sd S |S )Nr ) r modulesget
__module__ __qualname__splitgetattrinspectisclass)funcclsnames r
_findclassr$ ^ sw
+//$/
*
*C
{t!'',,SbS1 ! !c4 ?3 t Jr c J t j | rZ| j j }| j }t j | r*t
t
||d d | j u r|}n~|j }nut j | r.| j }t | }|t
|| | urd S n3t j
| rC| j }| j }t j | r|j dz |z | j k r|}n|j }nt | t r4| j }|j }t | }|t
|| | urd S nt j | st j | ri| j }| j }t
|| | urd S t j | r2t
|dd }t |t& r ||v r|| S nd S |j D ]7} t+ t
|| }n# t, $ r Y -w xY w||c S 8d S )N__func__r __slots__)r ismethodr& __name____self__r r __class__
isfunctionr$ isbuiltinr
isinstancepropertyfgetismethoddescriptorisdatadescriptor __objclass__ismemberdescriptordict__mro__
_getowndocAttributeError)objr# selfr" r! slotsbasedocs r _finddocr> h sd (|$| OD ! ! ! GD$--z : :cl J JCC.CC C |oo ;'#t,,C774 8 3 || OD ! ! ! #d *c.> > >CC.CC C " " x} ;'#t,,C774 8 #C ( (
G,DS,I,I
| 3 S ( (4 %c * * #Cd33E%&&
#45== T{"t WT4 0 011CC H ?JJJ 4s . H
HHc t | d }|dS | t ur1t | j }t |t
r||k rdS |S # t $ r Y dS w xY w)zUGet the documentation string for an object if it is not
inherited from its class.__doc__N)object__getattribute__typer@ r. strr8 )r9 r= typedocs r r7 r7 s
%%c955 ;4 d??3ii'G'3''
GsNNt
tts A 8A A
A+*A+c t | }|) t | }n# t t f$ r Y dS w xY wt |t
sdS t
j | S )zGet the documentation string for an object.
All tabs are expanded to spaces. To clean up docstrings that are
indented to line up with blocks of code, any whitespace than can be
uniformly removed from the second line onwards is removed.N)r7 r> r8 TypeErrorr. rD r cleandoc)rA r= s r _getdocrI sy V
C
{ 6""CC * 44 c3 t C s # 88c t | pt j | }|r(t j dd| pdS )z-Get the doc string or comments for an object.z^ *
)rI r getcommentsresubrstrip)rA results r getdocrQ sC
V__
; 3F ; ;F :bfWb&--//:: @b@r c \ | d }t | dk r
|d dfS t | dk r?|d s%|d d |dd fS dd | fS )z>Split a doc string into a synopsis line (if any) and the rest.
r rK N)stripr lenrO join)r= liness r splitdocrZ s IIKK d # #E
5zzQQx| Uq q !2!2 Qx59----
tyy r c D | j }| j |k r
| j dz |z }|S )z@Get a class name and qualify it with a module name if necessary.r )r) r )rA modnamer# s r classnamer] s. ?D
G## 3&- Kr c t j | pct j | pOt j | p;t j | p't j | pt j | S )z>Check if an object is of a type that probably means it's data.)r ismoduler isroutineisframe istracebackiscode)rA s r isdatard s| (( FGOF,C,C F!&))F-4_V-D-DF#F++F/6~f/E/E G Gr c |r@|d | |d } |dd }|@| S )z/Do a series of global replacements on a string.rT r rU N)rX r )textpairss r replacerh sM
Qx}}TZZa 1 122abb Kr c t | |k rTt d|dz
dz }t d|dz
|z
}| d| dz | t | |z
d z S | S )zCOmit part of a string if needed to make it fit in a maximum length.r rU N...)rW max)rf maxlenpreposts r cramrp sq
4yy6!fQh]##1fQhsl##DSDzE!DT4 $999 Kr z at 0x[0-9a-f]{6,16}(>+)$c 8 t d| S )z>Remove the hexadecimal id from a Python object representation.z\1) _re_stripidrN rf s r stripidrt s ??5$ ' ''r c t j | rdS t j | r*t | dd }t j | p|du S dS )zo
Returns True if fn is a bound method, regardless of whether
fn was implemented in Python or in C.
Tr* NF)r r( r- r r_ )fnr: s r _is_bound_methodrw sb
t >r:t,,$T**<tt|== 5r c
i }t j | t j D ]
\ }}d||< | j D ]$}| t | %| D ]}t | | ||< |S NrT )r
getmembersr` __bases__update
allmethodskeysr )clmethodskeyvaluer< s r r} r} s G (W->??
U ) )z$''((((||~~ ( ( r3'' Nr c g }g }| D ]8} || r| | #| | 9||fS )zSplit 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)])
r )s predicateyesnoxs r _split_listr sX
C B
9Q<< JJqMMMM IIaLLLL 7Nr c f | dv rdS | d r| d rdS | d rt |d rdS |t ur4| t v r+t t
|| d t j rd S || |v S | d S )
z3Decide whether to show documentation on a variable.> r@ __date____file__r) __path____spec__r'
__author__
__cached__
__loader__r __credits__ __package__ __version__ __builtins__r r __rT __fieldsTNF)
startswithendswithhasattr
__future___future_feature_namesr. r _Feature)r# allr9 s r visiblenamer s H H H q t > t!4!4>QQ s Y 7 7 t
* )>!>!> gc4..
0C D D 5
s{??3''''r c g }t j | D ]T\ }}}}t j | r d}t |t r |j d}| ||||f U|S )zCWrap inspect.classify_class_attrs, with fixup for data descriptors.data descriptorNreadonly property)r classify_class_attrsr2 r. r/ fsetr )rA resultsr# kindr" r s r r r , s G$+$@$H$H 1 1 tS% #E * * +$D%**
+uz/A*dC/0000 Nr c t |dg fdt D n# t $ r i Y nw xY wfd}| | dS )zGSort the attrs list in-place by _fields and then alphabetically by namer c < i | ]\ }}||t z
S )rW ).0ir# fieldss r
<dictcomp>z#sort_attributes.<locals>.<dictcomp>= s) OOO DtaF mOOOr c L | d d | d fS Nr )r )attr field_orders r <lambda>z!sort_attributes.<locals>.<lambda>@ s" KOODGQ 7 7aA r r N)r enumeraterG sort)attrsrA keyfuncr r s @@r sort_attributesr 7 s VY
+
+FOOOOYv=N=NOOO AAAAG JJ7Js 1 A A c t j | rHdD ]E}t j t j | d|z r dS FdS )z3Guess whether a path refers to a package directory.)z.pyz.pyc__init__TF)r r
r isfilerX )r
exts r ispackager E sc w}}T " Cw~~bgll4c1A B BCC
tt
5r c z | }|d d dk s| s9| }|sn"|d d dk %| 9| }|d d dk r
|dd }|d d dk r|dd }|dd dk r
|d d }| s+| }|sn| +| d d }nd }|S )
NrT # zr"""rj """r \r )readlinerV r )filelinerP s r source_synopsisr M s4 ==??D
rr(c// /}}U rr(c// / ::<<D BQBx6$qrr(4 BQBx5ABBx 9 T#2#Yd**,, ==??D **,, E""1%++--& Mr c X t j | j }| | d \ }}|||k rn| t t j j rt j j }nE| t t j j
rt j j }nd}|Q t j
| }n# t $ r Y dS w xY w|5 t | }ddd n # 1 swxY w Y n |d| }t j d| | } t j | } n# Y dS xY wt( j d= | j r | j d nd}||f|| < |S )z.Get the one-line summary out of a module file.NNN__temp__loaderr )r statst_mtimer r tuple importlib machineryBYTECODE_SUFFIXESSourcelessFileLoaderEXTENSION_SUFFIXESExtensionFileLoadertokenizeopenOSErrorr utilspec_from_file_location
_bootstrap_loadr r r@
splitlines)
filenamecachemtime
lastupdaterP
loader_clsr r specmodules
r synopsisr ^ s GH &E 8\::JZ% / / U9#6#H I I J J ",AJJ
uY%8%K L L
M
M ",@JJ J
}X..
tt
/
/(..
/
/
/
/
/
/
/
/
/
/
/
/
/
/
/ Z
H55F >99*hAG : I ID
"-33D99
tt J'7=~OV^..00334F &/h Ms0 C
C*)C*/D DD E& &E+c e Zd ZdZd Zd ZdS )ErrorDuringImportzEErrors that occurred while trying to import something to document it.c > || _ |\ | _ | _ | _ d S N)r excr tb)r: r exc_infos r r zErrorDuringImport.__init__ s
(0%$*dgggr c D | j j }d| j d|d| j S )Nz problem in - z: )r r) r r )r: r s r __str__zErrorDuringImport.__str__ s) h +/===###tzzJJr N)r) r r r@ r r r r r r r s= OO1 1 1K K K K Kr r c t j j }t | d 5 }|| t | k }ddd n # 1 swxY w Y t j | }t j | \ }}|r!t j
|| }n t j
|| }t j
|| | } t j | S # t! | t# j xY w)z<Import a Python source file or compiled file given its path.rbNr )r r MAGIC_NUMBERr readrW r r
basenamesplitext_bootstrap_externalr SourceFileLoaderr r r r r r ) r
magicr is_bytecoder r# r r r s r
importfiler sJ N 'E
dD 5TtyyU 4 44 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5w %%H **ID# L.CCD$OO.??dKK > 1 1$V 1 L LD6#))$///6 clnn555s 'AA A D& &#E c |r_ t j v rQ t j vrC fdt j D } g|z D ]$}t j | ||< t j |= %t }n# t j x\ }}}} t j v r%t t j j | |t u rt |j | t |t r|j k rY dS t t j xY w d dd D ]$}
t ||
}# t $ r Y dS w xY w|S )a 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).c D g | ] }| d z | S )r )r )r mr
s r
<listcomp>z safeimport.<locals>.<listcomp> s. KKKa!,,tcz2J2JKKKKr Nr rT )r r builtin_module_names
__import__r r r SyntaxErrorr
issubclass ImportErrorr# r r r8 ) r
forceloadr subsr r r r r infoparts ` r
safeimportr s :
),,3333 LKKK3;KKK 6D= ) )C!$S!1E#J C((D!!:"%,..0eR4 3; #CK$5$>EE E
K
#END99 9
[
)
) :ejD.@.@44 $D#,..99 9
3# + + fd++VV ***dddd* Ms% A0A4 4B D$!D$E
E&%E&c e Zd Zej ddej dd z Zd dZ d dZ
e
xZ xZ xZ
xZxZZ ej d fdZdS )
Doc
PYTHONDOCSz%https://docs.python.org/%d.%d/libraryNrU c 8 ||f|z } t j | r
| j | S t j | r
| j | S t j | r
| j | S n# t $ r Y nw xY wt j | r
| j | S | j
| S )z%Generate documentation for an object.) r r_ docmoduler docclassr`
docroutiner8 r2 docdatadocother)r: rA r# argss r documentz Doc.document s ~$
'' E0E)Ev&& C}t}d/C(C (( G $1G*G G D #F + +GLDL$4G-G t}d##s A$ A$ A$ $
A10A1c x d|odt | z dt | j }t | )z+Raise an exception for unimplemented types.z!don't know how to document object z of type )reprrC r) rG )r: rA r# r messages r failzDoc.fail sB
%S4::% % %tF||'<'<> r stdlibc t j | }n# t $ r d}Y nw xY wt j d| j }t j | }t |t t r|j dv sH| | r| t j
|d s|j dvr| d rAd | d |j }n=t j
||j d z }nd
}|S ) z*Return the location of module docs or None
(built-in)r )
errno
exceptionsgcimpmarshalposixsignalr _thread zipimportz
site-packages)z xml.etreeztest.pydoc_mod)zhttp://zhttps://z
{}/{}.html/.htmlN)r
getabsfilerG r environr r r
r
r. rC r) r rX formatrO lower)r: rA basedirr doclocs r getdoclocz
Doc.getdocloc s` %f--DD DDD do>>'""7++ vtBxx ( (
_ !9 9 9 oog&&9 //"',,w"H"HII 9
O#B B B !899
Q%,,V]]3-?-? AVAVAXAXYY ffo.C.C.E.E.OPPF
s &&r )r) r r r r) r r version_infor r r r r r r docpropertyr sysconfigget_pathr. r r r r r s G"%"22A2"6!78 8J$ $ $ $ ! ! ! ! LPOIOO:OO;(: (:8(D(D r r c > e Zd ZdZd Zd Zd Zd Zd ZeZ d Z
eZ dS ) HTMLReprzBClass for safely making an HTML representation of a Python object.c t t j | dx| _ | _ d| _ dx| _ | _ d S N
d r r maxlistmaxtuplemaxdict maxstringmaxotherr: s r r zHTMLRepr.__init__
9
d')) t} ),, r c , t |dddddd S )N&z&<z<>z>)rh r: rf s r escapezHTMLRepr.escape s tS'3VDDDr c , t j | | S r )r r r: rA s r r z
HTMLRepr.repr s yv&&&r c t t | d rfdd t | j z }t | | r t | | || S | t t t | | j
S Nr) repr_r ) r rC rX r) r r rG rp rt r r? r: r level
methodnames r repr1zHTMLRepr.repr1 s 477J ' ' ; 388DGG,<,B,B,D,D#E#EEJtZ((
;0wtZ00E:::{{4Q 0 0$-@@AAAr c t || j }t | }d|v r=dt |dd vr*d|d z | | z |d z S t j dd| | S )Nr \\rK rr z-((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)z <span class="repr">\1</span>)rp r> r rh rG rM rN r: r rN testtestreprs r repr_stringzHTMLRepr.repr_string s At~&&:: 4<<D%(D(D D D !$t{{4'8'888A;F FvF5kk(++- - -r c | t t t | | j S # | d|j j z cY S xY wNz
<%s instance>)rG rp rt r r> r+ r) r: r rN s r
repr_instancezHTMLRepr.repr_instance- s` G;;tGDGG$4$4dn E EFF F G;;1E EFF F F Fs AA $A*N) r) r r r@ r rG r rP rW repr_strr[ repr_unicoder r r r4 r4 s LL- - - E E E' ' 'B B B - - - HG G G LLLr r4 c e Zd ZdZ e Zej Zej Zd ZddZ d dZ
d Z d
Z d Z
d Zd
Zd Zd Zd Zd Zdi i i fdZd dZd dZddi i fdZd Zddi i i dfdZd dZeZd dZ d dZ dS ) HTMLDocz'Formatter class for HTML documentation.c d|d|dS )Format an HTML page.zN<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: z</title>
</head><body>
z
</body></html>r )r: titlecontentss r pagez HTMLDoc.page> s UUHHH& &r rK c d|d|pddS )zFormat a page heading.zU
<table class="heading">
<tr class="heading-text decor">
<td class="title"> <br>z</td>
<td class="extra"> z</td></tr></table>
r )r: rb extrass r headingzHTMLDoc.headingJ s$ 55&$H$$ & &r Nrf c | dd|z z dz }d|d|d}|r|d|d |d
|d |d |d
z }n|d|d|d|d
z }|d|z z S )z Format a section with a heading.Nz<span class="code">rf z</span>z-<p>
<table class="section">
<tr class="decor zD-decor heading-text">
<td class="section-title" colspan=3> <br>z</td></tr>
z
<tr><td class="decor z-decor" rowspan=2>z</td>
<td class="decor z-decor" colspan=2>z</td></tr>
<tr><td></td>z-decor">z </td><td>z.
<td class="singlecolumn">%s</td></tr></table>r ) r: rb r" rc widthprelude
marginaliagaprP s r sectionzHTMLDoc.sectionS s .E1AAIMJ
33
NV cc:::sssGGGSSS : :FF
V8;ZZZ N NF IHTTTr c ( d|z } | j |g|R S )z$Format a section with a big heading.z&<strong class="bigsection">%s</strong>)rp )r: rb r s r
bigsectionzHTMLDoc.bigsectionh s& 85@t|E)D))))r c ~ | | }t |dddddddd S )z!Format literal preformatted text.
z
r rf rS <br>
)rG
expandtabsrh rF s r preformatzHTMLDoc.preformatm sB {{4??,,--tVWfg (D(< < <r c d}t | dz dz }t d D ]R}|dz }t ||z ||z |z D ],}|t | k r| ||| z dz }-|dz }Sd|z S )z0Format a list of items into a multi-column list.rK rj r z<td class="multicolumn">ru rk z<table><tr>%s</tr></table>)rW range)r: listr* rP rowscolr s r multicolumnzHTMLDoc.multicolumns s D A
!#88 & &C 88F48T#Xd]33
A
As4yy== #ffT!Woo 5 @Fg%FF+f44r c d|z S )Nz <span class="grey">%s</span>r rF s r greyz HTMLDoc.grey s
!?$!FFr c : |D ]}||v rd|| d|dc S |S )z:Make a link for an identifier, given name-to-URL mappings. <a href=""></a>r )r: r# dictsr5 s r namelinkzHTMLDoc.namelink sE B BDt|||04T
DDDAAAA r c |j t j |j }}t || r1t
|| |u r d|j d|dt || dS t || S )zMake a link for a class.r .html#r r )r) r r r r r r r] )r: rA r\ r# r s r classlinkzHTMLDoc.classlink s 8I(J(Jf 64 CWVT%:%:f%D%D%Dy'A'A'A'AC
C)))r c ( d|j d|j dS )zMake a link for a module.r .html">r )r) rI s r
modulelinkzHTMLDoc.modulelink s -3___foooNNr c |\ }}}}|r| | S |r |d|d}nd|z }|rd|z }n|}d|d|dS )z;Make a link for a module or package to display in an index.r r' z%s.htmlz"<strong>%s</strong> (package)r r r )r )r:
modpkginfor# r
r shadowedurlrf s r
modpkglinkzHTMLDoc.modpkglink s{ *4'dIx #99T?? " #"&$$-CCd"C 7$>DDD(+TTT22r c d|d|dS )zMake a link to source file.z<a href="file:r r r )r: r r
s r filelinkzHTMLDoc.filelink s -0SS$$$77r c |p| j }g }d}t j d } | || } | sn| \ }
} | ||||
| \ } }
}}}}|
r= || dd }| d|d|d n3|r8d t | z }| d|d || d n|r8d
t | z }| d|d || d n|rW|| | d z d k r-| d
| || z n| d|z nf|| | d z d k r,| | |||| n)| | || | }| |||d d
| S )zMark up some plain text, given a context of symbols to look for.
Each context dictionary maps object names to anchor names.r zJ\b((http|https|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?(\w+))T"z"r r r z(https://www.rfc-editor.org/rfc/rfc%d.txtz!https://peps.python.org/pep-%04d/rT (zself.zself.<strong>%s</strong>NrK ) rG rM compilesearchspanr groupsrh intr rX )r: rf rG funcsclassesr r herepatternmatchstartendr schemerfcpepselfdotr# r s r markupzHTMLDoc.markup su &4;* 3 4 4 NN4..E % JE3 NN66$tEz"233 4 4 438<<>> 0Cc7D
= fSkk))#x88SSS ABBBB
=@3s88KVVC[[[[ IJJJJ
=9CHHDVVC[[[[ IJJJJ
= CE ?c))NN7T]]4-I-I#IJJJJNN#=#DEEEEc#a%i C''t}}T7E7 K KLLLLt}}T7 ; ;<<<D7 8 vvd455k**+++www r c d}|D ]}t | t d u r|\ }}|dz }|| || z }|rU||fk rNg }|D ]+} | | | | ,|dz d | z dz }|dz }t | t g u r |d| ||| z z }d |z S )
zAProduce HTML for a class tree as given by inspect.getclasstree().rK r z<dt class="heading-text">r , )z
</dt>z
<dd>
%s</dd>
z
<dl>
%s</dl>
)rC r r rX
formattree)
r: treer\ parentrP entrycbasesparentsr< s
r r zHTMLDoc.formattree s
'
'EE{{d2hh&& 5 "== $..G"<"<< EUvi / / G % F F t~~dG'D'DEEEE #c\DIIg,>,> > DF )+eR(( "3doo7A7' 7' #' ' 6))r c
|j } |j }n# t $ r d}Y nw xY w| d }g }t t | dz
D ]B}| dd |d|dz d|| d Cd ||dd z } d| z }
t j | } t j | }
| | }
n# t $ r d }
Y nw xY wg }t |d
rwt! |j }|dd d k r*|dd d
k r |d d }| d | z t |d r:| t! |j |r|
dd | z z }
| }|dt- z }nd} |
d|
z |z }t j |t j }g i }}t j |t j D ]T\ }}|t j | p||u r5t9 ||| r$| ||f d|z x||< ||< U|D ]z\ }}|j D ]m}|j |j }}t> j ! | }||k r8|r6t || r&tE || |u r||vr|dz |z x||< ||< n{g i }}t j |t j# D ]\ }}|*t j$ | st j | |u rOt9 ||| r>| ||f d|z ||< t j% | r || ||< g } t j |tL D ]-\ }}t9 ||| r| ||f . ' tQ | j) || } | od| z } |d| z z }t |d rg } tU j+ |j, D ] \ } }} | ||| df | - . | j/ }!| 0 d d |! z }n5|r3 . | fd }!| 0 d d |! z }|rd |D }" 1 t j2 |"d | g}!|D ]1\ }}|! 3 ||||| 2| 0 d!d"d# |! z }|rcg }!|D ]1\ }}|! 3 ||||| 2| 0 d$d%d# |! z }| r`g }!| D ].\ }}|! 3 || /| 0 d&d'd( |! z }t |d) rG ' t! |j4 j) }!| 0 d*d+|! z }t |d, rG ' t! |j5 j) }!| 0 d-d.|! z }|S )/z/Produce HTML documentation for a module object.Nr rT r z.html" class="white">r r !<strong class="title">%s</strong>r r $Revision: $z
version %sr z (%s)r z-<br><a href="%(docloc)s">Module Reference</a>rK z<a href=".">index</a><br>r r z#-z <span class="code">%s</span>z
<p>%s</p>
r r zPackage Contentsz pkg-contentc : | d S ry )r )tr: s r r z#HTMLDoc.docmodule.<locals>.<lambda>9 s 4??1Q4#8#8 r Modulesc g | ]\ }}|S r r r r r s r r z%HTMLDoc.docmodule.<locals>.<listcomp>> s ;;;<C;;;r Classesindexr Functions functionsDatadataru r Authorauthorr Creditscredits)6r) __all__r8 r ry rW r rX r r( urllibparsequoter rG r rD r rV rG r r. localsrh rz r_ r getmoduler r{ r r r r r r` r- r, rd r rQ rw pkgutil iter_modulesr r r} r rr r getclasstreer r r )#r: rA r# modignoredr partslinksr
linkednameheadr
r r r versionr- rP r r cdictr r r< r\ r r fdictr r= modpkgsimporterispkgrc classlists# ` r r zHTMLDoc.docmodule s! .CC CCC
3s5zz!|$$ 3 3A LLL%1+&&&&a2
3
3
3
3 XXeeBCCj 011
2Z? $%f--D,$$T**C}}S$//HH $ $ $#HHH $ 6= ) ) =&,--Gss| 111gbcclc6I6I!"R%...00 KK t{{7';';; < < < 6: & & ; KK C$8$899 : : : 4'DIIdOO33D '' DvxxOFFF d$?($JV$STT$VW-=>>R!,VW_EE : :JC"5))3V>> sC00 :NNC<00003c 9E#Ju ! P PJC
P
P #}doW 11d??v?'F2F? vs++t33 "e||7>7IC7O OE#Jt
P 2u!,VW5FGG L LJC!%(( ,3,=e,D,D,N,N sC00 LLL#u ...!%E#J )%00Ks%,!,VV<< * *JC3V,,
* S%L)))kk&..$.%GG:4s:-#-- 6: & & 4G,3,@ ,Q,Q
:
:('5ua 89999 LLNNN'' AAHdoo"M8 = = =FF
4''8888: :Hdoo=( 4 4 4F 8;;7;;;I 4Y B BDIIKH %
O
O
U
eS$u M MNNNNdoo7CHHX$6$6 8 8 8F >H #
O
O
U
eS$u M MNNNNdoo[#((8*<*< > > >F 9H "
;
;
U
eS 9 9::::doo
h 7 7 9 9 9F 6< ( ( L{{3v'8#9#94>JJHdooh( K KKF 6= ) ) N{{3v'9#:#:DNKKHdooiH M MMF
s !!A D
D D c > ! j }|p|}j }g } | j G fdd }
|
t t j } t
| dk rV d | D ])} d | j z * d fd}
fd} fd }fd
t D }i |D ]O\ }}}}d |z d z |z x |< } t | }n# t $ r Y nw xY w | |< @# t $ r Y Lw xY w|r| r| !n|d
d !t |!fd \ }}t j ur!t j u r|}]!u rd}n d !j z }|dz
}t% | |
d|z |d } |
d|z |d } |
d|z |d } |d|z |d } |d|z |d } |d |z |d }|g k sJ |}|d | } ||k r
d |d |d!}n d"|d#|d$|d%}|rPg }|D ]0} | | j 1|d&d' | z z }d } t j }n# t* t f$ r d(}Y nw xY w|r2t- | } | r!| d)k r| | z d*z }t1 } |r|| pd z } | j } | od+| z } |d,| d-| S ).z.Produce HTML documentation for a class object.c e Zd Zd Z fdZdS )(HTMLDoc.docclass.<locals>.HorizontalRulec d| _ d S r needoner@ s r r z1HTMLDoc.docclass.<locals>.HorizontalRule.__init__f
r c : | j r d d| _ d S )Nz<hr>
rT r r: pushs r maybez.HTMLDoc.docclass.<locals>.HorizontalRule.maybeh % < #DNNN r Nr) r r r r r s r HorizontalRuler e =
!
!
!
!
!
!
!
!
!
!r r rU z&<dl><dt>Method resolution order:</dt>
z <dd>%s</dd>
</dl>
c f t || \ }}|r
| |D ]x\ }}}} t
| } ||
n0# t $ r# || Y nw xY w d y|S )NrS r r r r Exceptionr )msgr r okr# r homeclsr r r hrmdictr rA r r: s r spillz HTMLDoc.docclass.<locals>.spillx s #E955IB
S 24
.D$H ' 5 5 T]]5$(-wv G G H H H H % = = = T\\%s ; ;<<<<<= DJJJJLs A55*B"!B"c t || \ }}|rI
| |D ]'\ }}}}
|| (|S r r r r r r r r r# r r r r r r r: s r spilldescriptorsz*HTMLDoc.docclass.<locals>.spilldescriptors x #E955IB
9
S 24 9 9.D$D eT3778888Lr c t || \ }}|r | |D ]\ }}}} t | | }t | } | s d|z nA t | j
} d| z } d|| d d |S )Nz<dl><dt>%s</dl>
z <dd><span class="code">%s</span><dl><dt>r rS )r r r r rQ r rw )r r r r r# r r r r< r= r r r r r rA r r: s r spilldataz#HTMLDoc.docclass.<locals>.spilldata s #E955IB
S 24
.D$ ==)>)>cJJD --C B 04 78888 "kk&-- */% A A @3 F ddCCC @AAADJJJJLr c H g | ] \ }}}}t | ||||f S )r9 r r r# r r" r rA s r r z$HTMLDoc.docclass.<locals>.<listcomp> L 3 3 3+T4e &1113$c5) 3 3 3r r -r c | d u S NrU r r thisclasss r r z"HTMLDoc.docclass.<locals>.<lambda> AaDI<M r defined hereinherited from %sz:<br>
z
Methods %sc | d dk S NrT methodr r s r r z"HTMLDoc.docclass.<locals>.<lambda> AaDH$4 r zClass methods %sc | d dk S NrT z class methodr r
s r r z"HTMLDoc.docclass.<locals>.<lambda> AaDN$: r zStatic methods %sc | d dk S NrT z
static methodr r
s r r z"HTMLDoc.docclass.<locals>.<lambda> AaDO$; r zReadonly properties %sc | d dk S NrT r r r
s r r z"HTMLDoc.docclass.<locals>.<lambda> qt7J/J r zData descriptors %sc | d dk S NrT r r r
s r r z"HTMLDoc.docclass.<locals>.<lambda> qt7H/H r z Data and other attributes %sc | d dk S NrT r r r
s r r z"HTMLDoc.docclass.<locals>.<lambda> ! r rK <a name="z">class <strong>
</strong></a>z<strong>z</strong> = <a name="z">class r (%s)r N()rt z&<span class="code">%s<br> </span>rb rj ) r) r{ r r r getmrorW r r r r r r rG popleftr builtinsrA r rX signature
ValueErrorrD rG rQ r rw rp )"r: rA r# r r r r realnamer rc r mror< r r r r r r r r anchor inheritedtagrb r declr% argspecr= r r r r s" `` ``` @@@@r r zHTMLDoc.docclassZ s ? x ! ! ! ! ! ! ! ! ! ! ^
GN6**++ s88a<< HHJJJ D: ; ; ;
J
J_t~~d6<6G(I (I I J J J J DOOO $ $3 3 3 3/CF/K/K3 3 3 ).
%Cw"%*s"2S"8 8E#J
--
&e
!
( KKMM !!HQK *52M2M2M2M N N E9X_,,ho1M1M!f$$$)DNN9;A;L-N -N N 9 C E6 * * * E,,e446 6EE,s2E::< <EE-3U;;= =E$$%=%CU%J%JL LE$$%:S%@%%H%HJ JE I <s BE 6 68 8EB;;;; EC ! F 778$$ 8 hhh EE
dddHHH&E 8G
H
Ht~~dF4E F FGGGGFTYYw%7%7 77E )&11III& III <)nnG
<7d??dkk' 2 22V;Vnn %#)$Ckk#t~uguEED>D||E7Ha===s6 D00
D=<D=E
EE'K< <LLc X | d| | z S z)Format an argument default value as text.=)r r rI s r formatvaluezHTMLDoc.formatvalue s% yytyy 0 00111r c |j }|p|}|r|j pddz |z } d}
d} t | rp|j j } |r | |urd| | | z }
nD|j $d| |j j | z }
nd| | | z }
t j | st j | rd}
nd}
||k r
d | d
|d }n>|r/t j ||g |u rd |j dz |z d
|d}d} n|}d | d
|d|}d}t j | rU t j
| }n# t t f$ r d}Y nw xY w|r$t | }|dk rd|z }|dd }|sd}|
|z | | z |
o| d|
z z }| rd|z S | t# | | j ||| }|od|z }d|d|dS )z;Produce HTML documentation for a function or method object.rK r r from N method of %s instance unbound %s methodasync r z
"><strong>r z
<a href="#r r rT z</strong></a> = <lambda>z$<strong>%s</strong> <em>lambda</em> r (...)z$<span class="heading-text">%s</span>z<dl><dt>%s</dt></dl>
z%<dd><span class="code">%s</span></dd>r z</dt>r )r) rw r* r+ r r iscoroutinefunctionisasyncgenfunctiongetattr_staticr` r% r& rG rD rG r r rQ rw )r: rA r# r r r r r r' r) noteskipdocsimclassasyncqualifierrb reallinkr- r% r, r= s r r zHTMLDoc.docroutine s ? x$*c1D8 F # #
N o/G
N"$$#dnnWc&B&BBD?.3dnn 1378 78 8DD 0$..2M2MMD ' / / *622 %NN N 8 >DffhhhOEE
$g,R2>>&HHHK#%000((( < #hh(E V $ $ ,
! # -f 5 5 *
!
!
!
!
, i..z)) BT IE &admG G % G(<(<< AHyy?$FGGI <+d2 2++vwI ICGACGCC15sss; ;s 2E E E c g }|j }|r |d|z | t | | j }|r |d|z |d d | S )z1Produce html documentation for a data descriptor.z!<dl><dt><strong>%s</strong></dt>
z&<dd><span class="code">%s</span></dd>
r rK )r r rQ rw rX r: rA r# r r r r r= s r r zHTMLDoc.docdataA s ~ > D5< = = =kk&..$.99 B D:S@ A A A Ywww r c D |rd|z pd}|| | z S )z-Produce HTML documentation for a data object.z<strong>%s</strong> = rK r )r: rA r# r r lhss r r zHTMLDoc.docotherQ s. 6/$6<"TYYv&&&&r c F g }|i }t j |g D ]@\ }}}t d |D r | |d|||v f d||< A| | || j }| |d| S )z2Generate an HTML index for a directory of modules.Nc 3 P K | ]!}d t | cxk odk nc V "dS )i i N)ordr chs r <genexpr>z HTMLDoc.index.<locals>.<genexpr>[ sD @@RFc"gg////////@@@@@@r rK rT r )r r anyr r r} r rr )r: r r r r r# r rc s r r z
HTMLDoc.indexV s X%,%93%%@%@ !HdE@@4@@@@@
NND"eTX-=> ? ? ? HTNN ##GT_==sGX666r rK )ri rK Nrf r r NNN) r) r r r@ r4 _repr_instancer rG rd rh rp rr rw r} r r r r r r r r r r r1 r r r0 r r r r r r_ r_ 5 s 11 XZZN D
"F
&
&
&& & & & 3419U U U U** * *
< < <
5
5
5 GFF * * *O O O
3
3
3 8 8 8 #'b"b ' ' ' ' V* * * *&s s s sj %)d"b `> `> `> `>D2 2 2 '+R?< ?< ?< ?<B K' ' ' '
7
7
7
7
7
7r r_ c . e Zd ZdZd Zd Zd ZeZd ZdS )TextReprzAClass for safely making a text representation of a Python object.c t t j | dx| _ | _ d| _ dx| _ | _ d S r6 r: r@ s r r zTextRepr.__init__i rA r c f t t | d rfdd t | j z }t | | r t | | || S t
t t | | j S rK )
r rC rX r) r r rp rt r r? rM s r rP zTextRepr.repr1o s 477J ' ' ; 388DGG,<,B,B,D,D#E#EEJtZ((
;0wtZ00E:::GDGG$$dm444r c t || j }t | }d|v r*dt |dd vrd|d z |z |d z S |S )Nr rR rK rS r )rp r> r rh rT s r rW zTextRepr.repr_stringv sa At~&&:: 4<<D%(D(D D D !$t+hqk9 9r c t t t | | j S # d|j j z cY S xY wrY )rp rt r r> r+ r) rZ s r r[ zTextRepr.repr_instance sF :Q(($.99 9 :"Q[%99 9 9 9s .1 AN) r) r r r@ r rP rW r\ r[ r r r rQ rQ g s] KK- - - 5 5 5 H: : : : :r rQ c e Zd ZdZ e Zej Zd ZddZd Z ddZ
dd Z dd
Z d Z
dd Zdd
ZeZddZdS )TextDocz'Formatter class for text documentation.c @ d d |D S )z(Format a string in bold by overstriking.rK c 3 & K | ] }|d z |z V
dS )Nr rI s r rK z TextDoc.bold.<locals>.<genexpr> s* 55"rDy2~555555r )rX rF s r boldz TextDoc.bold s# ww55555555r c |sdS fd| d D }|r |d |d< d | S )z6Indent text by prepending a given prefix to each line.rK c g | ]}|z S r r )r r prefixs r r z"TextDoc.indent.<locals>.<listcomp> s <<<4$ <<<r rS r )r rO rX )r: rf r_ rY s ` r indentzTextDoc.indent sb BB<<<<4::d+;+;<<< 0eBi . . 0 0%)yy r c | | }| | dz |z dz S )z&Format a section with a given heading.rS rt )r` rO r[ )r: rb rc clean_contentss r rp zTextDoc.section s@ X..5577yy $& 7&@@r NrK c p d}|D ]}t | t d u rS|\ }}||z t | z }|r0||fk r)fd|D } |dd | z z }|dz }st | t g u r || |||dz z }|S )zBRender in text a class tree as returned by inspect.getclasstree().rK r c 3 8 K | ]}t | V d S r r] )r r r\ s r rK z%TextDoc.formattree.<locals>.<genexpr> s- D DyG 4 4 D D D D D Dr r r rS r\ )rC r] rX r )
r: r r\ r r_ rP r r r r s
` r r zTextDoc.formattree s
8
8EE{{d2hh&& 5 & 9Q+@+@@ BUvi / / D D D De D D DG #ftyy/A/A&A AF $ eR(( $//7Av#8 #8 8
r c |j }t t | \ }}| d||od|z z }t |dd }| | }| || d|dz z }|r|| d| z }g } t
j |t j D ]G\ }
} |t
j | p||u r(t |
|| r| |
| f Hg } t
j |t j D ]Y\ }
} |*t
j
| st
j | |u r(t |
|| r| |
| f Zg }
t
j |t D ]-\ }
} t |
|| r|
|
| f .g }t }t! |d rt# j |j D ]K\ }}}| | |r| |d z 6| | L| || d
d | z }g }t
j |t j D ];\ }
} | j |d z r|
|vr| |
<|r@| || d
d | z }| rd | D }| t
j |d | g}| D ]/\ }
} | | | |
| 0|| dd | z }| r`g }| D ]/\ }
} | | | |
| 0|| dd | z }|
rbg }|
D ]1\ }
} | | | |
|d 2|| dd | z }t! |d ret; |j }|dd dk r*|dd dk r |dd }|| d| z }t! |d r+|| d t; |j z }t! |d r+|| d t; |j! z }t! |d r+|| d t; |j" z } t
j# | }n# tH $ r d!}Y nw xY w|| d"| z }|S )#z5Produce text documentation for a given module object.NAMEr r NzMODULE REFERENCEa.
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
DESCRIPTIONr
(package)zPACKAGE CONTENTSrS r
SUBMODULESc g | ]\ }}|S r r r s r r z%TextDoc.docmodule.<locals>.<listcomp> s 999:3999r rT CLASSES FUNCTIONSF )rm DATAr r r r r VERSIONr DATEr AUTHORr CREDITSr FILE)%r) rZ rQ rp r r. r rz r r r r r` r- rd setr r r r addr rX r_ r r r r r rD r rV r r r r( rG )r: rA r# r synopdescrP r r- r r r r r r
modpkgs_namesr r\ r
submodulesr rc r r s r r zTextDoc.docmodule s\ vf~~.. t fde.E
&FGGfi.. '' dll+=v I @ F @dll=$ ? ??F!,VW_EE 1 1JC%e,,66AA sC00 1NNC<000!,VW5FGG / /JC!%(( ,3,=e,D,D,N,N sC00 /LL#u ...!,VV<< * *JC3V,,
* S%L)))
6: & &
8,3,@ ,Q,Q
,
,('5 !!'*** ,NN7\#9::::NN7++++ LLNNNdll"DIIg$6$6 8 8 8F
!,VW5EFF ' 'JC~((44
'M9Q9Q!!#&&& 5 OO dll dii
3 3 5 5 5F K99999I $Y22D: : ;H %
A
A
U
eS$ ? ?@@@@dll9dii6I6I J JJF MH #
A
A
U
eS$ ? ?@@@@dll; (8K8K L LLF HH "
L
L
U
eS$r
J JKKKKdll6499X3F3F G GGF 6= ) ) ?&,--Gss| 111gbcclc6I6I!"R%...00dll9g > >>F 6: & & Idll63v3G3G H HHF 6< ( ( Mdll8S9J5K5K L LLF 6= ) ) Odll9c&:L6M6M N NNF %f--DD DDD $,,vt444
s 9W W W c b j }|p|}j }j fd}||k rd | z }n | dz |z }|r+t || } |dd | z z }g }
|
j t j } n# t t f$ r d} Y nw xY w| r(t | } | r| dk r || z dz t }
|
r |
dz t t j }t | d k r2 d
|D ]} d || z d t! d
t" D t j }t | }d}|rX d |d| D ]} d |z ||k r! dt ||z
z dz d G fdd } | fd} fd} fd}fdt) D }|r|r| n|d d t- | fd \ }}t. j ur t. j u r|}\ u rd}nd t3 j z }t5 | |d |z |d } |d |z |d } |d!|z |d" } |d#|z |d$ } |d%|z |d& } |d'|z |d( }|g k sJ |}|d |
}
|
s|dz S |dz |
d) z dz S )*z4Produce text documentation for a given class object.c " t | | S r re )r r s r makenamez"TextDoc.docclass.<locals>.makename s Q?? "r class z = class r r Nr! rS rU zMethod resolution order:r\ rK c 3 K | ]=}|j d s!|j dk 't |j V >dS )r r$ N)r) r r rD )r r" s r rK z#TextDoc.docclass.<locals>.<genexpr>A sa
S
S3L++C00
S58^z5Q5Q
5Q5Q5Q5Q
S
Sr r r zBuilt-in subclasses:z ... and z other subclassesc e Zd Zd Z fdZdS )(TextDoc.docclass.<locals>.HorizontalRulec d| _ d S r r r@ s r r z1TextDoc.docclass.<locals>.HorizontalRule.__init__S r r c : | j r d d| _ d S )NzF----------------------------------------------------------------------rT r r s r r z.TextDoc.docclass.<locals>.HorizontalRule.maybeU r r Nr r s r r r R r r r c H t || \ }}|r | |D ]i\ }}}} t
| } ||
:# t $ r# || Y fw xY w|S r r )
r r r r r# r r r r r rA r r: s
r r z TextDoc.docclass.<locals>.spill[ s #E955IB
<
S 24 < <.D$< ' 5 5 T]]5(,c6 ; ; < < < < % = = = T\\%s ; ;<<<<<= Ls A22*B B c t || \ }}|rI
| |D ]'\ }}}}
|| (|S r r r s r r z*TextDoc.docclass.<locals>.spilldescriptorsl r r c
L t || \ }}|r
| |D ]k\ }}}}t | } t | } n # t $ r |j | } Y nw xY w
| | d| dz l|S )Nrn )rm r= rS )r r rQ r r8 __dict__r )r r r r r# r r r r= r9 r r rA r r: s r r z#TextDoc.docclass.<locals>.spilldatau s #E955IB
S 24 .D$ --C5 %fd 3 3) 5 5 5 % .t 45D sD#bc JJ Ls A A:9A:c H g | ] \ }}}}t | ||||f S r r r s r r z$TextDoc.docclass.<locals>.<listcomp> r r r c | d u S r r r s r r z"TextDoc.docclass.<locals>.<lambda> r r r r z Methods %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r zClass methods %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r zStatic methods %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r zReadonly properties %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r zData descriptors %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r z Data and other attributes %s:
c | d dk S r r r
s r r z"TextDoc.docclass.<locals>.<lambda> r r z | ) r) r{ r r[ maprX r r r% r& rG rD rQ r r" rW sortedrC __subclasses__r+ r r# r r$ rA r] r r` rO ) r: rA r# r r r' r r} rb r rc r% r- r= r( r<
subclassesno_of_subclassesMAX_SUBCLASSES_TO_DISPLAY subclassnamer r r r r r* r+ r r r s `` ` @@@r r zTextDoc.docclass s ? x + # # # # 8 tyy 2 22EEIIdOOk1H<E 8(E**GFTYYw%7%7 77E )&11III& III ,)nnG
,7d??TG^d*+++Vnn Dt GN6**++ s88a<< D+ , , ,
.
.Vhhtnn,---- DHHH
S
S$*=*=f*E*E
S
S
S
z??$%! D' ( ( ( *+E,E+E F
,
, Vl*++++ ";;;^),EEFFG() * * *
DHHH ! ! ! ! ! ! ! ! ! ! ^
"
3 3 3 3/CF/K/K3 3 3 !
( KKMM !!HQK *52M2M2M2M N N E9X_,,ho1M1M!f$$$)Ii6<6G-I -I I
E6 * * * E/C/446 6EE/#5u::< <EE036;;= =E$$%@3%F%J%JL LE$$%=%CU%H%HJ JE I ?# Eu 6 68 8E B;;;; EC ! F 99X&& 4< t|dkk(//*;*;V D DDtKKs B) )B?>B?c 2 d| | z S r/ rD rI s r r1 zTextDoc.formatvalue s TYYv&&&&r c |j }|p|}d}d}t | r^|j j }|r||urdt || z }n8|j dt |j j | z }ndt || z }t j | st j | rd} nd} ||k r| | }
n7|rt j ||g |u rd}| | d z |z }
d} t j
| rh t j | } n# t t f$ r d} Y nw xY w| r7t | } |d
k r"| | d z }
| dd } | sd
} | |
z | z |z }
|r|
dz S t | pd}|
dz |o)| | dz z S )z;Produce text documentation for a function or method object.rK r r3 Nr4 r5 r6 rT = r7 z lambda r r8 rS )r) rw r* r+ r] r r9 r: r[ r; r` r% r& rG rD rQ r` rO )r: rA r# r r r' r< r= r> r? rb r- r% r, r= s r r zTextDoc.docroutine s> ? x F # #
I o/G
I"$$#i&=&==D?.3i 1378 78 8DD 0)GC2H2HHD ' / / *622 %NN N 8 IIh''EE
g,R2>>&HH IIdOOe+h6E V $ $ ,
! # -f 5 5 *
!
!
!
!
, i..z)) IIdOOj 8E &admG G %/$6 L$; ..&BC$;#"J$++c*:*:*A*A*C*Cd*JK Ks D) )D?>D?c g }|j }|r) || | |d t | pd}|r) || | |d d | S )z1Produce text documentation for a data descriptor.rS rK )r r[ rQ r` rX rB s r r zTextDoc.docdata s ~ D4 ! ! ! DJJJVnn" DS!! " " " DJJJwww r c P | | }|r1|r|dz pd|z }|t | z
} | dk r
|d| dz }|r| | dz pd|z }|st | }|r+|d| t | z dz z
}|S )z-Produce text documentation for a data object.r rK r Nrk rS )r rW r[ rQ r` rD )
r: rA r# r r rm r= r r chops
r r zTextDoc.docother s yy 4)TE\/R47DCII%DaxxUdU e 304 506B$> !..C 8 D4;;s3xx00047 7D r )r\ )NrK r rN )NNNNN)r) r r r@ rQ rO r r[ r` rp r r r r1 r r r0 r r r r rW rW s 11 XZZN D6 6 6 A A A c c c cJXL XL XL XLt' ' '5L 5L 5L 5Ln K r rW c e Zd ZdZd ZdS )
_PlainTextDocz2Subclass of TextDoc which overrides string stylingc |S r r rF s r r[ z_PlainTextDoc.bold s r N)r) r r r@ r[ r r r r r s) << r r c @ t at | dS )zCThe first time this is called, determine what kind of pager to use.N)getpagerpagerrs s r r r s
JJE $KKKKKr c h t t j d st S t t j d st S t j r t j st S t j dk rt S t j d p t j d r@t j dk rfdS t j d dv rfd S fd
S t j d dv rt S t j dk rd S t t d rt j
d
dk rd S ddl } | \ }}t j
| t t d r2t j
d|z dk rd t j | S t t j | S # t j | w xY w)z2Decide what method to use for paging through text.isatty
emscriptenMANPAGERPAGERwin32c > t t | S r
tempfilepagerplainrf use_pagers r r zgetpager.<locals>.<lambda># s
eDkk9 E E r TERM)dumbemacsc > t t | S r ) pipepagerr r s r r zgetpager.<locals>.<lambda>% s %++y A A r c $ t | S r r r s r r zgetpager.<locals>.<lambda>' s $ : : r c < t t | d S )Nzmore <r rs s r r zgetpager.<locals>.<lambda>+ s M%++x @ @ r systemz(less) 2>/dev/nullr c " t | d S )Nlessr rs s r r zgetpager.<locals>.<lambda>- s IdF 3 3 r Nz more "%s"c " t | d S )Nmorer rs s r r zgetpager.<locals>.<lambda>4 s $ 7 7 r )r r stdin
plainpagerstdoutr platformr r) r r tempfilemkstempcloseunlinkttypager)r fdr r s @r r r s 39h ' ' 3:x ( ( 9 SZ%6%6%8%8
||##
z**EbjnnW.E.EI ; <7 " "EEEE E
Z^^F
#
#'8
8
8AAAA A:::: : z~~f !222
|w @@@r8 4+?!@!@A!E!E333OOO %%''NRHRLLL 2x RY{X/E%F%F!%K%K77 (
( (s 92H H H1c . t j dd| S )z%Remove boldface formatting from text.z.rK )rM rN rs s r r r : s
6%T " ""r c H ddl }| |d|j d } |j 5 } | | n# t
$ r Y nw xY wddd n # 1 swxY w Y n# t $ r Y nw xY w | dS # t
$ r Y nw xY w()z3Page through text by feeding it to another program.r NTbackslashreplace)shellr errors)
subprocessPopenPIPEr writeKeyboardInterruptr wait)rf cmdr procpipes r r r > s4 Ct:?#5 7 7D
Z 4
4 $
IIKKK E
D si A+ A AA
A
A AA A+ A##A+ &A#'A+ +
A87A8=B
B B c ddl }| 5 }t j |d }t |ddt j dk rt j d nd 5 }| | ddd n # 1 swxY w Y t j
|dz |z d z ddd dS # 1 swxY w Y dS )
z<Page through text by invoking a program on a temporary file.r Nz pydoc.outwr r )r encodingz "r ) r TemporaryDirectoryr r
rX r r r device_encodingr r )rf r r tempdirr r s r r r V sY OOO $ $ & & /'7<<55
(C(:,')) -a000/3 JJt
#*x'#-.../ / / / / / / / / / / / / / / / / /s6 AC1B CB CB CC C c t t j dd pd}| |d | S )Nr utf-8r )r r r encodedecode)rf r s r _escape_stdoutr b s= sz:t44?H ;;x!3 4 4 ; ;H E EEr c t t | d } ddl}t j }| | }| | d }n'# t t t j f$ r d}d }Y nw xY w t t j dd }n# t" $ r d}Y nw xY w|dk rd}|dz
x}}t j d |d| dz ||d rt j d t j | } | d
v r t j d n| d v r1t j d || z dz |dz }| d
v r||z
|z
}|dk rd}t j dd ||||z z dz ||z }||d |r | ||j | dS dS # |r | ||j | w w xY w)z%Page through text on a text terminal.rS r Nc @ t j d S ry )r r r r r r r zttypager.<locals>.<lambda>o s #)..++ r c ^ t j d d d d S )Nr rT )r r r r r r r zttypager.<locals>.<lambda>r s& #),,..ss3BQB7 r LINESrT z
-- more --)qQz
)
rS )bB)r r r ttyr r fileno tcgetattr setcbreakr r8 ioUnsupportedOperationr r r) r r& r r rX flush tcsetattr TCSAFLUSH)
rf rY r r oldgetcharhrS incr s
r r r g s .&& ' ' - -d 3 3E8
Y
mmB
b++ )@ A 8 8 8778 2 BJNN7A..//AA AAA 66Aa%C
5#;//$6777ABBi J \ * * * J AJ
!1222l""
!1E!H!<t!CDDDE&&&GcMq55a! J TDIIeAaeGn$=$= = D E E ECA! ABBi & 2 MM"cmS 1 1 1 1 1 2 23 2 MM"cmS 1 1 1 1 2s= AB !B%$B%*-C I* C'$I* &C''E!I* *!J c x t j t t | dS )z>Simply print unformatted text. This is the ultimate fallback.N)r r r r r rs s r r r s. JU>$//0011111r c t j | rA| j t j v r
d| j z S t | d r
d| j z S d| j z S t j | r
d| j z S t j | r$d| j j d| j j d| j S t j
| r$d| j j d| j j d| j S t j | r
d | j z S t j | r
d
| j z S t j
| r
d | j z S t | j S ) z/Produce a short description of the given thing.zbuilt-in module r zpackage zmodule zbuilt-in function zgetset descriptor r zmember descriptor r~ z function zmethod )r r_ r) r r r r- isgetsetdescriptorr3 r r4 r r, r( rC )things r describer s| . >S 5 5 5%6 6 5* % % . . . u~- - 5#en44!%(( ) ) )5+=+F+F+F NN !%(( ) ) )5+=+F+F+F NN u )%.((% ,U^++ *5>)) ;; r c d | d D }d\ }}|t | k rLt d |d|dz | }|r||dz }}nn|t | k L|r|}nt }||d D ]%} t || }# t $ r Y dS w xY w|S )z@Locate an object by name or dotted path, importing as necessary.c g | ]}||S r r )r r s r r zlocate.<locals>.<listcomp> s 6 6 6d 6T 6 6 6r r r NrT )r rW r rX r$ r r8 )r
r r r n
nextmodulerA r s r locater s 6 6djjoo 6 6 6EIFA
c%jj.. t!t 5 5yAA
:q1uqvv c%jj.. abb VT**FF 444 Ms B..
B=<B=c t | t r(t | | }|t d| z || fS t | dd }| t |t r|ndfS )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. rD r r r )r r rA r# s r resolver s %
>y)) > , /4 4 5 5
5 u} uj$//js 3 3=dd==r Python Library Documentation: %sc N |t }t | | \ }}t | }t j | }|r(d|v r$|d|d| d z z
}n|r||ur
|d|j z z
}t j | swt j | sct j | sOt j
| s;t | s,t |d r|j
}nt | }|dz
}||z dz | || z S )zBRender text documentation, given an object or a path to an object.Nr z in z in module
__origin__z objectrt )rf r r r r rfindr) r_ r r` r2 rI r r rC r )r rb r rendererrA r# rx r s r
render_docr sL 5),,LFD F D
v
&
&F 0t .tzz# ./// 0F&((
// V $ $ of%% '' &v.. foo 6< ( ( &FF&\\F I D 4<& 8#4#4VT#B#B BBr Fc H |K t t | || dS # t $ r }|r t | Y d}~dS d}~ww xY w t | ||t }n&# t $ r}t | }Y d}~nd}~ww xY w| | dS )zCDisplay text documentation, given an object or a path to an object.N)r r r print plaintextrD r )r rb r outputis_clir r s r r= r= s ~ *UE955 6 6 6 6 6
#JJJJJJJJJ
5%I>>AA CAAAAAA Qs, $
A AA A' '
B
1BB
c X t | | \ }}t t | t || }t |dz dd 5 }| | ddd n # 1 swxY w Y t d|dz dS )z<Write HTML documentation to a file in the current directory.r' r r )r Nwrote)r htmlrd r r r r r
)r r rA r# rd r s r writedocr s 5),,LFD 99Xf%%t}}VT'B'B C CD
dWncG 4 4 4
4 '4'>"""""s *B BBrK c f |i }t j | g| D ]\ }}}t | dS )zAWrite out HTML documentation for all modules in a directory tree.N)r
walk_packagesr )r pkgpathdoner r\ r s r writedocsr
sF |BT$+$93%$I$I '5
Fr c > e Zd Zi ddddddddddd d
d d d
ddddddddddddddd d d d d i d d!d"d#d$d%dd&d#d'd(d)d*d+d,d-d.d/d0dd1dd2d3d4d5d6d7d d8d9d:dd;d<d=iZd> d?D Zd@dAdBdCgeR dDdEdFdGdHdIdJZdKdLdMdNdOdPdQdRdSdTdUdVdVdWdWdXZe D ]1\ ZZ e D ])Z
e e
e Z ee vre dYz ez Z e ee
< *2[[ [
[ i dZd[dRd\d]d^d_d`dadbdcdddedfdgdhdidjdkdldmdndodpdqdrdsdtdudvdwdZdxdZi dydzdOd{d|d}d~ddddd#ddddddddddddddddddddddi dddddddddddddddddddSdddddkdddddddndddi dddddddddLdddddddddēd+dœddƓdd ddɓdd˓dddd6dd#ddddddӜZ ddՄZ
edք Zedׄ Zd Z e ZefdلZdڄ Zdۄ Zdd݄Zdބ ZddZd Zd Zd Z ddZ ddZ d Z ddZ dS )HelperFalserK NoneTrueandBOOLEANaswithassert)r rK async)r! rK await)r" rK break)r# while forclass)r% zCLASSES SPECIALMETHODScontinue)r& r$ def)functionrK del)r) BASICMETHODSelififelse)r- r$ excepttryfinallyfor)r1 zbreak continue whilefromimportglobal)r4 znonlocal NAMESPACES)r,
TRUTHVALUE)r3 MODULESin)r7 SEQUENCEMETHODSis
COMPARISONlambda)r; rm nonlocal)r< zglobal NAMESPACESnotorpass)r? rK raise)r@
EXCEPTIONSreturn)rB rm )r/ rA while)rC z break continue if TRUTHVALUE)r z CONTEXTMANAGERS EXCEPTIONS yieldyield)rD rK c " g | ] }d D ]}||z
S )'r r )r pr s r r zHelper.<listcomp>H s) LLLaLLAAELLLLr )r frS urG z'''r r )+r ***r& z//%<<>>rC |^~rD rE <=>===!=<>)rD rE rT rU rV rW rX )r rS ) z+=z-=z*=z/=z%=z&=z|=z^=z<<=z>>=z**=z//=)rO rP rC rQ rR rS )jJ)STRINGS OPERATORSr: UNARYAUGMENTEDASSIGNMENTBITWISECOMPLEXzOPERATORS FORMATTINGPOWERzTUPLES LISTS FUNCTIONSz ATTRIBUTES FLOAT MODULES OBJECTSELLIPSISzSLICINGS DICTIONARYLITERALSz def classr[ PRIVATENAMESzPRIVATENAMES SPECIALMETHODS
BACKQUOTESzTUPLES FUNCTIONS CALLSzLISTS SUBSCRIPTS SLICINGS)rN rM ,r rk :@r r r `r r []r TYPES)typeszRSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect)stringsz4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPES
STRINGMETHODS)zstring-methodszSTRINGS FORMATTING
FORMATTING)
formatstringsr\ UNICODE)rm z:encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPESNUMBERS)numberszINTEGER FLOAT COMPLEX TYPESINTEGER)integersz int rangeFLOAT)floatingz
float mathr` ) imaginaryz
complex cmath SEQUENCES)typesseqz$STRINGMETHODS FORMATTING range LISTSMAPPINGS DICTIONARIESrm )typesfunctionsz def TYPESMETHODS) typesmethodszclass def CLASSES TYPES CODEOBJECTS)zbltin-code-objectszcompile FUNCTIONS TYPES TYPEOBJECTS)zbltin-type-objectsz types TYPES FRAMEOBJECTS
TRACEBACKSNONE)zbltin-null-objectrK )zbltin-ellipsis-objectSLICINGSSPECIALATTRIBUTES) specialattrsrK rl )rl z!class SPECIALMETHODS PRIVATENAMESr6 ) typesmodulesr3 PACKAGES EXPRESSIONS)zoperator-summaryzlambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIESr\
PRECEDENCEOBJECTS)objectsrk SPECIALMETHODS) specialnameszbBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSESr* )
customizationz hash repr str SPECIALMETHODSATTRIBUTEMETHODS)zattribute-accesszATTRIBUTES SPECIALMETHODSCALLABLEMETHODS)zcallable-typeszCALLS SPECIALMETHODSr8 )sequence-typesz(SEQUENCES SEQUENCEMETHODS SPECIALMETHODSMAPPINGMETHODS)r zMAPPINGS SPECIALMETHODS
NUMBERMETHODS)z
numeric-typesz*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS EXECUTION) execmodelz%NAMESPACES DYNAMICFEATURES EXCEPTIONS
NAMESPACES)namingz3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURESDYNAMICFEATURES)zdynamic-featuresrK SCOPINGFRAMESrA )r ztry except finally raise CONVERSIONS) conversionsrK IDENTIFIERS) identifierszkeywords SPECIALIDENTIFIERSSPECIALIDENTIFIERS)z
id-classesrK )zatom-identifiersrK LITERALS)z
atom-literalsz=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALSTUPLES
TUPLELITERALS) exprlistszTUPLES LITERALSLISTS)ztypesseq-mutable LISTLITERALSr )listszLISTS LITERALS) typesmappingDICTIONARYLITERALSr )r5 zDICTIONARIES LITERALS
ATTRIBUTES)zattribute-referencesz(getattr hasattr setattr ATTRIBUTEMETHODS
SUBSCRIPTS)
subscriptionsr8 r )slicingsr8 CALLS)callsr )powerr r] )unaryr BINARY)binaryr SHIFTING)shiftingr r_ )bitwiser ) comparisonszEXPRESSIONS BASICMETHODS)booleanszEXPRESSIONS TRUTHVALUE ASSERTION
ASSIGNMENT)
assignmentr^ r^ ) augassignr DELETION RETURNING IMPORTING)compoundzfor while break continue)truthz if while and or not BASICMETHODS)debuggerpdb)zcontext-managersr ) CONDITIONALLOOPINGr5 DEBUGGINGCONTEXTMANAGERSNc " || _ || _ d S r )_input_output)r: inputr s r r zHelper.__init__ s r c ( | j p t j S r )r r r r@ s r r z Helper.input s {'ci'r c ( | j p t j S r )r r r r@ s r r z
Helper.output s |)sz)r c t j d d dk r | dS d| j j d| j j dS )NrT rj ?rK rD r z
instance>)r stackr+ r r r@ s r __repr__zHelper.__repr__ s\ =??1 a C ' ' DFFF2 ( &*^%>%>%>%)^%@%@%@B Br c 6 || j urM | | d S # t $ r(}| j | d Y d }~d S d }~ww xY w| | | j d d S )NrS a
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 r r r introinteract)r: requestes r __call__zHelper.__call__ s $- - -
, '"""""
,
,
, !!Q(((+++++++++
,
JJLLL MMOOO K
s "
A AAc | j d | d }|sd S n# t t f$ r Y d S w xY w| }t
| dk r6|d |d cxk rdv r n n |d |dd vr
|dd }| d v rd S |d
k r| n| | ) NrS Tzhelp> rU r r rF rT )r quitr )
r r getliner EOFErrorrV rW r+ r r )r: r s r r zHelper.interact s $ #
,,x00 %%%x0
mmooG G q WQZ72;%L%L%L%L*%L%L%L%L%L
'!B$-77!!B$-}}-//&
'"""# #s 7 A A c | j t j u rt | S | j | | j | j S )z.Read one line, using input() when appropriate.)r r r r r r r )r: prompts r r zHelper.getline s[ : " "== K f % % % K :&&(( (r Fc t |t rz| }|dk r| n|dk r| nf|dk r| nJ|dk r| n.|d d dk r.| | d n|| j v r| | n|dv r t t | d |
n|| j v r|
| n|| j v r|
| nq|rt |d | j | nVt t d | j | n8t |t r | nt |d | j | | j d d S )
Nkeywordssymbolstopicsr zmodules rT )r r r z Help on %s:r
)r r
rS )r. rD rV listkeywords listsymbols
listtopics listmodulesr r
showsymbolr= evalr showtopicr r r r r )r: r r
s r r z Helper.help s gs # # N mmooG*$$d&7&7&9&9&9&9I%%t'7'7'9'9'9'9H$$doo&7&7&7&7I%%t'7'7'9'9'9'9!
** !34444DL(($//'*B*B*B*B 555DMM=@@@@@DM))4>>'+B+B+B+BDK'' )@)@)@)@
N#g}T\RXYYYYYc= fMMMMM
(
( N$$&&&&'= fMMMM $ r c | j d dt j d d z 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 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 get a list of available
modules, keywords, symbols, or topics, enter "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",
enter "modules spam".
To quit this help utility and return to the interpreter,
enter "q" or "quit".
z%d.%drU )r r r* r r/ r@ s r r z Helper.intro sK F7S%bqb) )**! , , , , ,r r P c t t | }||z }t | |z dz
|z }t | D ]}t | D ]}||z |z }|t | k rb| j || ||dz
k r9| j dd|dz
t || z
z z | j d d S )NrT r rS )rz r rW ry r r ) r: itemscolumnsrl colwr{ rowr| r s r rz z Helper.list. s VE]]## E
W$q(W4;; $ $C W~~
R
R$J$s5zz>>K%%eAh///Wq[(( ))#tax#eAh--7O0P*PQQQ K d # # # # $ $r c | j d | | j d S )NzN
Here is a list of the Python keywords. Enter any keyword to get more help.
)r r rz r r~ r@ s r r zHelper.listkeywords; sI
$-$$&&'''''r c | j d | | j d S )Nzx
Here is a list of the punctuation symbols which Python assigns special meaning
to. Enter any symbol to get more help.
)r r rz r r~ r@ s r r zHelper.listsymbolsB sI
$,##%%&&&&&r c | j d | | j d S )NzN
Here is a list of available topics. Enter any topic name to get more help.
)r r rz r r~ r@ s r r zHelper.listtopicsJ sI
$+""$$%%%%%r c f dd l }n+# t $ r | j d Y d S w xY w| j || j | }|s,| j dt | z d S t | t d u r| || S |\ }} |j j | }n;# t $ r. | j dt | z Y d S w xY w| dz }|r
|pddz |z }|rbdd l }dd
| z dz } | | d }
|d
d
|
z z
}t! | d S ) Nr t
Sorry, topic and keyword documentation is not available because the
module "pydoc_data.topics" could not be found.
z no documentation found for %s
rK rS r Related help topics: r H z
%s
)pydoc_data.topicsr r r r r r r rC r KeyErrorrV textwraprX r wrapr ) r: topic
more_xrefs
pydoc_datatargetlabelxrefsr= r rf wrapped_texts r r zHelper.showtopicQ s $ $ $ $ $ K
FF
(9(9%(@(@AA K ?$u++ M N N N F <<488 # #>>&*55 5 u #*51CC K ?$u++ M N N N FF iikkD 5[bC'*4E 6 OOO*TYYu{{}}-E-EELD#==r22L 8dii 5 55 5C
c
s $//
C 4DDc \ ddl }n# t $ r Y dS w xY w| j || j | }|st d t
|t r| || S |\ }}|j j | }|r
|pddz |z }||fS )a* Return unbuffered tuple of (topic, xrefs).
If an error occurs here, the exception is caught and displayed by
the url handler.
This function duplicates the showtopic method but returns its
result directly so it can be formatted for display in an html page.
r N)r rK zcould not find topicrK r ) r r r r r r& r. rD _gettopic)r: r r r r r r r= s r r zHelper._gettopicq s
$ $ $ $ $
(9(9%(@(@AA 5 344 4 fc " " 6>>&*55 5 u &u- 5[bC'*4EEzs
c ~ | j | }| d \ }}}| || d S )Nr )r partitionr )r: symbolr r r r s r r zHelper.showsymbol sA f% **3//q% ue$$$$$r c |r>| j d | t | d S | j d i }|fdfd}t | | | | j d d S )Nzy
Here is a list of modules whose name or summary contains '{}'.
If there are any, enter a module name to get more help.
zI
Please wait a moment while I gather a list of all available modules...
c |r|dd dk r
|d d dz }| d dk rd||< d S d S )N .__init__ri r r rT )find)r
r\ rx r s r callbackz$Helper.listmodules.<locals>.callback s] :wrss|{ : : %crcl\ 9G<<$$q(('(GG$$$ )(r c " d | d d S r r )r\ r s r onerrorz#Helper.listmodules.<locals>.onerror s w-----r 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
ModuleScannerrunrz r~ )r: r r r r s @r r zHelper.listmodules s K F3KK
CLLLLL K
G6=
)
)
)
)
.
.
.
.
. OO ' : : : IIgllnn % % % K
r r )F)r r rM )!r) r r r _strprefixes_symbols_inverser r r symbols_r
r r r r/ r r r rA r r r r r r rz r r r r r r r r r r r r s $$$ $ y $
f $ .
$ $ $ '$ 4$ -$ $ &$ $ % $ %!$" 5#$ $$ .%$& '$( 3)$*
"+$, '-$.
'/$0
l1$2 )3$4 55$6 y7$8
i9$: ;$< (=$> )?$@ $A$B :C$D <E$ $F G$ $HN ML#7LLLL%e;l;;N? !B4
$
%
/
*
+
%
%
(
( G" ,1133 % %x % %F [[//FF"" # - $GFOO %
xU =U (U
A U 4
U (U =U ,U +U 1U IU N U 4 U >!U" H#U$ <%U& 'U( g)U U* )+U, 9-U. 1/U0 A1U2 -3U4 H5U6 .7U> ]?U@ mAUB 'CUD 4EUJ IKUL MMUN EOUP /QUT GUUV ,WU U UZ K[U\ W]U^ 3_U` <aUb ,cUd @eUf *gUh EiUj 0kUl 0mUn 8oUr +sUt 9uUv 5wUx 3yUz >{U| ?}U U U~ ZU@ :AUB 3CUD )EUF )GUH )IUJ +KUL /MUN -OUP AQUR 9SUT XUUV ;WUX =YUZ E[U\ X]U^ X_U U` ;C(7iU U UFn ( ( X( * * X*B B B VXXN - # # #*) ) ) *, , ,& $ $ $ $( ( (' ' '& & & @ 6% % %
r r c e Zd ZdZddZdS )r z7An interruptible scanner that searches module synopses.Nc |r| }d| _ i }t j D ]}|dk rd||< | |d |d t | j pd}| d d }|dz |z }| | dk r
|d || t j | D ]\ } }}
| j r n| |d |d ! t j
| | } n# t $ r Y Dw xY w| j } t | d r | | }
n # t $ r |r || Y w xY wt! t# j |
pd}t | d
r| | }n{d }nx t( j | }n # t. $ r |r || Y w xY w|j r |j d nd}t3 |d d }|dz |z }| | dk r
|||| |r | d S d S ) NF__main__rT rK rS r r r
get_source get_filenamer )r+ r r r r r@ r r r r _get_specr r r r r r r StringIOr r r r r r r )r: r r completerr seenr\ r# rx r r r r sourcer
r s r r zModuleScanner.run s !ciikk /
6
6G*$$ !W
; HT7B////%g..6<"D ::d++A.D"U?T1Dzz||((--22 w555(/(=g(N(N(N $ 2 $ 2 $Hguy
{w++++ ",Xw??DD" H 6<00 ;!!'!2!27!;!;$ ! ! !" - #GG , , , ! +2;v+>+>??E2D v~66 $ % 2 27 ; ; #!!*!5!;!;D!A!A& ! ! !" - #GG , , , ! >D^S6>4466q99QSD"6*T::D -::<<$$S))Q.. HT7D111 IKKKKK s6 2D
DD0EE E 0 GG+*G+rN )r) r r r@ r r r r r r s. AA8 8 8 8 8 8r r c d }d }t j 5 t j d t || | ddd dS # 1 swxY w Y dS )zAPrint all the one-line module summaries that contain a substring.c f |dd dk r
|d d dz }t ||od|z d S Nr
r ri z- )r
)r
r\ rx s r r zapropos.<locals>.callback sF 233<; & & crcl\1G
gt+t ,,,,,r c d S r r r\ s r r zapropos.<locals>.onerror s r ignorer N)warningscatch_warningsfilterwarningsr r )r r r s r r r s - - -
" " < < )))Hc7;;;< < < < < < < < < < < < < < < < < <s 9A A$'A$c j
ddl ddlddl ddl
G d dj j G fddj j G
fdd
j } || || }| |j s)|j
s"t j d |j s|j
"|S )
aA Start an HTTP server thread on a specific port.
Start an HTML/text server thread, so HTML or text documents can be
browsed dynamically and interactively with a web browser. Example use:
>>> import time
>>> import pydoc
Define a URL handler. To determine what the client is asking
for, check the URL and content_type.
Then get or generate some text or HTML code and return it.
>>> def my_url_handler(url, content_type):
... text = 'the URL sent was: (%s, %s)' % (url, content_type)
... return text
Start server thread on port 0.
If you use port 0, the server will pick a random port number.
You can then use serverthread.port to get the port number.
>>> port = 0
>>> serverthread = pydoc._start_server(my_url_handler, port)
Check that the server is really started. If it is, open browser
and get first page. Use serverthread.url as the starting page.
>>> if serverthread.serving:
... import webbrowser
The next two lines are commented out so a browser doesn't open if
doctest is run on this module.
#... webbrowser.open(serverthread.url)
#True
Let the server do its thing. We just need to monitor its status.
Use time.sleep so the loop doesn't hog the CPU.
>>> starttime = time.monotonic()
>>> timeout = 1 #seconds
This is a short timeout for testing purposes.
>>> while serverthread.serving:
... time.sleep(.01)
... if serverthread.serving and time.monotonic() - starttime > timeout:
... serverthread.stop()
... break
Print any errors that may have occurred.
>>> print(serverthread.error)
None
r Nc e Zd Zd Zd ZdS )!_start_server.<locals>.DocHandlerc T | j d rd}nd}| d | dd|z | | j | | j | d dS ) zProcess a request from an HTML browser.
The URL received is in self.path.
Get an HTML page from self.urlhandler and send it.
z.csstext/css text/html z Content-Typez%s; charset=UTF-8r N) r
r
send_response send_header end_headerswfiler
urlhandlerr )r: content_types r do_GETz(_start_server.<locals>.DocHandler.do_GET9 s y!!&))
+ ) * s # # # ^-@<-O P P P J T__ < ) ))/
:
:
:
:
:r c d S r r )r: r s r log_messagez-_start_server.<locals>.DocHandler.log_messageI s Dr N)r) r r r: r< r r r
DocHandlerr/ 7 s2 : : : r r= c & e Zd Zd Z fdZd ZdS ) _start_server.<locals>.DocServerc || _ | j |f| _ || _ | j | | j | j d| _ d S NF)hostaddressr r< r handlerr )r: rB portr s r r z)_start_server.<locals>.DocServer.__init__O sG DI It,DL $DM I tT\4< @ @ @ DIIIr c | j sQ | j gg g d \ }}}|r| | j Q| d S ry )r selectsocketr handle_request server_close)r: rdwrexrG s r serve_until_quitz1_start_server.<locals>.DocServer.serve_until_quitV s{ i
* #]]DK,>,>,@,@+A2r1 M M
B *''))) i
*
r c v | j | | j r| | d S d S r )r< server_activater r@ s r rP z0_start_server.<locals>.DocServer.server_activate] sD I % %d + + +}
$
d#####
$
$r N)r) r r r rN rP )rG s r DocServerr? M sL $ $ $ $ $r rQ c 6 e Zd ZfdZ fdZd Zd ZdS )#_start_server.<locals>.ServerThreadc || _ || _ t | | _ j | d| _ d | _ d S rA )r8 rB r rE Threadr servingerror)r: r8 rB rE threadings r r z,_start_server.<locals>.ServerThread.__init__d sG (DO DID DI % %d + + + DL DJJJr c : j j _ _ j j _ t | j _ | j | j
| j }|| _ |
dS # t $ r}|| _ Y d}~dS d}~ww xY w)zStart the server.N)server
HTTPServerr< rD r Message MessageClass staticmethodr8 rB rE ready docserverrN r rW )r: docsvrr r= rQ emailhttps r r z'_start_server.<locals>.ServerThread.runl s
!%!7 $. !*/-*?
'(4T_(E(E
%"49diDD!''')))))
s A9A> >
BBBc p d| _ |j | _ |j | _ d| j | j fz | _ d S )NTz
http://%s:%d/)rV rB server_portrE r )r: rZ s r r_ z)_start_server.<locals>.ServerThread.readyy s5 DL DI *DI&$)TY)??DHHHr c p d| j _ | d| _ d| _ d| _ dS )z&Stop the server and this thread nicelyTNF)r` r rX rV r r@ s r stopz(_start_server.<locals>.ServerThread.stop s4 "&DN IIKKK "DN DLDHHHr N)r) r r r r r_ rg )r= rQ rb rc rX s r ServerThreadrS b sw @ @ @ r rh g{Gz?)
http.server
email.messagerG rX rZ BaseHTTPRequestHandlerr[ rU r rW rV timesleep) r8 hostnamerE rh threadr= rQ rb rc rG rX s @@@@@@r
_start_serverrp sJ p MMM T[7 ,$ $ $ $ $ $ $DK* $ $ $*% % % % % % % % % % % y' % % % N \*h
5
5F
LLNNN l 6>
3 l 6> Mr r2 c
G fddt } | fd fd
fd
fdfd fdfd fd
fd }| d r
| d
d } |dk rt j t j t }t j || }t | 5 }d | cddd S # 1 swxY w Y n|dk r || S t d|d| )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 e Zd Z fdZdS ) _url_handler.<locals>._HTMLDocc @ d}d|z }d|d|d d|d S )ra zpydoc_data/_pydoc.cssz1<link rel="stylesheet" type="text/css" href="%s">zH<!DOCTYPE>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Pydoc: z </title>
z
</head><body>z*<div style="clear:both;padding-top:.5em;">z</div>
</body></html>r )r: rb rc css_pathcss_link html_navbars r rd z#_url_handler.<locals>._HTMLDoc.page sE .HC
H UUHHHkkmmmmXXX?
?r N)r) r r rd )rw s r _HTMLDocrs s.
?
?
?
?
?
?
?r rx c t j dt j d dt j d } d| d t j d d S )
Nz [r r rj z=
<div style='float:left'>
Python <br>T)tersea
</div>
<div style='float:right'>
<div style='text-align:center'>
<a href="index.html">Module Index</a>
: <a href="topics.html">Topics</a>
: <a href="keywords.html">Keywords</a>
</div>
<div>
<form action="get" style='display:inline;'>
<input type=text name=key size=15>
<input type=submit value="Get">
</form>
<form action="search" style='display:inline;'>
<input type=text name=key size=15>
<input type=submit value="Search">
</form>
</div>
</div>
)rG r python_version python_buildpython_compiler)r r s r rw z!_url_handler.<locals>.html_navbar s ++x/F/H/H/H/H/7/D/F/Fq/I/I/I/7/G/I/I/I/I K L L0 77DKK(9(E(E(E F F F F+H Hr c d } d }d t j D } || }|d dd| z g}i }t j D ]+}| || ,| d dd | fS )
zModule Index page.c d| d| dS Nr r r r r# s r bltinlinkz3_url_handler.<locals>.html_index.<locals>.bltinlink 15ttt< <r z/<strong class="title">Index of Modules</strong>c g | ]
}|d k | S )r r )r r# s r r z4_url_handler.<locals>.html_index.<locals>.<listcomp> s, ( ( ($J&& &&&r z<p>zBuilt-in Modulesr zf<p align=right class="heading-text grey"><strong>pydoc</strong> by Ka-Ping Yee<ping@lfw.org></p>zIndex of ModulesrK ) rh r r r} rr r
r r rX )r rh namesrc r" r r s r
html_indexz _url_handler.<locals>.html_index s = = = ,, =
( (#": ( ( (##E955UT__ &3 &3 3 4 8 3 3C OODJJsD 1 1 2 2 2 2
' ( ( ( "2778#4#444r c g fd}t j 5 t j d d }t || | ddd n # 1 swxY w Y d }g }
d } D ]&\ }}| || |z '|
d| z d d
| z }d |fS ) zSearch results page.c v |dd dk r
|d d dz } ||od|z f d S r& r )r
r\ rx
search_results r r z3_url_handler.<locals>.html_search.<locals>.callback sP rss|{**!#2#, 5 '4+?D4K!@ A A A A Ar r) c d S r r r( s r r z2_url_handler.<locals>.html_search.<locals>.onerror s r r Nc d| d| dS r r r s r r z4_url_handler.<locals>.html_search.<locals>.bltinlink r r z-<strong class="title">Search Results</strong>zkey = %sr rz zSearch Results) r* r+ r, r r rh r rr rX ) r r r r r rh r# rx rc r r s @r html_searchz!_url_handler.<locals>.html_search s
B B B B B
$
&
& @ @ #H - - -
OO #w ? ? ? @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ = = = ,, ;
( 3 3JD$ NN99T??T1 2 2 2 2T__ gv{{7';'; = = = ))s <A%%A),A)c d } d }t t j } || }| dd| z }d|fS )z Index of topic texts available.c d| d| dS Nz<a href="topic?key=r r r r s r r z4_url_handler.<locals>.html_topics.<locals>.bltinlink
6:ddDDDA Ar $<strong class="title">INDEX</strong>Topicsr )rh r r r r~ r} rr )r rh r rc r s r html_topicsz!_url_handler.<locals>.html_topics
s B B B ,, 2
v}))++,,##E955T__ gx ) ) )!!r c d } t t j }d } || }| dd| z }d|fS )zIndex of keywords.r c d| d| dS r r r s r r z6_url_handler.<locals>.html_keywords.<locals>.bltinlink
r r Keywordsr )rh r r r r~ r} rr )rh r r rc r s r
html_keywordsz#_url_handler.<locals>.html_keywords
s ,, 2
v++--.. B B B ##E955T__ + + +8##r c t j }t || }| | \ }}| |j v rd}nd} d|z }d | z } | d| }|rQt | }d }
|| } dd| }|d| d |||f fS )
zTopic or keyword help page.KEYWORDTOPICr z
<pre>%s</pre>r c d| d| dS r r r s r r z7_url_handler.<locals>.html_topicpage.<locals>.bltinlink0
s :>$$EEr r r rK )
r r r r r rh r rr r r r} rp rX ) r bufhtmlhelprc r rb rh r r s r html_topicpagez$_url_handler.<locals>.html_topicpage
s! kmm#s##",,U33% H% % % EEE,, /% 7
#T[[%:%::??57H== J5;;==))E
F
F
F $$UI66ELL!8'5IIE 55%%((E2335 5r c t | d }|| dk rt d t | } || }||fS )NrT )r r zcould not find object)r r& r r )r r9 rb contentr s r html_getobjz!_url_handler.<locals>.html_getobj8
sY SA&&& ;3&== 455 5
--S))g~ r c d }d fdt t | | D }| | d| z }d| z |fS )Nz$<strong class="title">Error</strong>rz c 3 B K | ]} | V d S r )rG )r r r s r rK z3_url_handler.<locals>.html_error.<locals>.<genexpr>D
sG F FTt{{4 0 0 F F F F F Fr rW z
Error - %s)rh rX r rC rr )r r rh rc r s r
html_errorz _url_handler.<locals>.html_error@
s ,, 2
;; F F F F 4T#YY D D F F F F FT__S'8 D DDc!8++r c | }| d r
| dd } | dv r
\ }}n| dk r \ }}n| dk r \ }}nd| v r| d \ }}} |dk r | \ }}n|d k r.
| \ }}n# t $ r | \ }}Y ngw xY w|d
k r@| dv r
\ }}nK | \ }}n;# t $ r
| \ }}Y n!w xY wt d | \ }}n&# t $ r} || \ }}Y d}~nd}~ww xY w || S ) z Generate an HTML page for url.r' N)rK r r r r0 z
search?keyz topic?keyzget?keyz
bad pydoc url)r r r& r rd )r complete_urlrb r opr r r r r r r r r r s r
get_html_pagez#_url_handler.<locals>.get_html_pageI
s << crc(C ;m##!+ ww !, ww
""!. ww ]]3 / /
As %%%0[%5%5NE77;&&:)7 )<)<ww% : : :)4S)9)9www:9__m++)3 wwA-8[-=-=NE77 ) A A A-;^C-@-@NE777A %_555!,S!1!1w ; ; ; 'Z c : :NE777777 ; yy(((s` A2D( B& %D( &C>D( CD( C, +D( ,DD( D D( (
E 2EE r& rT Nr1 rK r2 zunknown content type z for url ) r_ r r r
dirnamerealpathr rX r readlinesrG )r r9 rx r path_hereru fpr r r r r rw r r r s @@@@@@@@@r _url_handlerr sq ? ? ? ? ? ? ?7 ? ? ?$ 8::DH H H H H65 5 5 5 50 * * * * *<" " " " "
$
$
$
$
$ 5 5 5 5 52 , , , , ,&) &) &) &) &) &) &) &) &) &) &) &)P ~~c !""gz!!GOOBG$4$4X$>$>?? 7<< 3//
(^^ +r772<<>>** + + + + + + + + + + + + + + + + + $ $ }S!!!
)LLL##N
O
OOs 2'D&&D*-D*T localhost) open_browserrn c ddl }t t || }|j rt |j dS |j r/d}|r| |j t d|j t | |j rat d }| }|dk rn7|dk r| |j nt | |j an%# t t f$ r t Y nw xY w|j r%| t d dS dS # |j r$| t d w w xY wdS ) 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)
webbrowserrp r rW r
rV r r r r+ r r rg )rE r rn r serverthreadserver_help_msgr s r browser ~
s x>>L
l !!! (> . OOL , - - - ( #\%5 6 6 6 / " " " &
+J''iikk#::CZZ OOL$45555/*** &
+ "8, GGGGG #
( !!###&'''''
(
(|#
( !!###&''''
('( (s+ B C, +D? , D D?
DD? ?-E,c r t | t o"| t j dk S r )r. rD r r sep)r s r ispathr
s( a 5!&&..A"55r c d| v s#t j | v st j | v rdS t j t
}t j | }| }|| v r5t j || s| | | dt j |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.
rK Nr )
r curdirgetcwdr
r r copysamefileremoveinsert)
given_pathargv0
stdlib_dir
script_dir revised_paths r _get_revised_pathr
s
Z29
22bikkZ6O6Ot **J ''J ??$$LZ (8(8Z(P(P J'''29;;''' r c t t j t j d } | | t j dd< 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 s r _adjust_cli_sys_pathr
s<
%SXsx{;;L " r c 0 ddl } G d dt }t | t j dd d \ }}d}d}d}d}d}|D ]C\ } }
| d k rd
}d
}| d k rt |
dS | d k rd
}|
}| d
k rd
}| dk rd
}|
}D|rt
||| dS |s||D ]C} t | rEt j
| s&t d| z t j d t | r.t j
| rt | } |rNt | r/t j | rt! | n,t# | n t$ | d
# t& t( f$ r.} t | t j d Y d} ~ =d} ~ ww xY wdS # | j |f$ r t j t j t j d d }
t d |
t j Y dS w xY w)z@Command-line interface (looks at sys.argv to decide what to do).r Nc e Zd ZdS )cli.<locals>.BadUsageN)r) r r r r r BadUsager
s r r rT zbk:n:p:wFr z-bTz-kz-pz-wz-n)rn r zfile %r does not existr a pydoc - the Python documentation tool
{cmd} <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 '{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 <keyword>
Search for a keyword in the synopsis lines of all available modules.
{cmd} -n <hostname>
Start an HTTP server with the given hostname (default: localhost).
{cmd} -p <port>
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 <name> ...
Write out the HTML documentation for a module to a file in the current
directory. If <name> 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
exitr r r r r r r r rW r r r* r )r r optsr writing start_serverr rE rn optvalargr r s r clir
s MMM#####9###M!]]38ABB<<<
d HCd{{ # # d{{ d{{ # d{{ d{{ # 4( F F F F F#8^ Cc{{
27>>##6#6
.4555
#;; *27>>##6#6 *$S//C 0 c{{ &rw}}S'9'9 &!#
IIc$I/// !23
e
$
L( # ! ! !g rw / / < <==a@
: FsF ; ! ! ! ! ! ! !sK A H 1H 8A H B)G?H H #G;5H ;H H B JJr r )r )r r N)r r NF)rK N)r2 )br@ r r r r r r$ importlib._bootstrapr importlib._bootstrap_externalimportlib.machineryimportlib.utilr r r r r rM r r1 rl r urllib.parser r* collectionsr reprlibr tracebackr r r$ r> r7 rI rQ rZ r] rd rh rp r
IGNORECASErr rt rw r} r ru all_feature_namesr r r r r r r r r r r r r4 r_ rQ rW r r r r r r r r r r r rf r r r r r= r r r r r r rp r r r r r r r) r r r <module>r sp % %L (
)
$ $ $ $
+ + + + + +
1 1 1f
! ! ! A A A
G G G bj5r}EE ( ( (
" J 899 ( ( ( (0
" % % % %NK K K K K K K K6 6 6$ ! , , , ,`6 6 6 6 6 6 6 6t( ( ( ( ( t ( ( ( Tn7 n7 n7 n7 n7c n7 n7 n7d : : : : :t : : :@@ @ @ @ @c @ @ @D G " " " H# # # 0
/
/
/F F F
*2 *2 *2X2 2 2 6 * wyy MOO wyy > > > > KLC C C C6 DE ! "# # # # W W W W W W W Wr vxx; ; ; ; ; ; ; ;z
<
<
< U U UpiP iP iP iPX (4+ ( ( ( ( (J6 6 6 8# # #T! T! T!l zCEEEEE r 
Browse
Usage
Versions