Current File : //opt/rh/rh-python35/root/lib64/python3.5/__pycache__/pydoc.cpython-35.pyc
���\7� � @ s: d Z d g Z d Z d Z d Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z d
d � Z d d
� Z d d � Z d d � Z d d � Z! d d � Z" d d � Z# e j$ d e j% � Z& d d � Z' d d � Z( d d � Z) d d � Z* d! d" � Z+ d d d# d$ � Z, d% d& � Z- d' d( � Z. d) d* � Z/ i d+ d, � Z0 Gd- d. � d. e1 � Z2 d/ d0 � Z3 d i d1 d2 � Z4 Gd3 d4 � d4 � Z5 Gd5 d6 � d6 e � Z6 Gd7 d8 � d8 e5 � Z7 Gd9 d: � d: e � Z8 Gd; d< � d< e5 � Z9 Gd= d> � d> e9 � Z: d? d@ � a; dA dB � Z< dC dD � Z= dE dF � Z> dG dH � Z? dI dJ � Z@ dK dL � ZA dM dN � ZB dO dP � ZC d dQ dR � ZD e9 � ZE e: � ZF e7 � ZG d dS dT � ZH dU d d dV dW � ZI dU d d dX dY � ZJ d dZ d[ � ZK d\ d d] d^ � ZL Gd_ d` � d` � ZM eM � ZN Gda db � db � ZO dc dd � ZP de df � ZQ dg dh di � ZR d dj dk dl dm �ZS dn do � ZT dp dq � ZU eV dr k r6eU � d S)sa� 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 -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. The -p option
can be used with the -b option to explicitly specify the server port.
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://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 2001z�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)�deque)�Repr)�format_exception_onlyc C s� g } g } xs t j D]h } t j j | p. d � } t j j | � } | | k r t j j | � r | j | � | j | � q W| S)zAConvert sys.path into a list of absolute, existing, unique paths.�.)�sys�path�os�abspath�normcase�isdir�append)�dirsZnormdirs�dirZnormdir� r �5/opt/rh/rh-python35/root/usr/lib64/python3.5/pydoc.py�pathdirsM s
r c C sC t j | � p t j | � } | r? t j d d | j � � pB d S)z-Get the doc string or comments for an object.z^ *
� )�inspect�getdocZ getcomments�re�sub�rstrip)�object�resultr r r r Y s r c C s� | j � j d � } t | � d k r5 | d d f St | � d k ry | d j � ry | d d j | d d � � f Sd d j | � f S)z>Split a doc string into a synopsis line (if any) and the rest.�
� r r � N)�strip�split�lenr �join)�doc�linesr r r �splitdoc^ s #!r$ c C s- | j } | j | k r) | j d | } | S)z@Get a class name and qualify it with a module name if necessary.r )�__name__�
__module__)r �modname�namer r r � classnameg s r) c C sY t j | � pW t j | � pW t j | � pW t j | � pW t j | � pW t j | � S)z>Check if an object is of a type that probably means it's data.)r �ismodule�isclass� isroutineZisframeZ istracebackZiscode)r r r r �isdatan s r- c G sA x: | r< | d j | j | d � � } | d d � } q W| S)z/Do a series of global replacements on a string.r r r N)r! r )�textZpairsr r r �replacet s r/ c C sn t | � | k rj t d | d d � } t d | d | � } | d | � d | t | � | d � S| S)zCOmit part of a string if needed to make it fit in a maximum length.r � r Nz...)r �max)r. �maxlenZpreZpostr r r �cram{ s
*r3 z at 0x[0-9a-f]{6,16}(>+)$c C s t j d | � S)z>Remove the hexadecimal id from a Python object representation.z\1)� _re_stripidr )r. r r r �stripid� s r5 c C s: t j | � p9 t j | � p9 t j | � p9 t j | � S)N)r �
isfunction�ismethod� isbuiltinZismethoddescriptor)�objr r r �_is_some_method� s r: c C sR t j | � r d St j | � rN t | d d � } t j | � pL | d k Sd S)zo
Returns True if fn is a bound method, regardless of whether
fn was implemented in Python or in C.
T�__self__NF)r r7 r8 �getattrr* )�fn�selfr r r �_is_bound_method� s r? c C s� i } x* t j | t � D] \ } } d | | <q Wx$ | j D] } | j t | � � q= Wx' | j � D] } t | | � | | <qg W| S)Nr )r �
getmembersr: � __bases__�update�
allmethods�keysr< )�cl�methods�key�value�baser r r rC � s rC c C sP g } g } x7 | D]/ } | | � r5 | j | � q | j | � q W| | f S)z�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)])
)r
)�s� predicate�yes�no�xr r r � _split_list� s
rO c C s| | d k r d S| j d � r2 | j d � r2 d S| j d � rT t | d � rT d S| d k rj | | k S| j d � Sd S)z3Decide whether to show documentation on a variable.�
__author__� __builtins__�
__cached__� __credits__�__date__�__doc__�__file__�__spec__�
__loader__r& r% � __package__�__path__� __qualname__� __slots__� __version__r �__r �_�_fieldsTN> �
__cached__�__doc__�
__author__�
__loader__� __package__�__date__�__file__� __qualname__� __credits__�__spec__� __version__�
__module__� __slots__�__name__� __builtins__�__path__)�
startswith�endswith�hasattr)r( �allr9 r r r � visiblename� s
ru c C s^ g } xQ t j | � D]@ \ } } } } t j | � r= d } | j | | | | f � q W| S)zCWrap inspect.classify_class_attrs, with fixup for data descriptors.zdata descriptor)r �classify_class_attrs�isdatadescriptorr
)r �resultsr( �kind�clsrH r r r rv � s " rv c C sP t j j | � rL x7 d D]/ } t j j t j j | d | � � r d Sq Wd S)z3Guess whether a path refers to a package directory.�.py�.pyc�__init__TF)r{ r| )r r r �isfiler! )r �extr r r � ispackage� s
%r� c C s | j � } x: | d d � d k s2 | j � rH | j � } | s Pq W| j � } | d d � d k r{ | d d � } | d d � d k r | d d � } | d d � d k r� | d d
� } x# | j � s� | j � } | s� Pq� W| j d � d j � } n d } | S) Nr �#� zr"""r0 z"""�\r ���r� )�readliner r )�file�liner r r r �source_synopsis� s& & r� c
C s� t j | � j } | j | d � \ } } | d k sB | | k r|| j t t j j � � rl t j j } n0 | j t t j j
� � r� t j j } n d } | d k r� y t j
| � } Wn t k
r� d SYn X| � t | � } Wd QRXn{ | d | � } t j j d | d | �} y t j j | � } Wn d SYn Xt j d =| j rf| j j � d n d } | | f | | <| S)z.Get the one-line summary out of a module file.NZ__temp__�loaderr )NN)r �stat�st_mtime�getrr �tuple� importlib� machinery�BYTECODE_SUFFIXES�SourcelessFileLoader�EXTENSION_SUFFIXES�ExtensionFileLoader�tokenize�open�OSErrorr� �util�spec_from_file_location�
_bootstrap�_loadr �modulesrU �
splitlines)
�filename�cache�mtimeZ
lastupdater Z
loader_clsr� r� �spec�moduler r r �synopsis� s4
"r� c @ s. e Z d Z d Z d d � Z d d � Z d S)�ErrorDuringImportzEErrors that occurred while trying to import something to document it.c C s% | | _ | \ | _ | _ | _ d S)N)r� �excrH �tb)r> r� �exc_infor r r r} s zErrorDuringImport.__init__c C s# | j j } d | j | | j f S)Nzproblem in %s - %s: %s)r� r% r� rH )r> r� r r r �__str__ s zErrorDuringImport.__str__N)r% r& r[ rU r} r� r r r r r� s r� c C s� t j j } t | d � �" } | | j t | � � k } Wd QRXt j j | � } t j j | � \ } } | r� t j
j | | � } n t j
j | | � } t j j
| | d | �} y t j j | � SWn t | t j � � � Yn Xd S)z<Import a Python source file or compiled file given its path.�rbNr� )r� r� � MAGIC_NUMBERr� �readr r r �basename�splitext�_bootstrap_externalr� �SourceFileLoaderr� r� r� r� r r� ) r �magicr� Z is_bytecoder� r( r r� r� r r r �
importfile s "r� c s{ y� | rv � t j k rv � t j k rv � f d d � t j D� } x0 � g | D]! } t j | | | <t j | =qQ Wt � � } Wn� t j � \ } } } } � t j k r� t t j � j | � � nU | t k r� t | j | � � n4 | t k r
| j
� k r
d St � t j � � � Yn XxM � j d � d d � D]2 }
y t | |
� } WqAt
k
rrd SYqAXqAW| 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 s) g | ] } | j � d � r | � q S)r )rq )�.0�m)r r r �
<listcomp>F s z safeimport.<locals>.<listcomp>Nr r )r r� �builtin_module_names�
__import__r� r� rV � SyntaxErrorr� � ImportErrorr( r r< �AttributeError) r � forceloadr� ZsubsrG r� r� rH r� �info�partr )r r �
safeimport2 s.
r� c @ sz e Z d Z e j j d d e j d d � � Z d d d � Z d d d � Z
e
Z Z Z
Z Z Z d d
� Z d S) �Doc�
PYTHONDOCSz$http://docs.python.org/%d.%d/libraryNr c G s� | | f | } t j | � r, | j | � St j | � rH | j | � SyX t j | � rg | j | � St j | � r� | j | � St j | � r� | j | � SWn t
k
r� Yn Xt | t � r� | j
| � S| j | � S)z%Generate documentation for an object.)r �isgetsetdescriptor�docdata�ismemberdescriptorr* � docmoduler+ �docclassr, �
docroutiner� �
isinstance�property� docproperty�docother)r> r r( �argsr r r �documenth s"
z Doc.documentc G s9 d | o d t | � t | � j f } t | � � d S)z+Raise an exception for unimplemented types.z.don't know how to document object%s of type %s� N)�repr�typer% � TypeError)r> r r( r� �messager r r �failz s &zDoc.failc C s* y t j | � } Wn t k
r- d } Yn Xt j j d | j � } t j j t j
d d t j d d � � } t | t
t � � r | j d k s� | j | � r | j t j j | d � � r | j d k r | j d � rd | j d � | j f } q&t j j | | j d � } n d } | S)z*Return the location of module docs or Nonez
(built-in)r� �libz python%d.%dNr �errno�
exceptions�gc�imp�marshal�posix�signalr �_thread� zipimportz
site-packages� xml.etree�test.pydoc_modzhttp://z%s/%s�/z.html)
zerrnoz
exceptionszgcr� zmarshalzposixzsignalzsysz_threadr� )r� r� )r �
getabsfiler� r �environr� r� r r! r �base_exec_prefix� version_infor� r� r% rq r )r> r r� �doclocZbasedirr r r � getdocloc� s&
z
Doc.getdocloc)r% r& r[ r r� r� r r� r� r� r� r� r� r� r� r� r� r� r r r r r� b s r� c @ sj e Z d Z d Z d d � Z d d � Z d d � Z d d � Z d
d � Z e Z d d
� Z
e Z d S)�HTMLReprzBClass for safely making an HTML representation of a Python object.c C s: t j | � d | _ | _ d | _ d | _ | _ d S)N� �
�d )r r} �maxlist�maxtuple�maxdict� maxstring�maxother)r> r r r r} � s
zHTMLRepr.__init__c C s t | d d d d d d � S)N�&z&�<z<�>z>)r/ )r> r. r r r �escape� s zHTMLRepr.escapec C s t j | | � S)N)r r� )r> r r r r r� � s z
HTMLRepr.reprc C s� t t | � d � r\ d d j t | � j j � � } t | | � r\ t | | � | | � S| j t t t | � � | j
� � S)Nr% �repr_r_ ) rs r� r! r% r r< r� r3 r5 r� r� )r> rN �level�
methodnamer r r �repr1� s
"zHTMLRepr.repr1c C s t | | j � } t | � } d | k rc d t | d d � k rc d | d | j | � | d St j d d | j | � � S)Nr� z\\r �rr z-((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)z <font color="#c040c0">\1</font>)r3 r� r� r/ r� r r )r> rN r� �test�testreprr r r � repr_string� s $! zHTMLRepr.repr_stringc C sO y) | j t t t | � � | j � � SWn | j d | j j � SYn Xd S)Nz
<%s instance>)r� r3 r5 r� r� � __class__r% )r> rN r� r r r �
repr_instance� s )zHTMLRepr.repr_instanceN) r% r& r[ rU r} r� r� r� r� �repr_strr� Z repr_unicoder r r r r� � s r� c @ s� e Z d Z d Z e � Z e j Z e j Z d d � Z d d d � Z d d d d d
d � Z
d d
� Z d d � Z d d d � Z
d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d i i i d d � Z d d! d" � Z d d d# d$ � Z d d i i d% d& � Z d' d( � Z d d i i i d d) d* � Z d+ d, � Z d d d d- d. � Z d d d/ d0 � Z d d d d1 d2 � Z d d3 d4 � Z d S)5�HTMLDocz'Formatter class for HTML documentation.c C s d | | f S)zFormat an HTML page.z�<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: %s</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
%s
</body></html>r )r> �title�contentsr r r �page� s z HTMLDoc.pager c C s d | | | | | p d f S)zFormat a page heading.a'
<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>
z r )r> r� �fgcol�bgcolZextrasr r r �heading� s zHTMLDoc.heading� Nz c
C sw | d k r d d | d } d | | | f } | rT | d | | | | f } n | d | | | f } | d | S) z Format a section with a heading.Nz<tt>z z</tt>z�<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>
zR
<tr bgcolor="%s"><td rowspan=2>%s</td>
<td colspan=2>%s</td></tr>
<tr><td>%s</td>z(
<tr><td bgcolor="%s">%s</td><td>%s</td>z'
<td width="100%%">%s</td></tr></table>r )
r> r� r r r� �widthZpreludeZ
marginaliaZgapr r r r �section� s zHTMLDoc.sectionc G s d | } | j | | � S)z$Format a section with a big heading.z <big><strong>%s</strong></big>)r )r> r� r� r r r �
bigsection� s
zHTMLDoc.bigsectionc
C s7 | j | j � � } t | d d d d d d d d � S)z!Format literal preformatted text.z
z
r� z r z<br>
)r� �
expandtabsr/ )r> r. r r r � preformat s zHTMLDoc.preformatr� c C s� d } t | � | d | } x� t | � D]r } | d d | } xM t | | | | | � D]0 } | t | � k r_ | | | | � d } q_ W| d } q+ Wd | S)z0Format a list of items into a multi-column list.r r z <td width="%d%%" valign=top>r� z<br>
z</td>z7<table width="100%%" summary="list"><tr>%s</tr></table>)r �range)r> �list�formatZcolsr �rows�col�ir r r � multicolumn s " zHTMLDoc.multicolumnc C s d | S)Nz <font color="#909090">%s</font>r )r> r. r r r �grey s z HTMLDoc.greyc G s3 x, | D]$ } | | k r d | | | f Sq W| S)z:Make a link for an identifier, given name-to-URL mappings.z<a href="%s">%s</a>r )r> r( Zdicts�dictr r r �namelink s
zHTMLDoc.namelinkc C sm | j t j j | j � } } t | | � r` t | | � | k r` d | j | t | | � f St | | � S)zMake a link for a class.z<a href="%s.html#%s">%s</a>)r% r r� r� r& rs r< r) )r> r r' r( r� r r r � classlink s
$zHTMLDoc.classlinkc C s d | j | j f S)zMake a link for a module.z<a href="%s.html">%s</a>)r% )r> r r r r �
modulelink% s zHTMLDoc.modulelinkc C so | \ } } } } | r% | j | � S| r> d | | f } n
d | } | r[ d | } n | } d | | f S)z;Make a link for a module or package to display in an index.z
%s.%s.htmlz%s.htmlz"<strong>%s</strong> (package)z<a href="%s">%s</a>)r )r> Z
modpkginfor( r r� �shadowed�urlr. r r r �
modpkglink) s
zHTMLDoc.modpkglinkc C s d | | f S)zMake a link to source file.z<a href="file:%s">%s</a>r )r> r r r r r �filelink8 s zHTMLDoc.filelinkc C s | p | j } g } d } t j d � } x�| j | | � } | sF P| j � \ }
} | j | | | |
� � � | j � \ } }
} } } } |
r� | | � j d d � } | j d | | f � n| rd t | � } | j d | | | � f � n� | r7d t | � } | j d | | | � f � n� | r�| | | d � d k rw| j d
| j | | � � q�| j d | � nU | | | d � d k r�| j | j | | | | � � n | j | j | | � � | } q- W| j | | | d � � � d
j
| � S)z�Mark up some plain text, given a context of symbols to look for.
Each context dictionary maps object names to anchor names.r zD\b((http|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?(\w+))�"z"z<a href="%s">%s</a>z'http://www.rfc-editor.org/rfc/rfc%d.txtz(http://www.python.org/dev/peps/pep-%04d/r �(zself.zself.<strong>%s</strong>Nr ) r� r �compile�search�spanr
�groupsr/ �intr r! )r> r. r� �funcs�classesrF rx �here�pattern�match�start�endrt �schemeZrfcZpepZselfdotr( r r r r �markup< s< "
zHTMLDoc.markupc
C s d } x� | D]� } t | � t f � k r� | \ } } | d } | | j | | � } | r� | | f k r� g } x' | D] } | j | j | | � � qy W| d d j | � d } | d } q
t | � t g � k r
| d | j | | | � } q
Wd | S) zAProduce HTML for a class tree as given by inspect.getclasstree().r z"<dt><font face="helvetica, arial">r z, �)z
</font></dt>z
<dd>
%s</dd>
z
<dl>
%s</dl>
)r� r r
r! �
formattree)
r> �treer' �parentr �entry�c�bases�parentsrI r r r r* g s
zHTMLDoc.formattreec # s� | j } y
| j } Wn t k
r0 d } Yn X| j d � } g } xP t t | � d � D]8 } | j d d j | d | d � � | | f � q] Wd j | | d. d � � } d | }
y7 t j | � } t
j j | � } � j
| | � }
Wn t k
rd }
Yn Xg } t | d � r�t | j � } | d d � d/ k rx| d0 d � d k rx| d d1 � j � } | j d � j | � � t | d � r�| j � j t | j � � � | r�|
d
d j | � }
� j | � } | d k rd t � } n d } � j |
d d d |
| � } t j | t j � } g i } } x� t j | t j � D]n \ } } | d k s�t j | � p�| | k rft | | | � rf| j | | f � d | | | <| | <qfWx� | D]� \ } } x� | j D]� } | j | j } } t j j! | � } | | k r�| r�t | | � r�t" | | � | k r�| | k r�| d | | | <| | <q�Wq�Wg i } } x� t j | t j# � D]� \ } } | d k s�t j$ | � s�t j | � | k r�t | | | � r�| j | | f � d | | | <t j% | � r�| | | | <q�Wg } xE t j | t& � D]1 \ } } t | | | � rP| j | | f � qPW� j' t( | � � j) | | � } | o�d | } | d | } t | d � rVg } x< t* j+ | j, � D]( \ } } } | j | | | d f � q�W| j- � � j. | � j/ � }! | � j0 d d d |! � } n@ | r�� j. | � f d d � � }! | � j0 d d d |! � } | r.d d! � | D� }" � j1 t j2 |" d � | � g }! x6 | D]. \ } } |! j � j3 | | | | | � � q�W| � j0 d" d d# d$ j |! � � } | r�g }! x6 | D]. \ } } |! j � j3 | | | | | � � qAW| � j0 d% d d& d$ j |! � � } | r�g }! x- | D]% \ } } |! j � j3 | | � � q�W| � j0 d' d d( d) j |! � � } t | d* � rB� j' t | j4 � � j) � }! | � j0 d+ d d |! � } t | d, � r�� j' t | j5 � � j) � }! | � j0 d- d d |! � } | S)2z/Produce HTML documentation for a module object.Nr r z5<a href="%s.html"><font color="#ffffff">%s</font></a>z)<big><big><strong>%s</strong></big></big>z
(built-in)r] � �$z
Revision: z
version %srT z (%s)z, z-<br><a href="%(docloc)s">Module Reference</a>r z#ffffffz#7799eez<a href=".">index</a><br>r� z.html#z#-z <tt>%s</tt>z
<p>%s</p>
rZ r zPackage Contentsz#aa55ccc s � j | d � S)Nr )r )�t)r> r r �<lambda>� s z#HTMLDoc.docmodule.<locals>.<lambda>�Modulesc S s g | ] \ } } | � q Sr r )r� rG rH r r r r� � s z%HTMLDoc.docmodule.<locals>.<listcomp>ZClassesz#ee77aar� Z Functionsz#eeaa77ZDataz#55aa55z<br>
rP ZAuthorrS ZCreditsr� z $Revision: r� r� )6r% �__all__r� r r r r
r! r r� �urllib�parseZquoter r� rs �strr] r r� rT r� �localsr r@ r* r+ � getmoduleru rA r& r r� r� r< r, r8 r6 r- r( r r �pkgutil� iter_modulesrZ �sortr r r r* � getclasstreer� rP rS )#r> r r( �mod�ignoredrt �partsZlinksr Z
linkedname�headr r r r� �versionr� r r� r! ZcdictrG rH rI r' r� r Zfdict�datar" �modpkgs�importer�ispkgr� � classlistr )r> r r� z s�
-
,
" ! "
" $ !"
!& & zHTMLDoc.docmodulec s � j } | p | } � j } g } | j � G� f d d � d � }
|
� � t t j � � � } t | � d k r� � j � � d � x+ | D]# } � d � j | � j � � q� W� d � � � � � � � � � f d d � }
� � � � f d d
� } � � � � � � � � f d d � } � f d
d � t
� � D� } i � x | D]w \ } } } } d | d | � | <} y t � | � } Wn t k
r�Yn Xy | � | <WqWt
k
r�YqWXqWWx[| r/| r�| j � � n | d d � t | � f d d � � \ } } � t j k r:| } q�n. � � k rOd } n d � j � � j � } | d 7} | j d d d � � |
d | | d d � � } |
d | | d d � � } |
d | | d d � � } | d | | d d � � } | d! | | d" d � � } | g k s&t � | } q�Wd# j | � } | | k r^d$ | | f } n d% | | | f } | r�g } x* | D]" } | j � j | � j � � q�W| d& d' j | � } � j t � � � j � � � � } | o�d( | } � j | d) d* | d+ | � S),z.Produce HTML documentation for a class object.c s. e Z d Z d d � Z � f d d � Z d S)z(HTMLDoc.docclass.<locals>.HorizontalRulec S s
d | _ d S)Nr )�needone)r> r r r r} � s z1HTMLDoc.docclass.<locals>.HorizontalRule.__init__c s | j r � d � d | _ d S)Nz<hr>
r )rJ )r> )�pushr r �maybe s
z.HTMLDoc.docclass.<locals>.HorizontalRule.maybeN)r% r& r[ r} rL r )rK r r �HorizontalRule� s rM r z&<dl><dt>Method resolution order:</dt>
z <dd>%s</dd>
z</dl>
c s� t | | � \ } } | r� � j � � | � x� | D]� \ } } } } y t � | � } Wn+ t k
r� � � j | | � � � Yn& X� � j | | � � � � � � � � d � q6 W| S)Nr )rO rL r< � Exception�_docdescriptorr� )�msg�attrsrK �okr( ry �homeclsrH )r! r �hr�mdictr@ r rK r> r r �spill s
z HTMLDoc.docclass.<locals>.spillc si t | | � \ } } | re � j � � | � x3 | D]+ \ } } } } � � j | | � � � q6 W| S)N)rO rL rO )rP rQ rK rR r( ry rS rH )rT r@ rK r> r r �spilldescriptors# s
z*HTMLDoc.docclass.<locals>.spilldescriptorsc
s
t | | � \ } } | r � j � � | � x� | D]� \ } } } } � j t � | � | � � } t | � s� t j | � r� t | d d � } n d } | d k r� � d | � nB � j t | � � j � � � � } d | } � d | | f � � d � q6 W| S)NrU z<dl><dt>%s</dl>
z<dd><tt>%s</tt>z<dl><dt>%s%s</dl>
r )
rO rL r� r< �callabler rw r( r r )
rP rQ rK rR r( ry rS rH rI r" )r! r rT rU r@ r rK r> r r � spilldata, s"
z#HTMLDoc.docclass.<locals>.spilldatac s@ g | ]6 \ } } } } t | d � �r | | | | f � q S)r9 )ru )r� r( ry rz rH )r r r r� A s z$HTMLDoc.docclass.<locals>.<listcomp>r� �-r c s | d � k S)Nr r )r3 )� thisclassr r r4 Z s z"HTMLDoc.docclass.<locals>.<lambda>z defined herezinherited from %sz:<br>
rG c S s | d S)Nr r )r3 r r r r4 g s z
Methods %sc S s | d d k S)Nr �methodr )r3 r r r r4 k s zClass methods %sc S s | d d k S)Nr z class methodr )r3 r r r r4 m s zStatic methods %sc S s | d d k S)Nr z
static methodr )r3 r r r r4 o s zData descriptors %sc S s | d d k S)Nr zdata descriptorr )r3 r r r r4 q s z Data and other attributes %sc S s | d d k S)Nr rE r )r3 r r r r4 s s r z*<a name="%s">class <strong>%s</strong></a>z/<strong>%s</strong> = <a name="%s">class %s</a>z(%s)z, z<tt>%s<br> </tt>z#000000z#ffc8d8r0 )r% rA r
r r �getmror rL r r& rv r< rN r� �popleftrO �builtinsr r> �AssertionErrorr! r( r r r )r> r r( r@ r r! rA �realnamer/ r� rM �mrorI rV rW rY rQ rG ry rS rH �anchor� inherited�tagr� r0 r" r ) r! r rT rU r@ r rK r> r[ r r� � s�
' '
!
$zHTMLDoc.docclassc C s | j d | j | � � S)z)Format an argument default value as text.�=)r r� )r> r r r r � formatvalue� s zHTMLDoc.formatvaluec C sT | j } | p | } | r$ | j p' d d | } d }
d } t | � r� | j j } | r� | | k r� d | j | | � }
nD | j d k r� d | j | j j | � }
n d | j | | � }
| | k r� d | | f }
ne | r0| | j k r0| j | | k r0d | j d | | f } d
} n | } d | | | f }
d } t j | � r�y t j | � } Wn t t
f k
r�d } Yn X| r�t | � } | d k r�d
| }
| d
d � } | s�d } |
| j | � |
o�| j
d |
� } | rd | S| j t | � | j | | | � } | o?d | } d | | f Sd S)z;Produce HTML documentation for a function or method object.r rZ r z from Nz method of %s instancez unbound %s methodz$<a name="%s"><strong>%s</strong></a>z<a href="#%s">%s</a>r z)<a name="%s"><strong>%s</strong></a> = %sz<lambda>z$<strong>%s</strong> <em>lambda</em> z(...)z'<font face="helvetica, arial">%s</font>z<dl><dt>%s</dt></dl>
z<dd><tt>%s</tt></dd>z<dl><dt>%s</dt>%s</dl>
r� )r% r? r; r� r �__dict__r r, � signature�
ValueErrorr� r9 r� r r( r r )r> r r( r@ r r! rF rE ra rc �note�skipdocs�imclassr� Zreallink�argspecri �declr" r r r r� � sZ
zHTMLDoc.docroutinec C sr g } | j } | r# | d | � | j d k r[ | j t | � | j � } | d | � | d � d j | � S)Nz!<dl><dt><strong>%s</strong></dt>
z<dd><tt>%s</tt></dd>
z</dl>
r )r
rU r( r r r! )r> r( rH r@ rx rK r" r r r rO � s
zHTMLDoc._docdescriptorc C s | j | | | � S)z*Produce html documentation for a property.)rO )r> r r( r@ rE r r r r� � s zHTMLDoc.docpropertyc G s' | r d | p d } | | j | � S)z-Produce HTML documentation for a data object.z<strong>%s</strong> = r )r� )r> r r( r@ rA Zlhsr r r r� � s zHTMLDoc.docotherc C s | j | | | � S)z1Produce html documentation for a data descriptor.)rO )r> r r( r@ rE r r r r� � s zHTMLDoc.docdatac C s� g } | d k r i } xh t j | g � D]T \ } } } t d d � | D� � rV q+ | j | d | | | k f � d | | <q+ W| j � | j | | j � } | j | d d | � S)z2Generate an HTML index for a directory of modules.Nc s s1 | ]' } d t | � k o& d k n Vq d S)i � i�� N)�ord)r� �chr r r � <genexpr>� s z HTMLDoc.index.<locals>.<genexpr>r r z#ffffffz#ee77aa)r< r= �anyr
r> r r r )r> r r rF rG r( rH r� r r r �index� s "
z
HTMLDoc.index) r% r& r[ rU r� �_repr_instancer� r� r� r r r r r r r r r r r r( r* r� r� rg r� rO r� r� r� rt r r r r r� � s:
+y� ;
r� c @ sL e Z d Z d Z d d � Z d d � Z d d � Z e Z d d � Z d
S) �TextReprzAClass for safely making a text representation of a Python object.c C s: t j | � d | _ | _ d | _ d | _ | _ d S)Nr� r� r� )r r} r� r� r� r� r� )r> r r r r} � s
zTextRepr.__init__c C sx t t | � d � r\ d d j t | � j j � � } t | | � r\ t | | � | | � St t t | � � | j � S)Nr% r� r_ )
rs r� r! r% r r< r3 r5 r� r� )r> rN r� r� r r r r� � s
"zTextRepr.repr1c C s^ t | | j � } t | � } d | k rZ d t | d d � k rZ d | d | | d S| S)Nr� z\\r r� r )r3 r� r� r/ )r> rN r� r� r� r r r r� s
$zTextRepr.repr_stringc
C s= y t t t | � � | j � SWn d | j j SYn Xd S)Nz
<%s instance>)r3 r5 r� r� r� r% )r> rN r� r r r r� s zTextRepr.repr_instanceN) r% r& r[ rU r} r� r� r� r� r r r r rv � s rv c @ s� e Z d Z d Z e � Z e j Z d d � Z d d d � Z d d � Z d d
d d � Z
d d d
d � Z d d d d � Z d d � Z
d d d d d � Z d d � Z d d d d d � Z d d d d d � Z d d d d d d d � Z d S) �TextDocz'Formatter class for text documentation.c C s d j d d � | D� � S)z(Format a string in bold by overstriking.r c s s | ] } | d | Vq d S)�Nr )r� rq r r r rr s z TextDoc.bold.<locals>.<genexpr>)r! )r> r. r r r �bold s z TextDoc.boldz c sS | s
d S� f d d � | j d � D� } | rF | d j � | d <d j | � S)z6Indent text by prepending a given prefix to each line.r c s g | ] } � | � q Sr r )r� r� )�prefixr r r� # s z"TextDoc.indent.<locals>.<listcomp>r r r� r� )r r r! )r> r. rz r# r )rz r �indent s " zTextDoc.indentc C s. | j | � j � } | j | � d | d S)z&Format a section with a given heading.r z
)r{ r ry )r> r� r� Zclean_contentsr r r r ' s zTextDoc.sectionNr c
s� d } x� | D]� } t | � t f � k r� | \ } } | | t | � � } | r� | | f k r� � f d d � | D� } | d d j | � } | d } q
t | � t g � k r
| | j | � | | d � } q
W| S)zBRender in text a class tree as returned by inspect.getclasstree().r c 3 s | ] } t | � � Vq d S)N)r) )r� r. )r' r r rr 6 s z%TextDoc.formattree.<locals>.<genexpr>z(%s)z, r z )r� r) r! r* )
r> r+ r' r, rz r r- r. r/ r0 r )r' r r* . s
zTextDoc.formattreec C s� | j } t t | � � \ } } | j d | | o: d | � } t | d d � } | j | � } | d k r� | | j d | d � } | r� | | j d | � } g } xo t j | t j � D]X \ }
} | d k s� t j | � p� | | k r� t
|
| | � r� | j |
| f � q� Wg } xx t j | t j � D]a \ }
} | d k stt j
| � stt j | � | k r8t
|
| | � r8| j |
| f � q8Wg }
xE t j | t � D]1 \ }
} t
|
| | � r�|
j |
| f � q�Wg } t � } t | d � r�xW t j | j � D]C \ } } } | j | � | rR| j | d � q | j | � q W| j � | | j d
d j | � � } g } xR t j | t j � D]; \ }
} | j j | d � r�|
| k r�| j |
� q�W| r| j � | | j d
d j | � � } | r�d d � | D� } | j t j | d � | � g } x0 | D]( \ }
} | j | j | |
| � � qWW| | j d d j | � � } | r g } x0 | D]( \ }
} | j | j | |
| � � q�W| | j d d j | � � } |
rdg } x6 |
D]. \ }
} | j | j | |
| d d �� qW| | j d d j | � � } t | d � r�t | j � } | d d � d# k r�| d$ d � d k r�| d d% � j � } | | j d | � } t | d � r| | j d t | j � � } t | d � r6| | j d t | j! � � } t | d � rd| | j d t | j" � � } y t j# | � } Wn t$ k
r�d! } Yn X| | j d" | � } | S)&z5Produce text documentation for a given module object.�NAMEz - r6 NzMODULE REFERENCEa.
The following documentation is automatically generated from the Python
source files. It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations. When in doubt, consult the module reference at the
location listed above.
Z DESCRIPTIONrZ z
(package)zPACKAGE CONTENTSr r Z
SUBMODULESc S s g | ] \ } } | � q Sr r )r� rG rH r r r r� ~ s z%TextDoc.docmodule.<locals>.<listcomp>r �CLASSES� FUNCTIONSr2 �F ZDATAr] r1 r2 z
Revision: �VERSIONrT ZDATErP ZAUTHORrS ZCREDITSz
(built-in)ZFILEz $Revision: r� r� )%r% r$ r r r< r� r r@ r+ r; ru r
r, r8 r- �setrs r< r= rZ �addr> r! r* rq r* r? r� r� r9 r] r rT rP rS r� r� )r> r r( r@ Zsynop�descr rt r� r! rG rH r rE rF Z
modpkgs_namesrG r' rH Z
submodulesrI r� rD r� r r r r� > s� " " $ "
""
& ,
zTextDoc.docmodulec s? � j } | p | } � j } � j d d � } | | k rR d � j | � } n � j | � d | } | r� t | | � } | d d j | � } t � � }
|
r� |
d g p� g } | j � t t j
� � � } t | � d k r#� d � x" | D] }
� d
| |
� � q� W� d � G� f d d
� d
� } | � � � � � � � f d d � } � � � � f d d � } � � � � � f d d � } � f d d � t � � D� } xB| r�| r�| j
� � n | d d � t | � f d d � � \ } } � t j k r#| } q�n+ � � k r8d } n d t � � j � } | j � | d | | d d � � } | d | | d d � � } | d | | d d � � } | d! | | d" d � � } | d# | | d$ d � � } | g k s�t � | } q�Wd j | � } | s | d S| d � j | j � d% � d S)&z4Produce text documentation for a given class object.c S s
t | | � S)N)r) )r. r� r r r �makename� s z"TextDoc.docclass.<locals>.makenamezclass z = class z(%s)z, r r zMethod resolution order:z r c s. e Z d Z d d � Z � f d d � Z d S)z(TextDoc.docclass.<locals>.HorizontalRulec S s
d | _ d S)Nr )rJ )r> r r r r} � s z1TextDoc.docclass.<locals>.HorizontalRule.__init__c s$ | j r � d d � d | _ d S)NrZ r r )rJ )r> )rK r r rL � s z.TextDoc.docclass.<locals>.HorizontalRule.maybeN)r% r& r[ r} rL r )rK r r rM � s rM c s� t | | � \ } } | r� � j � � | � xw | D]o \ } } } } y t � | � } Wn+ t k
r� � � j | | � � � Yq6 X� � j | | � � � � q6 W| S)N)rO rL r< rN rO r� )rP rQ rK rR r( ry rS rH )rT r@ r rK r> r r rV � s
z TextDoc.docclass.<locals>.spillc si t | | � \ } } | re � j � � | � x3 | D]+ \ } } } } � � j | | � � � q6 W| S)N)rO rL rO )rP rQ rK rR r( ry rS rH )rT r@ rK r> r r rW � s
z*TextDoc.docclass.<locals>.spilldescriptorsc
s� t | | � \ } } | r� � j � � | � x� | D]� \ } } } } t | � sc t j | � rr t | � } n d } y t � | � } Wn t k
r� | j | } Yn X� � j | | � d d d | �d � q6 W| S)Nr2 r r" r )
rO rL rX r rw r r< r� rh r� )
rP rQ rK rR r( ry rS rH r" r9 )rT r@ r rK r> r r rY � s
! z#TextDoc.docclass.<locals>.spilldatac s@ g | ]6 \ } } } } t | d � �r | | | | f � q S)r9 )ru )r� r( ry rz rH )r r r r� � s z$TextDoc.docclass.<locals>.<listcomp>r c s | d � k S)Nr r )r3 )r[ r r r4 � s z"TextDoc.docclass.<locals>.<lambda>z defined herezinherited from %sz Methods %s:
c S s | d d k S)Nr r\ r )r3 r r r r4 s zClass methods %s:
c S s | d d k S)Nr z class methodr )r3 r r r r4 s zStatic methods %s:
c S s | d d k S)Nr z
static methodr )r3 r r r r4 s zData descriptors %s:
c S s | d d k S)Nr zdata descriptorr )r3 r r r r4 s z Data and other attributes %s:
c S s | d d k S)Nr rE r )r3 r r r r4 s z | )r% rA r& ry �mapr! r r
r r r] r rv r^ rO r_ r r) r> r` r{ r )r> r r( r@ rA ra r/ r� r� r0 r" r� rb rI rM rV rW rY rQ rd re r )rT r@ r rK r> r[ r r� � sn
!
zTextDoc.docclassc C s d | j | � S)z)Format an argument default value as text.rf )r� )r> r r r r rg s zTextDoc.formatvaluec C s� | j } | p | } d } d } t | � r� | j j } | ra | | k r� d t | | � } n> | j d k r� d t | j j | � } n d t | | � } | | k r� | j | � } nE | r� | | j k r� | j | | k r� d } | j | � d | } d }
t j | � r�y t j | � } Wn t
t f k
rJd } Yn X| r�t | � }
| d k r�| j | � d
} |
d d
� }
|
s�d }
| |
| } | r�| d St
| � p�d }
| d |
o�| j |
� j � d Sd S)z;Produce text documentation for a function or method object.r r z from Nz method of %s instancez unbound %s methodr z = z<lambda>z lambda z(...)r r� )r% r? r; r� r) ry rh r r, ri rj r� r9 r r{ r )r> r r( r@ rE ra rk rl rm r� rn ri ro r" r r r r� $ sJ zTextDoc.docroutinec C st g } | j } | r2 | | j | � � | d � t | � pA d } | rg | | j | � � | d � d j | � S)Nr r )r
ry r r{ r! )r> r( rH r@ rx rK r" r r r rO V s
zTextDoc._docdescriptorc C s | j | | | � S)z*Produce text documentation for a property.)rO )r> r r( r@ rE r r r r� c s zTextDoc.docpropertyc C s | j | | | � S)z1Produce text documentation for a data descriptor.)rO )r> r r( r@ rE r r r r� g s zTextDoc.docdatac
C s� | j | � } | r_ | r% | d p( d | } | t | � } | d k r_ | d | � d } | rx | j | � d p{ d | } | d k r� | d | j t | � � 7} | S)z-Produce text documentation for a data object.z = r r Nz...r )r� r ry r{ r9 )
r> r r( r@ r, r2 r" r� r� Zchopr r r r� k s # zTextDoc.docother)r% r& r[ rU rv ru r� ry r{ r r* r� r� rg r� rO r� r� r� r r r r rw s e} 2
rw c @ s" e Z d Z d Z d d � Z d S)�
_PlainTextDocz2Subclass of TextDoc which overrides string stylingc C s | S)Nr )r> r. r r r ry y s z_PlainTextDoc.boldN)r% r& r[ rU ry r r r r r� w s r� c C s t � a t | � d S)zCThe first time this is called, determine what kind of pager to use.N)�getpager�pager)r. r r r r� ~ s r� c C s� t t j d � s t St t j d � s, t St j j � sL t j j � rP t Sd t j k r� t j d k rx d d � St j j d � d k r� d d � Sd
d � St j j d � d k r� t St j d k r� d d � St t d � rt j
d
� d k rd d � Sd d l } | j � \ } } t j
| � z: t t d � rgt j
d | � d k rgd d � St SWd t j | � Xd S)z2Decide what method to use for paging through text.�isatty�PAGER�win32c S s t t | � t j d � S)Nr� )�
tempfilepager�plainr r� )r. r r r r4 � s zgetpager.<locals>.<lambda>ZTERM�dumb�emacsc S s t t | � t j d � S)Nr� )� pipepagerr� r r� )r. r r r r4 � s c S s t | t j d � S)Nr� )r� r r� )r. r r r r4 � s c S s t t | � d � S)Nzmore <)r� r� )r. r r r r4 � s �systemz(less) 2>/dev/nullr c S s
t | d � S)NZless)r� )r. r r r r4 � s Nz more "%s"c S s
t | d � S)NZmore)r� )r. r r r r4 � s )r� r� )r� r� )rs r �stdin�
plainpager�stdoutr� r r� �platformr� r� �tempfileZmkstemp�close�ttypager�unlink)r� �fdr� r r r r� � s4
$
(
r� c C s t j d d | � S)z%Remove boldface formatting from text.z.r )r r )r. r r r r� � s r� c C s� d d l } | j | d d d | j �} yL t j | j d d ��- } y | j | � Wn t k
rm Yn XWd QRXWn t k
r� Yn Xx( y | j � PWq� t k
r� Yq� Xq� Wd S)z3Page through text by feeding it to another program.r N�shellTr� �errors�backslashreplace)
�
subprocess�Popen�PIPE�io�
TextIOWrapperr� �write�KeyboardInterruptr� �wait)r. �cmdr� �proc�piper r r r� � s
r� c C sv d d l } | j � } t | d d d �� } | j | � Wd QRXz t j | d | d � Wd t j | � Xd S)z<Page through text by invoking a program on a temporary file.r N�wr� r� z "r )r� Zmktempr� r� r r� r� )r. r� r� r� r� r r r r� � s r� c C s4 t t j d d � p d } | j | d � j | � S)N�encodingzutf-8r� )r< r r� �encode�decode)r. r� r r r �_escape_stdout� s r� c
C s5 t t | � � j d � } yG d d l } t j j � } | j | � } | j | � d d � } Wn0 t t
t j f k
r� d } d d � } Yn Xz|y t
t j j d d � � } Wn t k
r� d } Yn X| d k r� d } | d } } t j j d j | d | � � d � x� | | d � rt j j d
� t j j � | � } | d k rrt j j d
� Pn5 | d k r�t j j d
| | d � | d } q | d k r�| | | } | d k r�d } t j j d d j | | | | � � d � | | } q WWd | r0| j | | j | � Xd S)z%Page through text on a text terminal.r r Nc S s t j j d � S)Nr )r r� r� r r r r r4 � s zttypager.<locals>.<lambda>c S s! t j j � d d � d d � S)Nr r� )r r� r� r r r r r4 � s ZLINESr � z
-- more --�q�Qz
�
�b�B�)r� r� )r� r )r� r� r� )r� r� r �ttyr r� �filenoZ tcgetattrZ setcbreakr� r� r� �UnsupportedOperationr r r� r� rj r� r� r! �flushZ tcsetattrZ TCSAFLUSH)
r. r# r� r� �oldZgetchar�hr� Zincr. r r r r� � sL
'
/r� c C s t j j t t | � � � d S)z>Simply print unformatted text. This is the ultimate fallback.N)r r� r� r� r� )r. r r r r� � s r� c C s$ t j | � rQ | j t j k r, d | j St | d � rF d | j Sd | j St j | � rk d | j St j | � r� d | j j | j j | j f St j
| � r� d | j j | j j | j f St j | � r� d | j St j | � r� d | j St j
| � rd
| j St | � j S) z/Produce a short description of the given thing.zbuilt-in module rZ zpackage zmodule zbuilt-in function zgetset descriptor %s.%s.%szmember descriptor %s.%s.%szclass z function zmethod )r r* r% r r� rs r8 r� � __objclass__r& r� r+ r6 r7 r� )�thingr r r �describe s. r� c C s� d d � | j d � D� } d \ } } xW | t | � k r� t d j | d | d � � | � } | r} | | d } } q+ Pq+ W| r� | } n t } xD | | d � D]2 } y t | | � } Wq� t k
r� d SYq� Xq� W| S)z@Locate an object by name or dotted path, importing as necessary.c S s g | ] } | r | � q Sr r )r� r� r r r r� s zlocate.<locals>.<listcomp>r Nr r )Nr )r r r� r! r_ r< r� )r r� rB r� �nZ
nextmoduler r� r r r �locate s &
r� c C sy t | t � rD t | | � } | d k r: t d | � � | | f St | d d � } | t | t � rn | n d f Sd S)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� r9 r� r� r< )r� r� r r( r r r �resolve4 s
r� z Python Library Documentation: %sc C s' | d k r t } t | | � \ } } t | � } t j | � } | rx d | k rx | d | d | j d � � 7} n# | r� | | k r� | d | j 7} t j | � p� t j | � p� t j | � p� t j
| � p� t j | � p� t | t
� s t | � } | d 7} | | d | j | | � S)zBRender text documentation, given an object or a path to an object.Nr z in z in module z objectz
)r. r� r� r r; �rfindr% r* r+ r, r� r� r� r� r� r� )r� r� r� Zrendererr r( r� r� r r r �
render_docB s$ $
r� c C s� yE | d k r( t t | | | � � n | j t | | | t � � Wn5 t t f k
r| } z t | � WYd d } ~ Xn Xd S)zCDisplay text documentation, given an object or a path to an object.N)r� r� r� � plaintextr� r� �print)r� r� r� �outputrH r r r r" [ s r" c C s� y~ t | | � \ } } t j t | � t j | | � � } t | d d d d �� } | j | � Wd QRXt d | d � Wn5 t t f k
r� } z t | � WYd d } ~ Xn Xd S)z<Write HTML documentation to a file in the current directory.z.htmlr� r� zutf-8NZwrote)
r� �htmlr� r� r� r� r� r� r� r� )r� r� r r( r� r� rH r r r �writedocf s $ r� r c C sI | d k r i } x0 t j | g | � D] \ } } } t | � q( Wd S)zAWrite out HTML documentation for all modules in a directory tree.N)r< �
walk_packagesr� )r �pkgpath�donerG r' rH r r r � writedocsq s
%r� c � @ s� e Z d Z d d d d d d d d d d d d5d
d6d d7d d8d d9d d:d d d d;d d d d d d<d d d d=d d>d d?d! d@d# d$ d% dAd' dBd) d d* d d+ dCd, dDd. dEd dFd/ dGd dHd2 dIi! Z d3 dJd< dKd$ dLdQ dMdR dNd_ dOd` dPi Z dC dc d@ dd de df dg dh di dj dk dl dm dn do d3 dp dq dr ds dt du dv dw dx dw dy dz d{ dz i Z xa e j � D]S \ Z Z xD e D]< Z e j
e e � Z e e k r�e d| e Z e e e <q�WquWd} dQd3 dRd� dSd� dTd� dUd� dVd� dWd� dXd` dYd� dZd� d� d& d[d� d\d� d]d� d^d� d} d� d} d� d_dj d`d� dad� dbd dcd� d d� ddd< d� d� d� d� ded� dfd dgd� dhd� did" djd� dkd� dld� dmd� dnd� dod� d� d� d� d- dpd� dqd� drd� dsdq dtd� dud� d� d� dvd� dwd� dxd� dyd� dzd� d{d� d|d� d}d� d~dd ddQ d�d� d�d� d�d_ d�d$ d�d d�d� d d d�dR d�dd dd. dd dd dd�d d�d d�dd�iI Z dddd� Z e
dd� � Z e
dd� � Z dd� Z e � Z e dd� Z dd � Z d d � Z d d � Z d!d"� Z d#d$d%d&� Z d'd(� Z d)d*� Z d+d,� Z d d-d.� Z d d/d0� Z d1d2� Z d d3d4� Z dS(� �Helper�Falser �None�True�andZBOOLEAN�as�with�assert�break� while for�class�CLASSES SPECIALMETHODS�continue�def�function�del� BASICMETHODS�elif�if�else�except�try�finally�for�break continue while�from�import�global�nonlocal NAMESPACES�
TRUTHVALUE�MODULES�in�SEQUENCEMETHODS�isZ
COMPARISON�lambdar~ �nonlocal�global NAMESPACES�not�or�pass�raise�
EXCEPTIONS�return�while� break continue if TRUTHVALUE� CONTEXTMANAGERS EXCEPTIONS yield�yieldZSTRINGS�'�'''�r'�b'�"""r �r"�b"� OPERATORS�+rZ �*�**r� �//�%�<<�>>r� �|�^�~r� r� �<=�>=�==�!=�<>ZUNARY�AUGMENTEDASSIGNMENT�+=�-=�*=�/=�%=�&=�|=�^=�<<=�>>=�**=�//=ZBITWISEZCOMPLEX�j�JzOPERATORS FORMATTINGZPOWER�,zTUPLES LISTS FUNCTIONSr z ATTRIBUTES FLOAT MODULES OBJECTSz...�ELLIPSIS�:zSLICINGS DICTIONARYLITERALS�@z def classr� r_ Z PRIVATENAMESr^ zPRIVATENAMES SPECIALMETHODS�`Z
BACKQUOTESr zTUPLES FUNCTIONS CALLSr) �[zLISTS SUBSCRIPTS SLICINGS�]r� �TYPES�types�RSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect�strings�4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPESZ
STRINGMETHODS�string-methods�STRINGS FORMATTINGZ
FORMATTING�
formatstrings�UNICODE�:encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPESZNUMBERS�numbers�INTEGER FLOAT COMPLEX TYPESZINTEGER�integers� int rangeZFLOAT�floating�
float math� imaginary�
complex cmathZ SEQUENCES�typesseq�$STRINGMETHODS FORMATTING range LISTSZMAPPINGSZ DICTIONARIES�typesfunctions� def TYPESZMETHODS� typesmethods�class def CLASSES TYPESZ CODEOBJECTS�bltin-code-objects�compile FUNCTIONS TYPESZ TYPEOBJECTS�bltin-type-objects� types TYPESZ FRAMEOBJECTSZ
TRACEBACKSZNONE�bltin-null-object�bltin-ellipsis-object�SLICINGSZSPECIALATTRIBUTES� specialattrsr} �!class SPECIALMETHODS PRIVATENAMES� typesmodulesZPACKAGES� EXPRESSIONS�operator-summary��lambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIESZ
PRECEDENCEZOBJECTS�objectsZSPECIALMETHODS� specialnames�bBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSES�
customization� hash repr str SPECIALMETHODSZATTRIBUTEMETHODS�attribute-access�ATTRIBUTES SPECIALMETHODSZCALLABLEMETHODS�callable-types�CALLS SPECIALMETHODS�sequence-types�(SEQUENCES SEQUENCEMETHODS SPECIALMETHODSZMAPPINGMETHODS�MAPPINGS SPECIALMETHODS�
NUMBERMETHODS�
numeric-types�*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODSZ EXECUTION� execmodel�%NAMESPACES DYNAMICFEATURES EXCEPTIONSZ
NAMESPACES�naming�3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURESZDYNAMICFEATURES�dynamic-featuresZSCOPINGZFRAMESr� �try except finally raiseZ CONVERSIONS� conversionsZ IDENTIFIERS� identifiers�keywords SPECIALIDENTIFIERSZSPECIALIDENTIFIERS�
id-classes�atom-identifiersZLITERALS�
atom-literals�=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALSZTUPLESZ
TUPLELITERALS� exprlists�TUPLES LITERALSZLISTS�typesseq-mutable� LISTLITERALS�lists�LISTS LITERALS� typesmapping�DICTIONARYLITERALSr �DICTIONARIES LITERALSZ
ATTRIBUTES�attribute-references�(getattr hasattr setattr ATTRIBUTEMETHODSZ
SUBSCRIPTS�
subscriptions�slicingsZCALLS�calls�power�unaryZBINARY�binaryZSHIFTING�shifting�bitwise� comparisons�EXPRESSIONS BASICMETHODS�booleans�EXPRESSIONS TRUTHVALUEZ ASSERTIONZ
ASSIGNMENT�
assignment� augassignZDELETIONZ RETURNINGZ IMPORTINGZ CONDITIONALZLOOPING�compound�for while break continue�truth� if while and or not BASICMETHODSZ DEBUGGING�debugger�pdbZCONTEXTMANAGERS�context-managersNc C s | | _ | | _ d S)N)�_input�_output)r> �inputr� r r r r} $ s zHelper.__init__c C s | j p t j S)N)r� r r� )r> r r r r4 ( s zHelper.<lambda>c C s | j p t j S)N)r� r r� )r> r r r r4 ) s c C s? t j � d d d k r% | � d Sd | j j | j j f S)Nr r0 �?r z<%s.%s instance>)r �stackr� r& r[ )r> r r r �__repr__+ s
zHelper.__repr__c C sG | | j k r | j | � n$ | j � | j � | j j d � d S)Na
You are now leaving help and returning to the Python interpreter.
If you want to ask for help on a particular object directly from the
interpreter, you can type "help(object)". Executing "help('string')"
has the same effect as typing a particular string at the help> prompt.
)�_GoInteractiver �intro�interactr� r� )r> �requestr r r �__call__3 s
zHelper.__call__c C s� | j j d � x� y | j d � } | s, PWn t t f k
rH PYn Xt | d d d d � j � } | j � d k rz P| d k r� | j � q | j | � q Wd S)
Nr zhelp> r r r� r� �quitr )r� zquit)
r� r� �getliner� �EOFErrorr/ r �lowerr� r )r> r� r r r r� @ s
zHelper.interactc C sJ | j t j k r t | � S| j j | � | j j � | j j � Sd S)z.Read one line, using input() when appropriate.N)r� r r� r� r� r� r� )r> �promptr r r r� O s
zHelper.getlinec C s� t | � t d � k ro| j � } | d k r= | j � q�| d k rV | j � q�| d k ro | j � q�| d k r� | j � q�| d d � d k r� | j | j � d � q�| | j k r� | j | � q�| d k r� t t
| � d � q�| | j k r| j | � q�| | j
k r7| j | � q�| rVt | d d
| j �q�t t d d
| j �n/ t | t � r�| � n t | d d
| j �| j j d � d S)Nr �keywords�symbols�topicsr� � zmodules r r� r� r� z Help on %s:r� r )zTruezFalsezNone)r� r � listkeywords� listsymbols�
listtopics� listmodulesr r� �
showsymbolr" �evalr� � showtopicr� r� r9 r� r� r� r� )r> r� r r r r X s6
z Helper.helpc C s2 | j j d t t j d d � g d � � d S)Na�
Welcome to Python %s's help utility!
If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://docs.python.org/%s/tutorial/.
Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules. To quit this help utility and
return to the interpreter, just type "quit".
To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics". Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".
r0 r )r� r� r� r rD )r> r r r r� m s z Helper.intror� �P c C s� t t | � � } | | } t | � | d | } x� t | � D]� } x� t | � D]t } | | | } | t | � k rT | j j | | � | | d k rT | j j d d | d t | | � � qT W| j j d � qA Wd S)Nr r� r )r
�sortedr r r� r� ) r> �items�columnsr Zcolwr �rowr
r r r r r
~ s
.z Helper.listc C s* | j j d � | j | j j � � d S)NzN
Here is a list of the Python keywords. Enter any keyword to get more help.
)r� r� r
r� rD )r> r r r r� � s zHelper.listkeywordsc C s* | j j d � | j | j 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� r
r� rD )r> r r r r� � s zHelper.listsymbolsc C s* | j j d � | j | j j � � d S)NzN
Here is a list of available topics. Enter any topic name to get more help.
)r� r� r
r� rD )r> r r r r� � s zHelper.listtopicsc C s� y d d l } Wn& t k
r8 | j j d � d SYn X| j j | | j j | � � } | s~ | j j d t | � � d St | � t d � k r� | j | | � S| \ } } y | j j | } Wn0 t
k
r� | j j d t | � � d SYn Xt | j � d � | r'| p d d | } | r�d d l
} d d j | j � � d } | j | d � }
| j j d
d j |
� � d S) Nr zt
Sorry, topic and keyword documentation is not available because the
module "pydoc_data.topics" could not be found.
z no documentation found for %s
r r r� zRelated help topics: z, �H z
%s
)�pydoc_data.topicsr� r� r� r� r� r� r� r� r� �KeyErrorr� r �textwrapr! r Zwrap) r> �topic�
more_xrefs�
pydoc_data�target�label�xrefsr" r� r. Z wrapped_textr r r r� � s4
!
zHelper.showtopicc C s� y d d l } Wn t k
r( d SYn X| j j | | j j | � � } | s\ t d � � t | t � r{ | j | | � S| \ } } | j j | } | r� | p� d d | } | | f S)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�t
Sorry, topic and keyword documentation is not available because the
module "pydoc_data.topics" could not be found.
r zcould not find topicr� )r� r ) r� r� r� r� r� rj r� r9 � _gettopic)r> r� r� r� r� r� r� r" r r r r� � s
! zHelper._gettopicc C s9 | j | } | j d � \ } } } | j | | � d S)Nr� )r� � partitionr� )r> �symbolr� r� r_ r� r r r r� � s
zHelper.showsymbolc s� | r, | j j d j | � � t | � np | j j d � i } | d d � � � f d d � } t � j � d | �| j | j � � | j 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 S sS | r0 | d d � d k r0 | d d � d } | j d � d k rO d | | <d S) N� z .__init__z
(package)r r r i����i����)�find)r r' r� r� r r r �callback� s z$Helper.listmodules.<locals>.callbackc s � d | d � d S)Nr )r' )r� r r �onerror� s z#Helper.listmodules.<locals>.onerrorr� 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�
ModuleScanner�runr
rD )r> rG r� r� r )r� r r� � s
zHelper.listmodules)zassertr )zbreakr� )zclassr� )zcontinuer� )r� r )zdelr� )zelser� )zforr� )zglobalr� )zifr� )�importr� )zinr� )zlambda� FUNCTIONS)znonlocalr� )zpassr )zraiser� )zreturnr� )ztryr� )zwhiler� )�withr� )zyieldr )r� r� r� r� r� r r r )r rZ r r r� r r r r r� r
r r r� r� r
r r r r )r� r� r
r r r r )rZ r ) r r r r r r r r r r r r )r r r� r
r r )r r )�typesr* )r+ r, )r- r. )r/ r )r+ r1 )r2 r3 )r4 r5 )r6 r7 )r8 r9 )r: r; )r< r= )r> r? )r@ rA )rB rC )rD r )rE rF )rG r )r� rH )rI r� )rK rL )rM r( )rN rO )rP rQ )rR rS )rT rU )rV rW )rV rX )rZ r[ )r\ r] )r^ r_ )r` r )z
exceptionsra )rb r )rc rd )re r )rf r )rg rh )ri rj )rk rl )rm rn )ro rp )zdictrq )rr rs )rt r� )ru r� )rv rJ )rw rJ )rx rJ )ry rJ )rz rJ )r{ rJ )r| r} )r~ r )r� r )r� rY )r� r� )ztruthr� )r� r� )r� r� ) r% r& r[ r� Z_symbols_inverser� r� r� Zsymbols_r� r� r� r} r� r� r� r� r r� r� r� r� r r� r
r� r� r� r� r� r� r� r r r r r� x s4
r� c @ s+ e Z d Z d Z d d d d d � Z d S)r� z7An interruptible scanner that searches module synopses.Nc C s� | r | j � } d | _ i } x� t j D]� } | d k r+ d | | <| d k rf | d | d � q+ t | � j px d } | j d � d } | d | } | j � j | � d k r+ | d | | � q+ Wx�t j d | � D]�\ } } }
| j r� P| d k r| d | d � q� y t j
| | � } Wn t k
rCw� Yn X| j } t
| d � r�y | j | � }
Wn% t k
r�| r�| | � w� Yn Xt t j |
� � p�d } t
| d
� r�| j | � } qNd } nr y t j j | � } Wn% t k
r| r| | � w� Yn X| j r6| j j � d n d } t | d d � } | d | } | j � j | � d k r� | | | | � q� W| r�| � d S) NF�__main__r r r r z - r� �
get_source� get_filenamerV )r� r� r r� r� rU r r� r< r� � _get_specr� r� rs r� rN r� r� �StringIOr� r� r� r� r� r� r< )r> r� rG Z completerr� �seenr' r( r� rG rH r� r� �sourcer r� r r r r� s`
"
"zModuleScanner.run)r% r& r[ rU r� r r r r r� � s r� c C sV d d � } d d � } t j � �+ t j d � t � j | | d | �Wd QRXd S)zAPrint all the one-line module summaries that contain a substring.c S sE | d d � d k r* | d d � d } t | | o= d | � d S)Nr� z .__init__z
(package)z- i����i����)r� )r r' r� r r r r� = s zapropos.<locals>.callbackc S s d S)Nr )r' r r r r� A s zapropos.<locals>.onerror�ignorer� N)�warnings�catch_warnings�filterwarningsr� r� )rG r� r� r r r r� ; s
r� c s� d d l � d d l � d d l � d d l � Gd d � d � j j � � G� f d d � d � j j � � G� � � � � f d d � d � j � } | | | � } | j � x% | j r� | j
r� t j d � q� W| S)
a7 Start an HTTP server thread on a specific port.
Start an HTML/text server thread, so HTML or text documents can be
browsed dynamically and interactively with a Web browser. Example use:
>>> import time
>>> import pydoc
Define a URL handler. To determine what the client is asking
for, check the URL and content_type.
Then get or generate some text or HTML code and return it.
>>> def my_url_handler(url, content_type):
... text = 'the URL sent was: (%s, %s)' % (url, content_type)
... return text
Start server thread on port 0.
If you use port 0, the server will pick a random port number.
You can then use serverthread.port to get the port number.
>>> port = 0
>>> serverthread = pydoc._start_server(my_url_handler, port)
Check that the server is really started. If it is, open browser
and get first page. Use serverthread.url as the starting page.
>>> if serverthread.serving:
... import webbrowser
The next two lines are commented out so a browser doesn't open if
doctest is run on this module.
#... webbrowser.open(serverthread.url)
#True
Let the server do its thing. We just need to monitor its status.
Use time.sleep so the loop doesn't hog the CPU.
>>> starttime = time.time()
>>> timeout = 1 #seconds
This is a short timeout for testing purposes.
>>> while serverthread.serving:
... time.sleep(.01)
... if serverthread.serving and time.time() - starttime > timeout:
... serverthread.stop()
... break
Print any errors that may have occurred.
>>> print(serverthread.error)
None
r Nc @ s( e Z d Z d d � Z d d � Z d S)z!_start_server.<locals>.DocHandlerc S sx | j j d � r d } n d } | j d � | j d d | � | j � | j j | j | j | � j d � � d S) z�Process a request from an HTML browser.
The URL received is in self.path.
Get an HTML page from self.urlhandler and send it.
z.cssztext/cssz text/html�� z Content-Typez%s; charset=UTF-8zutf-8N) r rr Z
send_responseZ send_headerZ end_headersZwfiler� �
urlhandlerr� )r> � content_typer r r �do_GET� s
z(_start_server.<locals>.DocHandler.do_GETc W s d S)Nr )r> r� r r r � log_message� s z-_start_server.<locals>.DocHandler.log_messageN)r% r& r[ r� r� r r r r �
DocHandler� s r� c s: e Z d Z d d � Z � f d d � Z d d � Z d S)z _start_server.<locals>.DocServerc S sM d | _ | j | f | _ | | _ | j j | | j | j � d | _ d S)NZ localhostF)�hostZaddressr� rI r} �handlerr� )r> �portr� r r r r} � s
z)_start_server.<locals>.DocServer.__init__c s[ xJ | j sL � j | j j � g g g d � \ } } } | r | j � q W| j � d S)Nr )r� �selectZsocketr� Zhandle_requestZ server_close)r> Zrd�wrZex)r� r r �serve_until_quit� s
-z1_start_server.<locals>.DocServer.serve_until_quitc S s* | j j | � | j r& | j | � d S)N)rI �server_activater� )r> r r r r� � s z0_start_server.<locals>.DocServer.server_activateN)r% r& r[ r} r� r� r )r� r r � DocServer� s r� c sU e Z d Z � f d d � Z � � � � f d d � Z d d � Z d d � Z d S)
z#_start_server.<locals>.ServerThreadc s> | | _ t | � | _ � j j | � d | _ d | _ d S)NF)r� r r� �Threadr} �serving�error)r> r� r� )� threadingr r r} � s
z,_start_server.<locals>.ServerThread.__init__c s� ye � j j � _ � � _ � j j � _ t | j � � _ � | j | j
� } | | _ | j � Wn. t
k
r� } z | | _ WYd d } ~ Xn Xd S)zStart the server.N)�server�
HTTPServerrI r� r� ZMessageZ MessageClass� staticmethodr� r� �ready� docserverr� rN r� )r> Zdocsvr�e)r� r� �email�httpr r r� � s z'_start_server.<locals>.ServerThread.runc S s> d | _ | j | _ | j | _ d | j | j f | _ d S)NTz
http://%s:%d/)r� r� Z server_portr� r )r> r� r r r r� � s z)_start_server.<locals>.ServerThread.readyc S s" d | j _ d | _ d | _ d S)z&Stop the server and this thread nicelyTFN)r� r� r� r )r> r r r �stop� s z(_start_server.<locals>.ServerThread.stopN)r% r& r[ r} r� r� r� r )r� r� r� r� r� r r � ServerThread� s
r� g{�G�z�?)
Z http.serverZ
email.messager� r� r� ZBaseHTTPRequestHandlerr� r� r% r� r� �timeZsleep)r� r� r� Zthreadr )r� r� r� r� r� r� r �
_start_serverI s 8 "+"
r� z text/htmlc s� G� f d d � d t � } | � � � f d d � � � f d d � � � f d d � � � f d d
� � � f d d � � � f d
d � � � f d d � � � f d d � � � f d d � � � � � � � � � � � f d d � } | j d � r| d d � } | d k r{t j j t j j t � � } t j j | | � } t | � � } d j | j � � SWd QRXn | d k r�| | � St
d | | f � � d S) a The pydoc url handler for use with the pydoc server.
If the content_type is 'text/css', the _pydoc.css style
sheet is read and returned if it exits.
If the content_type is 'text/html', then the result of
get_html_page(url) is returned.
c s. e Z d Z � f d d � Z d d � Z d S)z _url_handler.<locals>._HTMLDocc s' d } d | } d | | � � | f S)zFormat an HTML page.zpydoc_data/_pydoc.cssz1<link rel="stylesheet" type="text/css" href="%s">a <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Pydoc: %s</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
%s</head><body bgcolor="#f0f0f8">%s<div style="clear:both;padding-top:.5em;">%s</div>
</body></html>r )r> r� r� �css_pathZcss_link)� html_navbarr r r� � s z#_url_handler.<locals>._HTMLDoc.pagec S s d | | f S)Nz <a href="getfile?key=%s">%s</a>r )r> r r r r r r � s z'_url_handler.<locals>._HTMLDoc.filelinkN)r% r& r[ r� r r )r� r r �_HTMLDoc� s
r� c sU � j d t j � t j � d t j � f � } d | � j t j d d � � f S)Nz %s [%s, %s]r aZ
<div style='float:left'>
Python %s<br>%s
</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>
ZterseT)r� r� Zpython_versionZ python_buildZpython_compiler)rD )r� r r r� � s
z!_url_handler.<locals>.html_navbarc s� d d � } � j d d d � } d d � t j D� } � j | | � } | d � j d d d
| � g } i } x* t j D] } | j � j | | � � q{ W| j d � d d
j | � f S)zModule Index page.c S s d | | f S)Nz<a href="%s.html">%s</a>r )r( r r r � bltinlink s z3_url_handler.<locals>.html_index.<locals>.bltinlinkz7<big><big><strong>Index of Modules</strong></big></big>z#ffffffz#7799eec S s" g | ] } | d k r | � q S)r� r )r� r( r r r r� s z4_url_handler.<locals>.html_index.<locals>.<listcomp>z<p>zBuilt-in Modulesz#ee77aaz|<p align=right><font color="#909090" face="helvetica,arial"><strong>pydoc</strong> by Ka-Ping Yee<ping@lfw.org></font>zIndex of Modulesr ) r r r� r r r r
rt r! )r� r �namesr� r� r )r� r r �
html_index s z _url_handler.<locals>.html_indexc s� g � � f d d � } t j � �7 t j d � d d � } t � j | | d | �Wd QRXd d � } g } � j d
d d � } x+ � D]# \ } } | j | | � | � q� W| � j d
| d d d j | � � } d | f S)zSearch results page.c sK | d d � d k r* | d d � d } � j | | o@ d | f � d S)Nr� z .__init__z
(package)z- i����i����)r
)r r' r� )�
search_resultr r r� 3 s z3_url_handler.<locals>.html_search.<locals>.callbackr� c S s d S)Nr )r' r r r r� : s z2_url_handler.<locals>.html_search.<locals>.onerrorr� Nc S s d | | f S)Nz<a href="%s.html">%s</a>r )r( r r r r� ? s z4_url_handler.<locals>.html_search.<locals>.bltinlinkz5<big><big><strong>Search Results</strong></big></big>z#ffffffz#7799eezkey = %sz#ee77aaz<br>zSearch Results) r� r� r� r� r� r r
r r! ) rG r� r� r� rx r r( r� r� )r� )r� r � html_search. s
z!_url_handler.<locals>.html_searchc
s� t j j | � } t j | � � } � j | j � � } Wd QRXd | } � j d d d � } | � j d | d d | � } d | | f S) z-Get and display a source file listing safely.Nz
<pre>%s</pre>z3<big><big><strong>File Listing</strong></big></big>z#ffffffz#7799eezFile: %sz#ee77aaz
getfile %s) r7 r8 Zunquoter� r� r� r� r r )r �fpr# Zbodyr r� )r� r r � html_getfileL s
z"_url_handler.<locals>.html_getfilec sn d d � } � j d d d � } t t j j � � } � j | | � } | � j d d d | � } d | f S)z Index of topic texts available.c S s d | | f S)Nz <a href="topic?key=%s">%s</a>r )r( r r r r� \ s z4_url_handler.<locals>.html_topics.<locals>.bltinlinkz,<big><big><strong>INDEX</strong></big></big>z#ffffffz#7799eeZTopicsz#ee77aa)r r� r� r� rD r r )r� r r� r� )r� r r � html_topicsY s z!_url_handler.<locals>.html_topicsc sn � j d d d � } t t j j � � } d d � } � j | | � } | � j d d d | � } d | f S)zIndex of keywords.z,<big><big><strong>INDEX</strong></big></big>z#ffffffz#7799eec S s d | | f S)Nz <a href="topic?key=%s">%s</a>r )r( r r r r� p s z6_url_handler.<locals>.html_keywords.<locals>.bltinlinkZKeywordsz#ee77aa)r r� r� r� rD r r )r r� r� r� )r� r r �
html_keywordsi s z#_url_handler.<locals>.html_keywordsc s t j � } t | | � } | j | � \ } } | | j k rH d } n d } � j d | d d � } d � j | � } � j | d d | � } | r� t | j � � } d d � } � j
| | � } � j d
d d | � } d | | f d j | | | f � f S)
zTopic or keyword help page.ZKEYWORDZTOPICz)<big><big><strong>%s</strong></big></big>z#ffffffz#7799eez
<pre>%s</pre>z#ee77aac S s d | | f S)Nz <a href="topic?key=%s">%s</a>r )r( r r r r� � s z7_url_handler.<locals>.html_topicpage.<locals>.bltinlinkzRelated help topics: z%s %sr )
r� r� r� r� r� r r( r r� r r r r! )r� ZbufZhtmlhelpr� r� r� r r� )r� r r �html_topicpagex s&
z$_url_handler.<locals>.html_topicpagec s^ t | d d �} | d k r6 | d k r6 t d � � t | � } � j | | � } | | f S)Nr� r r� zcould not find object)r� rj r� r� )r r9 r� �content)r� r r � html_getobj� s z!_url_handler.<locals>.html_getobjc sp � j d d d � } d j � f d d � t t | � | � D� � } | � j | d d | � } d | | f S) Nz,<big><big><strong>Error</strong></big></big>z#ffffffz#7799eez<br>c 3 s | ] } � j | � Vq d S)N)r� )r� r� )r� r r rr � s z3_url_handler.<locals>.html_error.<locals>.<genexpr>z#bb0000z
Error - %s)r r! r r� r )r r� r r� )r� r r �
html_error� s
z _url_handler.<locals>.html_errorc s
| } | j d � r% | d d � } y�| d k rF � � \ } } ny| d k rd � � \ } } n[| d k r� � � \ } } n=d | k r�| j d � \ } } } | d k r� � | � \ } } q�| d
k r� � | � \ } } q�| d k r4y � | � \ } } Wq�t k
r0� | � \ } } Yq�Xq�| d k r�| d k r^� � \ } } q�y � | � \ } } Wq�t k
r�� | � \ } } Yq�Xq�t d
� � n � | � \ } } Wn: t k
r�} z � | | � \ } } WYd d } ~ Xn X� j | | � S)z Generate an HTML page for url.z.htmlN� r rt r� r� rf z
search?keyz getfile?keyz topic?keyzget?keyz
bad pydoc url���)r �index)r r� )rr r� rj rN r� )r Z complete_urlr� r� �opr_ r� ) r� r� r� r� r� r� r� r� r� r r �
get_html_page� sB
(z#_url_handler.<locals>.get_html_pager� r Nztext/cssr z text/htmlz"unknown content type %r for url %s) r� rq r r �dirname�realpathrV r! r� � readlinesr� )r r� r� r� Z path_herer� r� r )
r� r� r� r� r� r� r� r� r� r� r � _url_handler� s,
**
r � open_browserTc C s$ d d l } t t | � } | j r5 t | j � d S| j r d } | rZ | j | j � z� y t d | j � t | � x^ | j r� t d � } | j � } | d k r� Pq} | d k r� | j | j � q} t | � q} WWn t
t f k
r� t � Yn XWd | j r | j � t d � Xd S) z�Start the enhanced pydoc Web server and open a Web browser.
Use port '0' to start the server on an arbitrary port.
Set open_browser to False to suppress opening a browser.
r Nz"Server commands: [b]rowser, [q]uitzServer ready atzserver> r� r� zServer stopped)
�
webbrowserr� r r� r� r� r� r r� r� r� r� r� )r� r r Z serverthreadZserver_help_msgr� r r r �browse� s2
r c C s% t | t � o$ | j t j � d k S)Nr )r� r9 r� r �sep)rN r r r �ispath
s r c C s� d d l } Gd d � d t � } d t j k r| t j j t j d � } | t j k ri t j j | � t j j d d � y�| j t j d d � d � \ } } d } d } d } d } xp | D]h \ } }
| d
k r� d } d } | d k rt |
� d S| d
k rd } |
} | d k r� d } q� W| r[| d k rGd } t
| d | �d S| sg| � x� | D]� } t | � r�t j j | � r�t
d | � Pyy t | � r�t j j | � r�t | � } | r
t | � r t j j | � r t | � qt | � n
t j | � Wqnt k
rL} z t
| � WYd d } ~ XqnXqnWWnc | j | f k
r�t j j t j j t j d � � d }
t
d j d |
d t j � � Yn Xd S)z@Command-line interface (looks at sys.argv to decide what to do).r Nc @ s e Z d Z d S)zcli.<locals>.BadUsageN)r% r& r[ r r r r �BadUsage
s r r r r zbk:p:wFz-bTz-kz-pz-wr zfile %r does not exista� 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} -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. The -p option can be used with
the -b option to explicitly specify the server port.
{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 )�getoptrN r r r r �argv�remove�insertr� r r �existsr� r~ r� r r� r� r r� r� r� r� r r )r
r Z scriptdirZoptsr� ZwritingZ start_serverr r� �opt�val�argrH r� r r r �cli
sd %
%)r r� )WrU r6 rP rT rS r_ Zimportlib._bootstrapr� Z importlib._bootstrap_external�importlib.machinery�importlib.utilr r� r r< r� r r r� r� Z urllib.parser7 r� � collectionsr �reprlibr � tracebackr r r r$ r) r- r/ r3 r �
IGNORECASEr4 r5 r: r? rC rO ru rv r� r� r� rN r� r� r� r� r� r� rv rw r� r� r� r� r� r� r� r� r� r� r� r. r� r� r� r� r" r� r� r� r r� r� r� r r r r r% r r r r �<module>$ s�
'
0=*� � - � d ! ,
� � = ��% V
Rosenblum TV: Video training, virtual workshops, classes, tutorials
RE-INVENTING THE TELEVISION NEWS BUSINESS*
A revolution in video storytelling
Creating entirely new & cost-effective production methods
From the world leaders in video production training and the creators of Character Driven Storytelling™
*and every other business that uses video
WHAT WE DO
Over the past 35 years, we have designed, built or restructured some of the most powerful news and journalism companies in the world.
We replace the traditional TV news ‘crew’ with one highly trained journalist, working alone with nothing but an iPhone.
No more TV news ‘crews’, no editors and no field producers.
This is television news done the way newspaper journalism is done – one reporter with their electronic pad and pencil.
In doing this, we can cut the cost of production by as much as 75% while increasing ratings and audience engagement.
In the place of conventional TV news ‘packages’ – ie, reporter stand up, interview, b-roll, man on the street, we marry great journalism with Netflix and Hollywood storytelling.
It’s a combination that works.
We have taken most of our clients to #1 in their respective markets.
And it’s not just for news. Any company, any profit, any NGO and anyone else who is online needs to tell their story in compelling yet cost-effective video. We can teach you to do that. Either in person or virtually.
EXAMPLES OF WHAT WE CAN TEACH YOUR STAFF TO PRODUCE
ITAY HOD
Itay Hod, MMJ with KPIX/CBS in San Francisco, took the 5-Day Intensive Video Storytelling Bootcamp in 2018.
Because he works alone, with only an iPhone, he was able to embed himself with a homeless family.
Here’s the story he produced in a one-day turn.
KIET DO
Kiet Do, an MMJ with KPIX/CBS in San Francisco, took the 5-Day Intensive Video Storytelling Bootcamp in 2021.
Here is a story he produced, all on his own, with only an iPhone and in a one-day turn.
TAYLOR SCHAUB
Taylor Schaub, an MMJ with Spectrum News 1 in LA, took the 5-Day Intensive Video Storytelling Bootcamp in 2023.
Here is a story he turned in only one day, using only an iPhone. It was the first video story he ever did and it was nominated for an Emmy.
THE BOOTCAMP
How do we convert stations and whole networks to working in this way?
Since 1988, we have run intensive 5-Day Video Storytelling Bootcamps
We have done these all over the world.
These are hands-on bootcamps, and participants learn an entirely new way of creating TV news stories.
-We shoot at a 3:1 ratio or lower, so turnaround times are fast.
-We go directly from camera to timelilne and edit – no written scripts. We work in the medium of pictures and sound.
-We are entirely character-driven.
-We are driven by pictures and real events.
-We are focused almost entirely on ’the viewer experience’.
Since 1988, more than 70,000 journalists around the world have taken our bootcamps, either in person on virtualy.
We have started to work with CBS News, bringing our ideas of character-driven storytelling to one of the most successful and biggest networks in the United States. Since beginning to work with them ratings have climbed and more importantly, audience engagement is through the ceiling.
We started New York Times Television in 1990 and it was the first paper to be brought into the world of TV. It quickly became one of the most successful non-fiction production companies in the United States. The series and documentaries we produced won many awards including multiple Emmys.
We have been working with the BBC since the year 2000 helping to convert their national news network to our visual storytelling technique. Most recently we have trained teams from their sports, documentaries, and comedy divisions to make character-driven stories using only smartphones.
For the past five years we have worked with Spectrum News to introduce and train their journalists on visual, character driven storytelling using smartphones helping to create a different kind of local news for their network of 24-Hour News Stations across the United States.
In 2006, we were approached by the United Nations. Rather than rely on news outlets, it would be much easier to train the field operatives to produce their own stories. We spent two years working with the UN, training more than 100 of their staff in bootcamps in Geneva and Nairobi.
We trained 50 print reporters at the paper to shoot and tell their own stories, in conjunction with their print work. We built a TV newsroom in their existing print newsroom – you could not ask for a better set and they began to live stream their stories in conjunction with their print work.
We spent two years with McGraw Hill, training more than 150 of their staffers, making them completely video literate. McGraw/Hill media properties we transit included Business Week, Aviation Week, (what was the name of the architecture magazine), and JD Power and Associates.
In 1990, we were approached by The Voice of America, the official broadcasting agency for the United States Government. When we met with VOA, they were only a short wave radio broadcaster, but working with them, we took them into television, launching VOA-TV.
British based Oyster Yachts makes some of the finest yachts in the world. Like every other company, they had to find a way to feed the never-ending video demands of social media – sites like Instagram and TikTok. We trained the Oyster staff to tell their own stories, using only iPhones.
We were approached by SEPA, the Scottish Environmental Protection Agency because they had to continually find a way to ‘feed the media beast’. The result was that SEPA was able to tell their own stories, whenever they wanted, and at almost no additional cost.
Michael Rosenblum has been writing about the media since 1988. His work and ideas have appeared in The Guardian, The Huffington Post, Ilkeston Life and many other publications.
He has been blogging regularly for the past 35 years on this subject. Having taught media studies at Columbia University, NYU and now the University of Oxford, he is considered an expert on this subject.
Continue reading this post or look back at previous posts.
