__ __ __ __ _____ _ _ _____ _ _ _ | \/ | \ \ / / | __ \ (_) | | / ____| | | | | | \ / |_ __\ V / | |__) | __ ___ ____ _| |_ ___ | (___ | |__ ___| | | | |\/| | '__|> < | ___/ '__| \ \ / / _` | __/ _ \ \___ \| '_ \ / _ \ | | | | | | |_ / . \ | | | | | |\ V / (_| | || __/ ____) | | | | __/ | | |_| |_|_(_)_/ \_\ |_| |_| |_| \_/ \__,_|\__\___| |_____/|_| |_|\___V 2.1 if you need WebShell for Seo everyday contact me on Telegram Telegram Address : @jackleetFor_More_Tools:
o
#T_i<� � @ s6 d Z dgZdZdZdZddlZddlZddlZddl Zddl
Zddl Z ddl Z ddl
Z
ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlmZ ddlm Z dd l m Z d
d � Z d d
� Z dd� Z!dd� Z"dd� Z#dd� Z$dd� Z%dd� Z&dd� Z'd d � Z(d d � Z)d d!� Z*e�+d"ej,�Z-d#d$� Z.d%d&� Z/d'd(� Z0d)d*� Z1d�d+d,�Z2d-d.� Z3d/d0� Z4d1d2� Z5d3d4� Z6i fd5d6�Z7G d7d8� d8e8�Z9d9d:� Z:di fd;d<�Z;G d=d>� d>�Z<G d?d@� d@e �Z=G dAdB� dBe<�Z>G dCdD� dDe �Z?G dEdF� dFe<�Z@G dGdH� dHe@�ZAdIdJ� aBdKdL� ZCdMdN� ZDdOdP� ZEdQdR� ZFdSdT� ZGdUdV� ZHdWdX� ZIdYdZ� ZJd�d[d\�ZKe@� ZLeA� ZMe>� ZNd�d]d^�ZO d�d`da�ZP d�dbdc�ZQd�ddde�ZRd�dgdh�ZSG didj� dj�ZTeT� ZUG dkdl� dl�ZVdmdn� ZWdodp� ZXd�drds�ZYd�dtdudv�dwdx�ZZdydz� Z[d{d|� Z\d}d~� Z]dd�� Z^e_d�k�r�e^� dS dS )�a^ 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
/usr/share/doc/pythonX.Y/html/library
if the pythonX.Y-doc package is installed or 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 <[email protected]>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 }t jD ]$}tj�|pd�}tj�|�}||vr+tj�|�r+| �|� |�|� q| S )zAConvert sys.path into a list of absolute, existing, unique paths.�.)�sys�path�os�abspath�normcase�isdir�append)�dirs�normdirs�dir�normdir� r � /usr/lib/python3.10/pydoc.py�pathdirsV s
�r c C s t �| �o t| tj� S �N)�inspect�isclass�
isinstance�types� GenericAlias��objectr r r �_isclassb s r c C sN t j�| j�}|d u r
d S | j�d�d d� D ]}t||�}qt|�s%d S |S )Nr ���)r �modules�get�
__module__� __qualname__�split�getattrr )�func�cls�namer r r �
_findclasse s r( c C s� t �| �r#| jj}| j}t|�r tt||d �d�| ju r |}n�|j}n�t �| �r=| j}t | �}|d u s:t||�| ur<d S nqt �
| �r]| j}| j}t|�rY|j d | | j krY|}nU|j}nQt | t
�rz| j}|j}t |�}|d u swt||�| uryd S n4t �| �s�t �| �r�| j}| j}t||�| ur�d S t �| �r�t|dd �}t |t�r�||v r�|| S nd S |jD ] }z tt||��}W n ty� Y q�w |d ur�| S q�d S )N�__func__r � __slots__)r �ismethodr) �__name__�__self__r r$ � __class__�
isfunctionr( � isbuiltinr" r �property�fget�ismethoddescriptor�isdatadescriptor� __objclass__�ismemberdescriptor�dict�__mro__�
_getowndoc�AttributeError)�objr' �selfr& r% �slots�base�docr r r �_finddoco s`
�
�
�
��r@ c C s` z%t �| d�}|du rW dS | tur#t| �j}t|t�r#||kr#W dS |W S ty/ Y dS w )zUGet the documentation string for an object if it is not
inherited from its class.�__doc__N)r �__getattribute__�typerA r �strr: )r; r? �typedocr r r r9 � s
�r9 c C sN t | �}|du rzt| �}W n ttfy Y dS w t|t�s"dS t�|�S )z�Get 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)r9 r@ r: � TypeErrorr rD r �cleandoc)r r? r r r �_getdoc� s �
rH c C s, t | �pt�| �}|rt�dd|�� �pdS )z-Get the doc string or comments for an object.z^ *
� )rH r � getcomments�re�sub�rstrip)r �resultr r r �getdoc� s rO c C sf | � � �d�}t|�dkr|d dfS t|�dkr,|d �� s,|d d�|dd� �fS dd�|�fS )z>Split a doc string into a synopsis line (if any) and the rest.�
� r rI � N)�stripr# �lenrM �join)r? �linesr r r �splitdoc� s rW c C s" | j }| j|kr| jd | }|S )z@Get a class name and qualify it with a module name if necessary.r )r, r! )r �modnamer' r r r � classname� s
rY c C s< t �| �p t| �p t �| �p t �| �p t �| �p t �| � S )z>Check if an object is of a type that probably means it's data.)r �ismoduler � isroutine�isframe� istraceback�iscoder r r r �isdata� s ����r_ c G s0 |r|d � | �|d ��} |dd� }|s| S )z/Do a series of global replacements on a string.rQ r rR N)rU r# )�text�pairsr r r �replace� s
�rb c C sX t | �|kr*td|d d �}td|d | �}| d|� d | t | �| d� S | S )zCOmit part of a string if needed to make it fit in a maximum length.r � rR N�...)rT �max)r` �maxlen�pre�postr r r �cram� s
$ri z at 0x[0-9a-f]{6,16}(>+)$c C s t �d| �S )z>Remove the hexadecimal id from a Python object representation.z\1)� _re_stripidrL �r` r r r �stripid� s rl c C s< t �| �rdS t �| �r t| dd�}t �|�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+ r0 r$ rZ )�fnr< r r r �_is_bound_method� s
rn c C s^ i }t �| t j�D ]\}}d||< q | jD ] }|�t|�� q|�� D ] }t| |�||< q#|S �NrQ )r �
getmembersr[ � __bases__�update�
allmethods�keysr$ )�cl�methods�key�valuer> r r r rs � s
rs c C s8 g }g }| D ]}||�r|� |� q|� |� q||fS )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 r c C sX | dv rdS | � d�r| �d�rdS | � d�r t|d�r dS |dur&| |v S | � d� S ) z3Decide whether to show documentation on a variable.> rA �__date__�__file__r, �__path__�__spec__r* �
__author__�
__cached__�
__loader__r! � __credits__� __package__� __version__� __builtins__r" r �__rQ �_�_fieldsTN)�
startswith�endswith�hasattr)r' �allr; r r r � visiblename s r� c C sX g }t �| �D ]"\}}}}t �|�r d}t|t�r |jdu r d}|�||||f� q|S )zCWrap inspect.classify_class_attrs, with fixup for data descriptors.�data descriptorN�readonly property)r �classify_class_attrsr4 r r1 �fsetr
)r �resultsr' �kindr& rx r r r r� - s
r� c sZ t |dg ��z
�fdd�t��D �� W n ty i � Y nw � fdd�}| j|d� dS )zGSort the attrs list in-place by _fields and then alphabetically by namer� c s i | ] \}}||t � � �qS r )rT )�.0�ir' )�fieldsr r �
<dictcomp>> � z#sort_attributes.<locals>.<dictcomp>c s � � | d d�| d fS �Nr )r )�attr)� field_orderr r �<lambda>A s z!sort_attributes.<locals>.<lambda>�rw N)r$ � enumeraterF �sort)�attrsr �keyfuncr )r� r� r �sort_attributes8 s � r� c C s: t j�| �rdD ]}t j�t j�| d| ��r dS qdS )z3Guess whether a path refers to a package directory.)z.pyz.pyc�__init__TF)r r r �isfilerU )r �extr r r � ispackageF s �r� c C s� | � � }|d d� dks|�� s#| � � }|sn |d d� dks|�� r|�� }|d d� dkr5|dd � }|d d� dkrk|dd � }|dd � dkrQ|d d� }|�� s`| � � }|s\n|�� rU|�d�d �� }|S d }|S )
NrQ �#� zr"""rc �"""r �\r )�readlinerS r# )�file�linerN r r r �source_synopsisN s$ � ��r� c
C s, t �| �j}|�| d�\}}|du s||k r�| �ttjj��r$tjj }n| �ttjj
��r2tjj }nd}|du razt �
| �}W n
tyI Y dS w |� t|�}W d � n1 s[w Y n-|d| �}tjjd| |d�}ztj�|�} W n Y dS tjd= | jr�| j�� d nd}||f|| < |S )z.Get the one-line summary out of a module file.�NNN�__temp__��loaderr )r �stat�st_mtimer r� �tuple� importlib� machinery�BYTECODE_SUFFIXES�SourcelessFileLoader�EXTENSION_SUFFIXES�ExtensionFileLoader�tokenize�open�OSErrorr� �util�spec_from_file_location�
_bootstrap�_loadr r rA �
splitlines)
�filename�cache�mtime�
lastupdaterN �
loader_clsr� r� �spec�moduler r r �synopsis_ s<
�
��
� r� c @ s e Zd ZdZdd� Zdd� ZdS )�ErrorDuringImportzEErrors that occurred while trying to import something to document it.c C s || _ |\| _| _| _d S r )r� �excrx �tb)r< r� �exc_infor r r r� � s zErrorDuringImport.__init__c C s | j j}d| j|| jf S )Nzproblem in %s - %s: %s)r� r, r� rx )r< r� r r r �__str__� s zErrorDuringImport.__str__N)r, r! r" rA r� r� r r r r r� � s r� c C s� t jj}t| d��}||�t|��k}W d � n1 s w Y tj�| �}tj� |�\}}|r:t j
� || �}nt j
� || �}t jj
|| |d�}zt j�|�W S t| t�� ��)z<Import a Python source file or compiled file given its path.�rbNr� )r� r� � MAGIC_NUMBERr� �readrT r r �basename�splitext�_bootstrap_externalr� �SourceFileLoaderr� r� r� r� r r� ) r �magicr� � is_bytecoder� r' r� r� r� r r r �
importfile� s � r� c s z/|r*� t jv r*� t jvr*� fdd�t jD �}� g| D ]
}t j| ||< t j|= q t� �}W n8 t �� \}}}} � t jv rJtt j� j| ��|tu rTt|j| ��t |t
�ra|j � kraY dS t� t �� ��� � d�dd� D ]}
zt
||
�}W qq ty� Y dS 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 s g | ] }|� � d �r|�qS )r )r� )r� �m�r r r �
<listcomp>� r� z safeimport.<locals>.<listcomp>Nr rQ )r r �builtin_module_names�
__import__r� r� r� � SyntaxErrorr� �
issubclass� ImportErrorr' r# r$ r: ) r � forceloadr� �subsrw r� r� rx r� �info�partr r� r �
safeimport� s*
r� c @ sf e Zd Zej�ddejdd� �Zd dd�Z d dd�Z
e
Z Z Z
Z ZZe�d �fd
d �ZdS )
�Doc�
PYTHONDOCSz%https://docs.python.org/%d.%d/libraryNrR c G s� ||f| }z"t �|�r| j|� W S t|�r | j|� W S t �|�r'| j|� W S W n ty1 Y nw t �|�r<| j |� S | j
|� S )z%Generate documentation for an object.) r rZ � docmoduler �docclassr[ �
docroutiner: r4 �docdata�docother)r< r r' �argsr r r �document� s �
z Doc.documentc G s& d|odt |� t|�jf }t|��)z+Raise an exception for unimplemented types.z.don't know how to document object%s of type %s� )�reprrC r, rF )r< r r' r� �messager r r �fail� s �zDoc.fail�stdlibc C s� zt �|�}W n ty d}Y nw tj�d| j�}tj�|�}t |t
t��rl|j dv sF|� |�rl|� tj�
|d��sl|� tj�
|d��sl|j dvrl|� d�r^d�|�d �|j �� �}|S tj�
||j �� d
�}|S d }|S ) z*Return the location of module docs or None�
(built-in)r� )
�errno�
exceptions�gc�imp�marshal�posix�signalr �_thread� zipimportz
dist-packagesz
site-packages)z xml.etreeztest.pydoc_mod)zhttp://zhttps://z
{}/{}.html�/�.htmlN)r �
getabsfilerF r �environr r� r r r rC r, r� rU �formatrM �lower)r< r �basedirr� �doclocr r r � getdocloc� s. �
���
��z
Doc.getdoclocr )r, r! r" r r r r � version_infor� r� r� r� r� r� r� � docpropertyr� � sysconfig�get_pathr
r r r r r� � s ��
r� c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � ZeZ d d
� Z
eZ dS )�HTMLReprzBClass for safely making an HTML representation of a Python object.c C �, t �| � d | _| _d| _d | _| _d S �N� �
�d �r r� �maxlist�maxtuple�maxdict� maxstring�maxother�r< r r r r� �
zHTMLRepr.__init__c C s t |dddddd�S )N�&z&�<z<�>z>)rb �r< r` r r r �escape s zHTMLRepr.escapec C s t �| |�S r )r r� �r< r r r r r� � z
HTMLRepr.reprc C sZ t t|�d�r dd�t|�j�� � }t | |�r t| |�||�S | �ttt |��| j
��S �Nr, �repr_r� ) r� rC rU r, r# r$ r$ ri rl r� r �r< r~ �level�
methodnamer r r �repr1 s
zHTMLRepr.repr1c C s^ t || j�}t|�}d|v r%dt|dd�vr%d|d | �|� |d S t�dd| �|��S )Nr� �\\rI �rr z-((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)z <font color="#c040c0">\1</font>)ri r r� rb r$ rK rL �r< r~ r* �test�testreprr r r � repr_string" s �zHTMLRepr.repr_stringc C s: z| � ttt|��| j��W S | � d|jj � Y S �Nz
<%s instance>)r$ ri rl r� r r. r, �r< r~ r* r r r �
repr_instance/ s zHTMLRepr.repr_instanceN) r, r! r" rA r� r$ r� r, r2 �repr_strr5 � repr_unicoder r r r r
s r c @ s e Zd ZdZe� ZejZejZdd� Zd1dd�Z d2d
d �Z
d d
� Z dd� Z d3dd�Z
dd� Zdd� Zdd� Zdd� Zdd � Zd d � Zdi i i fd d �Zd4d!d"�Zd5d#d$�Zddi i fd%d&�Zd'd(� Zddi i i dfd)d*�Zd6d+d,�ZeZd5d-d.�Z d4d/d0�Z dS )7�HTMLDocz'Formatter class for HTML documentation.c C � d||f S )�Format 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.pagerI c C s d|||||pdf 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>
� r )r< r; �fgcol�bgcol�extrasr r r �headingJ s �zHTMLDoc.heading� Nr> c
C s^ |du r dd| d }d|||f } |r | d||||f } n | d|||f } | d| S ) z Format a section with a heading.Nz<tt>r> 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< �width�prelude�
marginalia�gaprN r r r �sectionU s �
�� zHTMLDoc.sectionc G s d| }| j |g|�R � S )z$Format a section with a big heading.z <big><strong>%s</strong></big>)rH )r< r; r� r r r �
bigsectionk s zHTMLDoc.bigsectionc
C s& | � |�� �}t|dddddddd� S )z!Format literal preformatted text.�
z
r� r> rP �<br>
)r$ �
expandtabsrb r# r r r � preformatp s �zHTMLDoc.preformatr� c C s� d}t |�| d | }t|�D ],}|dd| }t|| || | �D ]}|t |�k r7|||| � d }q%|d }qd| S )z0Format a list of items into a multi-column list.rI rQ z <td width="%d%%" valign=top>r rK z</td>z7<table width="100%%" summary="list"><tr>%s</tr></table>)rT �range)r< �listr �colsrN �rows�colr� r r r � multicolumnv s �
zHTMLDoc.multicolumnc C s d| S )Nz <font color="#909090">%s</font>r r# r r r �grey� s z HTMLDoc.greyc G s* |D ]}||v rd|| |f S q|S )z:Make a link for an identifier, given name-to-URL mappings.�<a href="%s">%s</a>r )r< r' �dictsr7 r r r �namelink� s
�zHTMLDoc.namelinkc C sN |j tj�|j�}}t||�r"t||�|u r"d|j |t||�f S t||�S )zMake a link for a class.z<a href="%s.html#%s">%s</a>)r, r r r r! r� r$ rY )r< r rX r' r� r r r � classlink� s �
zHTMLDoc.classlinkc C s d|j |j f S )zMake a link for a module.�<a href="%s.html">%s</a>)r, r% r r r �
modulelink� s zHTMLDoc.modulelinkc C sR |\}}}}|r
| � |�S |rd||f }nd| }|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)rU )rT )r< �
modpkginfor' r r� �shadowed�urlr` r r r �
modpkglink� s
zHTMLDoc.modpkglinkc C r9 )zMake a link to source file.z<a href="file:%s">%s</a>r )r< r] r r r r �filelink� � zHTMLDoc.filelinkc C s� |p| j }g }d}t�d�} |�||�} | sn�| �� \}
} |�||||
� �� | �� \} }
}}}}|
rG|| ��dd�}|�d||f � ng|r[dt|� }|�d||| �f � nS|rodt|� }|�d||| �f � n?|r�|| | d � d
kr�|�d | � ||� � n'|�d | � n || | d � d
kr�|�| � ||||�� n |�| � ||�� | }q|�|||d
� �� d�
|�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 zJ\b((http|https|ftp)://\S+[\w/]|RFC[- ]?(\d+)|PEP[- ]?(\d+)|(self\.)?(\w+))T�"z"rU z'http://www.rfc-editor.org/rfc/rfc%d.txtz)https://www.python.org/dev/peps/pep-%04d/rQ �(zself.zself.<strong>%s</strong>NrI ) r$ rK �compile�search�spanr
�groupsrb �intrW rU )r< r` r$ �funcs�classesrv r� �here�pattern�match�start�endr� �scheme�rfc�pep�selfdotr' r] r r r �markup� s<
�
zHTMLDoc.markupc
C s� d}|D ]T}t |�t d�u rE|\}}|d }|| �||� }|r@||fkr@g }|D ] } |�| �| |�� q)|d d�|� d }|d }qt |�t g �u rX|d| �|||� }qd | S )
zAProduce HTML for a class tree as given by inspect.getclasstree().rI r z"<dt><font face="helvetica, arial">rb �, �)z
</font></dt>z
<dd>
%s</dd>
z
<dl>
%s</dl>
)rC rX r
rU �
formattree)
r< �treerX �parentrN �entry�c�bases�parentsr> r r r rv � s$
��zHTMLDoc.formattreec #
s� |j }z|j}W n ty d}Y nw |�d�}g }tt|�d �D ]}|�dd�|d|d � �|| f � q#d�||dd� �} d| }
zt� |�} t
j � | �} � �
| | �}
W n tyg d}
Y nw g }t|d�r�t|j�}|dd � d
kr�|dd� d kr�|d d� �� }|�d � �|� � t|d
�r�|�� �t|j��� |r�|
dd�|� }
� �|�}|dur�dt� }nd}� �|
ddd|
| �}t�|tj�}g i }}t�|t�D ]*\}}|dus�t�|�p�||u �r
t |||��r
|�||f� d| ||< ||< q�|D ]@\}}|j D ]7}|j |j }}t j �!|�}||k�rJ|�rJt||��rJt"||�|u �rJ||v�rJ|d | ||< ||< �q�q
g i }}t�|tj#�D ]8\}}|du�sqt�$|��sqt�|�|u �r�t |||��r�|�||f� d| ||< t�%|��r�|| ||< �qZg } t�|t&�D ]\}}t |||��r�| �||f� �q�� �'t(|�� j)||�} | �o�d| } |d| }t|d��r�g } t*�+|j,�D ]\} }} | �||| df� �q�| �-� � �.| � j/�}!|� �0d dd |!� }n|�r� �.|� fd d ��}!|� �0d dd |!� }|�rHd!d"� |D �}"� �1t�2|"d�|�g}!|D ]\}}|!�� �3|||||�� �q)|� �0d#dd$d%�|!�� }|�rng }!|D ]\}}|!�� �3|||||�� �qO|� �0d&dd'd%�|!�� }| �r�g }!| D ]\}}|!�� �3||�� �qu|� �0d(dd)d*�|!�� }t|d+��r�� �'t|j4�� j)�}!|� �0d,dd|!� }t|d-��rň �'t|j5�� j)�}!|� �0d.dd|!� }|S )/z/Produce HTML documentation for a module object.Nr rQ z5<a href="%s.html"><font color="#ffffff">%s</font></a>r �)<big><big><strong>%s</strong></big></big>r� r� � � $Revision: �$z
version %sr� z (%s)rt z-<br><a href="%(docloc)s">Module Reference</a>rI �#ffffff�#7799eez<a href=".">index</a><br>r� z.html#z#-z <tt>%s</tt>z
<p>%s</p>
r� r zPackage Contentsz#aa55ccc s � � | d �S ro )rZ ��tr r r r� > � z#HTMLDoc.docmodule.<locals>.<lambda>�Modulesc S � g | ]\}}|�qS r r �r� rw rx r r r r� C � z%HTMLDoc.docmodule.<locals>.<listcomp>�Classes�#ee77aar� � Functionsz#eeaa77�Dataz#55aa55rK r� �Authorr� �Credits)6r, �__all__r: r# rN rT r
rU r r �urllib�parse�quoter_ rF r� rD r� rS r$ r� r
�localsrB rp rZ r � getmoduler� rq r! r r r r$ r[ r0 r/ r_ rs rO rM �pkgutil� iter_modulesr� r� rS r^ rI rv � getclasstreer� r� r� )#r< r r' �mod�ignoredr� �parts�linksr� �
linkedname�headr r] r_ r� �versionr rN r ri �cdictrw rx r> rX r� rh �fdict�datar? �modpkgs�importer�ispkgr< � classlistr r r r� � s
�
��
�
�
�
��
� �� � ��� � � � � �zHTMLDoc.docmodulec s� �j }|p|}�j}g } | j�G �fdd�d�}
|
� �tt����} t| �dkrD��� �d� | D ]
} �d��| �j � � q2�d� � �������fdd�}
����fd d
�}� �������fd d �}�fd
d�t
��D �}i �|D ]2\}}}}d| d | �|< }zt �|�}W n t y� Y nw z|�|< W qv t
y� Y qvw |�r1| r�| �� �n|d d �t|�fdd��\}}�tjurшtju r�|}q���u r�d}n d����j � }|d7 }t|�� |
d| |dd� �}|
d| |dd� �}|
d| |d d� �}|d | |d d� �}|d | |d d� �}|d!| |d"d� �}|g k�s-J �|}|s�d#�| �} ||k�rBd$||f }nd%|||f }|�rgg }|D ]
} |���| �j �� �qP|d&d'�|� }d#}zt���}W n tt
f�y~ d(}Y nw |�r�t|�} | �r�| d)k�r�|��| � d* }t��} |�r�|| �p�d# } ��| �j�� ��} | �o�d+| } ��|d,d-| d.| �S )/z.Produce HTML documentation for a class object.c � e Zd Zdd� Z� fdd�ZdS )z(HTMLDoc.docclass.<locals>.HorizontalRulec S �
d| _ d S r� ��needoner r r r r� m �
z1HTMLDoc.docclass.<locals>.HorizontalRule.__init__c � | j r� d� d| _ d S )Nz<hr>
rQ r� r ��pushr r �maybeo �
z.HTMLDoc.docclass.<locals>.HorizontalRule.maybeN�r, r! r" r� r� r r� r r �HorizontalRulel � r� rR z&<dl><dt>Method resolution order:</dt>
z <dd>%s</dd>
�</dl>
c s� t ||�\}}|rE��� �| � |D ]1\}}}}zt�|�}W n ty2 ���||��� Y nw ���||��� ���� �d� q|S )NrP �r r� r$ � Exceptionr� r� ��msgr� r{ �okr' r� �homeclsrx �ri rh �hr�mdictr� r r� r< r r �spill s � �
z HTMLDoc.docclass.<locals>.spillc �J t ||�\}}|r#� �� �| � |D ]\}}}}���||��� q|S r �r r� r� r� �r� r� r� r< r r �spilldescriptors� � z*HTMLDoc.docclass.<locals>.spilldescriptorsc
s� t ||�\}}|rM��� �| � |D ]9\}}}}��t�|�|��}t|�} | s0�d| � n��t|��j�� ��} d| } �d|| f � �d� q|S )Nz<dl><dt>%s</dl>
z<dd><tt>%s</tt>z<dl><dt>%s%s</dl>
rP )r r� r� r$ rO rs rM )
r� r� r{ r� r' r� r� rx r> r? r� r r � spilldata� s �
z#HTMLDoc.docclass.<locals>.spilldatac �, g | ]\}}}}t |� d �r||||f�qS �)r; �r� �r� r' r� r& rx r r r r� � �
�z$HTMLDoc.docclass.<locals>.<listcomp>r� �-r c � | d � u S �NrR r r� �� thisclassr r r� � � z"HTMLDoc.docclass.<locals>.<lambda>� defined here�inherited from %sz:<br>
z
Methods %sc S � | d dkS �NrQ �methodr r� r r r r� � r� zClass methods %sc S r� �NrQ z class methodr r� r r r r� � r� zStatic methods %sc S r� �NrQ z
static methodr r� r r r r� � r� zReadonly properties %sc S r� �NrQ r� r r� r r r r� � r� zData descriptors %sc S r� �NrQ r� r r� r r r r� � r� z Data and other attributes %sc S r� �NrQ r� r r� r r r r� � r� rI z*<a name="%s">class <strong>%s</strong></a>z/<strong>%s</strong> = <a name="%s">class %s</a>�(%s)rt N�()rJ z<tt>%s<br> </tt>z#000000z#ffc8d8rc ) r, rq r
r r �getmrorT r� rX r! r� r$ r� rF �popleftr �builtinsr r� rU � signature�
ValueErrorrD r$ rO rs rM rH ) r< r r' r� rh ri r� �realnamer{ r< r� �mror> r� r� r� r� rw r� r� rx �anchor� inherited�tagr; r| �declr� �argspecr? r ) ri rh r� r� r� r r� r< r� r r� a s�
�
� � �
�
�
�
�
�
�
��
#
���zHTMLDoc.docclassc C s | � d| �|� �S �z)Format an argument default value as text.�=)rT r� r% r r r � formatvalue � zHTMLDoc.formatvaluec C s� |j }|p|}|r |j p
dd | } d}
d} t|�rE|jj} |r-| |ur,d| �| |� }
n|jdur=d| �|jj|� }
nd| �| |� }
t�|�sOt�|�rRd}
nd}
||kr_d | |f }n"|rxt�||g �|u rxd
|j d | |f }d } n|}d | ||f }d}t� |�r�zt�
|�}W n
t t fy� d}Y nw |r�t
|�}|d
kr�d| }|d d� }|s�d}|
| | �|� |
o�| �d|
� }| r�d| S | �t|�| j|||�}|o�d| }d||f S )z;Produce HTML documentation for a function or method object.rI r� r � from N� method of %s instance� unbound %s method�async z$<a name="%s"><strong>%s</strong></a>z<a href="#%s">%s</a>rQ z)<a name="%s"><strong>%s</strong></a> = %s�<lambda>z$<strong>%s</strong> <em>lambda</em> r �(...)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, rn r- r. rX r �iscoroutinefunction�isasyncgenfunction�getattr_staticr[ r� r� rF rD r$ rT rs rO rM )r< r r' r� rh ri rv ru r� r� �note�skipdocs�imclass�asyncqualifierr; �reallinkr� r� r� r? r r r r� sp �
�
���
� �� zHTMLDoc.docroutinec C sN g }|j }|r
|d| � | �t|�| j�}|r |d| � |d� d�|�S )z1Produce html documentation for a data descriptor.z!<dl><dt><strong>%s</strong></dt>
z<dd><tt>%s</tt></dd>
r� rI )r
rs rO rM rU �r< r r' r� ru r� r� r? r r r r� H s
zHTMLDoc.docdatac G s |rd| pd}|| � |� S )z-Produce HTML documentation for a data object.z<strong>%s</strong> = rI �r� )r< r r' r� r� �lhsr r r r� X s zHTMLDoc.docotherc C s� g }|du ri }t �|g�D ] \}}}tdd� |D ��r q|�|d|||v f� d||< q|�� | �|| j�}| �|dd|�S )z2Generate an HTML index for a directory of modules.Nc s s, � | ]}d t |� kodkn V qdS )i � i�� N)�ord�r� �chr r r � <genexpr>b s �* z HTMLDoc.index.<locals>.<genexpr>rI rQ r� r� )r� r� �anyr
r� rS r^ rI )r< r r\ r� r� r' r� r< r r r �index] s
z
HTMLDoc.index�rI )rC rI Nr> )r� r r� �NNN) r, r! r" rA r �_repr_instancer� r$ r= rB rH rI rM rS rT rW rX rZ r^ r_ rs rv r� r� r� r� r� r r� r r r r r r8 7 s@
�
+
y #
�
A
r8 c @ s4 e Zd ZdZdd� Zdd� Zdd� ZeZdd � Zd
S ) �TextReprzAClass for safely making a text representation of a Python object.c C r r r r r r r r� p r zTextRepr.__init__c C sT t t|�d�r dd�t|�j�� � }t | |�r t| |�||�S ttt|��| j �S r' )
r� rC rU r, r# r$ ri rl r� r r) r r r r, v s
zTextRepr.repr1c C sH t || j�}t|�}d|v r"dt|dd�vr"d|d | |d S |S )Nr� r- rI r. r )ri r r� rb r/ r r r r2 } s
zTextRepr.repr_stringc C s. z t tt|��| j�W S d|jj Y S r3 )ri rl r� r r. r, r4 r r r r5 � s zTextRepr.repr_instanceN) r, r! r" rA r� r, r2 r6 r5 r r r r r n s r c @ s~ e Zd ZdZe� ZejZdd� Zddd�Zdd� Z dd d �Z
dd
d�Z ddd�Z dd� Z
d dd�Zd dd�ZeZd dd�Zd S ) �TextDocz'Formatter class for text documentation.c C s d� dd� |D ��S )z(Format a string in bold by overstriking.rI c s s � | ] }|d | V qdS )�Nr r� r r r r � s � z TextDoc.bold.<locals>.<genexpr>)rU r# r r r �bold� r� z TextDoc.bold� c s> |sdS � fdd�|� d�D �}|r|d �� |d< d�|�S )z6Indent text by prepending a given prefix to each line.rI c s g | ]}� | �qS r r �r� r� ��prefixr r r� � r� z"TextDoc.indent.<locals>.<listcomp>rP r )r# rM rU )r< r` r
rV r r r �indent� s
zTextDoc.indentc C s$ | � |��� }| �|�d | d S )z&Format a section with a given heading.rP rJ )r rM r )r< r; r< �clean_contentsr r r rH � s zTextDoc.sectionNrI c
s� d}|D ]I}t |�t d�u r9|\}}|| t|� � }|r4||fkr4� fdd�|D �} |dd�| � }|d }qt |�t g �u rM|| �|� ||d � }q|S ) zBRender in text a class tree as returned by inspect.getclasstree().rI r c 3 s � | ]}t |� �V qd S r �rY )r� rz �rX r r r � � � z%TextDoc.formattree.<locals>.<genexpr>r� rt rP r
)rC rY rU rv )
r< rw rX rx r
rN ry rz r{ r| r r r rv � s
��zTextDoc.formattreec C s |j }tt|��\}}| �d||od| �}t|dd�}| �|�}|dur0|| �d|d � }|r:|| �d|� }g } t�|t�D ] \}
} |dusSt� | �pP||u r`t
|
||�r`| � |
| f� qBg } t�|tj �D ]!\}
} |dus~t�
| �s~t� | �|u r�t
|
||�r�| � |
| f� qjg }
t�|t�D ]\}
} t
|
||�r�|
� |
| f� q�g }t� }t|d�r�t�|j�D ]\}}}|�|� |r�|� |d � q�|� |� q�|�� || �d
d �|�� }g }t�|tj�D ]\}
} | j �|d �r�|
|vr�|� |
� q�|�r|�� || �d
d �|�� }| �rBdd� | D �}| �t�|d�|�g}| D ]\}
} |� | �| |
|�� �q'|| �dd �|�� }| �rdg }| D ]\}
} |� | �| |
|�� �qI|| �dd �|�� }|
�r�g }|
D ]\}
} |� | j | |
|dd�� �qk|| �dd �|�� }t|d��r�t |j �}|dd� dk�r�|dd� dk�r�|dd� � � }|| �d|� }t|d ��r�|| �d t |j �� }t|d ��r�|| �d t |j!�� }t|d ��r�|| �d!t |j"�� }zt�#|�}W n t$�y� d"}Y nw || �d#|� }|S )$z5Produce text documentation for a given module object.�NAME� - 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 CONTENTSrP r �
SUBMODULESc S r� r r r� r r r r� � r� z%TextDoc.docmodule.<locals>.<listcomp>rQ �CLASSES� FUNCTIONS�F )rf �DATAr� r~ r r r� �VERSIONr� �DATEr� �AUTHORr� �CREDITSr� �FILE)%r, rW rO rH r$ r
r rp r r� r� r
r[ r0 r_ �setr� r� r� r� �addr� rU rZ r� rv r� r� r� rD r� rS r� r� r� r rF )r< r r' r� �synop�descrN r� r ri rw rx rh r� r� �
modpkgs_namesr� rX r� �
submodulesr� r< r� r� r r r r� � s�
�� � �
�
�
� �
$ �zTextDoc.docmodulec sN �j }|p|}�j}�jfdd�}||kr d��|� }n ��|�d | }|r6t||�} |dd�| � }g }
|
j�zt���} W n
t t
fyO d} Y nw | rdt | �} | rd| dkrd�|| d � t ��}
|
rp�|
d � t
t����}t|�d
kr��d � |D ]
}�d ||� � q��d
� tdd� t���D �t jd�}t|�}d}|rЈd� |d|� D ]}�d | � q�||kr̈dt || � d � �d
� G �fdd�d�}|� � � ����fdd�}� ���fdd�}� ����fdd �}�fd d �t��D �}|�r�|�r|�� �n|d d
�t|�fd d!��\}}�tju�r0�tju �r0|}�q��u �r8d"}nd#t��j� }t|�� |d$| |d%d!� �}|d&| |d'd!� �}|d(| |d)d!� �}|d*| |d+d!� �}|d,| |d-d!� �}|d.| |d/d!� �}|g k�s�J �|}|�sd �|
�}
|
�s�|d S |d ��|
� � d0� d S )1z4Produce text documentation for a given class object.c S s
t | |�S r r )rz r� r r r �makename# r� z"TextDoc.docclass.<locals>.makename�class z = class r� rt Nr� rP rR zMethod resolution order:r
rI c s s0 � | ]}|j �d �s|jdkrt|j �V qdS )r� r� N)r, r� r! rD )r� r& r r r r H s �
�
��z#TextDoc.docclass.<locals>.<genexpr>r� r� zBuilt-in subclasses:z ... and z other subclassesc r� )z(TextDoc.docclass.<locals>.HorizontalRulec S r� r� r� r r r r r� Z r� z1TextDoc.docclass.<locals>.HorizontalRule.__init__c r� )NzF----------------------------------------------------------------------rQ r� r r� r r r� \ r� z.TextDoc.docclass.<locals>.HorizontalRule.maybeNr� r r� r r r� Y r� r� c
s� t ||�\}}|r>� �� �| � |D ]*\}}}}zt�|�}W n ty2 ���||��� Y qw ���||���� q|S r r� r� �r� r� r r� r< r r r� b s ��z TextDoc.docclass.<locals>.spillc r� r r� r� r� r r r� s r� z*TextDoc.docclass.<locals>.spilldescriptorsc
s� t ||�\}}|rB� �� �| � |D ].\}}}}t|�}zt�|�} W n ty2 |j| } Y nw ��j| |�d|d�d � q|S )Nr )rf r? rP )r r� rO r$ r: �__dict__r� )
r� r� r{ r� r' r� r� rx r? r; r) r r r� | s ��z#TextDoc.docclass.<locals>.spilldatac r� r� r� r� r r r r� � r� z$TextDoc.docclass.<locals>.<listcomp>r c r� r� r r� r� r r r� � r� z"TextDoc.docclass.<locals>.<lambda>r� r� z Methods %s:
c S r� r� r r� r r r r� � r� zClass methods %s:
c S r� r� r r� r r r r� � r� zStatic methods %s:
c S r� r� r r� r r r r� � r� zReadonly properties %s:
c S r� r� r r� r r r r� � r� zData descriptors %s:
c S r� r� r r� r r r r� � r� z Data and other attributes %s:
c S r� r� r r� r r r r� � r� z | ) r, rq r! r �maprU r
r r� r� rF rD rO r r� rT �sortedrC �__subclasses__r
r� r� r r� r rY r� r rM )r< r r' r� r� r� r{ r' r; r| r< r� r� r? r� r> �
subclasses�no_of_subclasses�MAX_SUBCLASSES_TO_DISPLAY� subclassnamer� r� r� r� r� r� r� r )r� r� r r� r< r� r r� s�
� �
��
�
�
�
�
�
�
�
��
# zTextDoc.docclassc C s d| � |� S r� r� r% r r r r� � � zTextDoc.formatvaluec C s� |j }|p|}d}d}t|�r7|jj}|r!||ur dt||� }n|jdur0dt|jj|� }ndt||� }t�|�sAt�|�rDd} nd} ||krP| �|�}
n|r]t� ||g �|u r]d}| �|�d | }
d} t�
|�r�zt� |�} W n
t t
fy� d} Y nw | r�t| �} |d
kr�| �|�d }
| dd � } | s�d
} | |
| | }
|r�|
d S t|�p�d}|
d |o�| �|��� d S )z;Produce text documentation for a function or method object.rI r r� Nr� r� r� rQ � = r� z lambda r r� rP )r, rn r- r. rY r r� r� r r� r[ r� r� rF rD rO r rM )r< r r' r� ru r� r� r� r� r� r; r� r� r� r? r r r r� � sX �
�
�
� zTextDoc.docroutinec C sT g }|j }|r|| �|�� |d� t|�pd}|r%|| �|�� |d� d�|�S )z1Produce text documentation for a data descriptor.rP rI )r
r rO r rU r� r r r r� � s
zTextDoc.docdatac
C s� | � |�}|r#|r
|d pd| }|t|� } | dk r#|d| � d }|r,| �|�d p-d| }|s6t|�}|rE|d| �t|�� d 7 }|S )z-Produce text documentation for a data object.r3 rI r Nrd rP )r� rT r rO r rD )
r< r r' r� rx rf r? r� r� �chopr r r r� s
zTextDoc.docother)r
)NrI r� r )NNNNN)r, r! r" rA r r r� r r rH rv r� r� r� r� r� r r� r r r r r � s
e
7r c @ s e Zd ZdZdd� ZdS )�
_PlainTextDocz2Subclass of TextDoc which overrides string stylingc C s |S r r r# r r r r � z_PlainTextDoc.boldN)r, r! r" rA r r r r r r5 s r5 c C s t � at| � dS )zCThe first time this is called, determine what kind of pager to use.N)�getpager�pagerrk r r r r8 s r8 c sd t tjd�stS t tjd�stS tj�� rtj�� s tS tj�d�p'tj�d�� � rItj dkr5� fdd�S tj�d�dv rC� fd d�S � fd
d�S tj�d�dv rStS tj dkr\d d� S t td �rlt�
d
�dkrldd� S t td �r|t�
d�dkr|dd� S ddl } | � � \}}t�
|� z t td �r�t�
d| �dkr�dd� W t�|� S tW t�|� S t�|� w )z2Decide what method to use for paging through text.�isatty�MANPAGER�PAGER�win32c � t t| �� �S r ��
tempfilepager�plainrk �� use_pagerr r r� ( r� zgetpager.<locals>.<lambda>�TERM)�dumb�emacsc r= r )� pipepagerr@ rk rA r r r� * r� c s
t | � �S r �rF rk rA r r r� , �
c S s t t| �d�S )Nzmore <r> rk r r r r� 0 r� �systemz(pager) 2>/dev/nullr c S �
t | d�S )Nr8 rG rk r r r r� 2 rH z(less) 2>/dev/nullc S rJ )N�lessrG rk r r r r� 4 rH Nz more "%s"c S rJ )N�morerG rk r r r r� ; rH )r� r �stdin�
plainpager�stdoutr9 r r r �platformrI �tempfile�mkstemp�close�unlink�ttypager)rQ �fdr� r rA r r7 s<
�r7 c C s t �dd| �S )z%Remove boldface formatting from text.z.rI )rK rL rk r r r r@ A r2 r@ c C s� ddl }|j|d|jdd�}z&|j�}z|�| � W n ty# Y nw W d � n1 s.w Y W n ty= Y nw z|�� W dS tyO Y nw q?)z3Page through text by feeding it to another program.r NT�backslashreplace)�shellrM �errors)�
subprocess�Popen�PIPErM �write�KeyboardInterruptr� �wait)r` �cmdrZ �proc�piper r r rF E s2 � �� �� � ��rF c C s� ddl }|�� �B}tj�|d�}t|ddtjdkr t�d�ndd��
}|� | � W d � n1 s2w Y t�
|d | d � W d � dS 1 sMw Y dS )
z<Page through text by invoking a program on a temporary file.r Nz pydoc.out�wrW r< )rY �encodingz "ra ) rQ �TemporaryDirectoryr r rU r� r rP �device_encodingr] rI )r` r` rQ �tempdirr� r� r r r r? ] s
�� �"�r? c C s$ t tjdd �pd}| �|d��|�S )Nrd �utf-8rW )r$ r rO �encode�decode)r` rd r r r �_escape_stdouti s rk c
C s� t t| ���d�}zddl}tj�� }|�|�}|�|� dd� }W n t t
t j fy5 d}dd� }Y nw z�z t
tj�dd��}W n tyM d}Y nw |dkrTd }|d }}tj�d�|d|� �d � ||d� r�tj�d
� tj�� |� } | d v r�tj�d � nB| d
v r�tj�d || d � |d }qi| dv r�|| | }|dk r�d}tj�dd�|||| � � d � || }||d� soW |r�|�||j|� dS dS |r�|�||j|� w w )z%Page through text on a text terminal.rP r Nc S s t j�d�S ro )r rM r� r r r r r� v r� zttypager.<locals>.<lambda>c S s t j�� d d� d d� S )Nr rQ )r rM r� r r r r r� y s �LINESrQ � z
-- more --)�q�Qz
)�
rP )�b�B�)r@ rk r# �ttyr rM �fileno� tcgetattr� setcbreakr� r: �io�UnsupportedOperationrg r r r r� rO r] rU �flush� tcsetattr� TCSAFLUSH)
r` rV rt rV �old�getchar�hr. �incrz r r r rU n sX
� �
& ����rU c C s t j�tt| ��� dS )z>Simply print unformatted text. This is the ultimate fallback.N)r rO r] r@ rk rk r r r rN � s rN c C s� t �| �r | jtjv rd| j S t| d�rd| j S d| j S t �| �r)d| j S t �| �r:d| jj | jj| jf S t �
| �rKd| jj | jj| jf S t | �rTd| j S t � | �r^d | j S t �
| �rhd
| j S t| �jS ) z/Produce a short description of the given thing.zbuilt-in module r� zpackage zmodule zbuilt-in function zgetset descriptor %s.%s.%szmember descriptor %s.%s.%sr( z function zmethod )r rZ r, r r� r� r0 �isgetsetdescriptorr5 r! r6 r r/ r+ rC )�thingr r r �describe� s2
�
�
r� c C s� dd� | � d�D �}d\}}|t|�k r3td�|d|d � �|�}|r,||d }}nn|t|�k s|r8|}nt}||d� D ]}zt||�}W q@ tyT Y dS w |S )z@Locate an object by name or dotted path, importing as necessary.c S s g | ]}|r|�qS r r )r� r� r r r r� � r� zlocate.<locals>.<listcomp>r r� NrQ )r# rT r� rU r� r$ r: )r r� r� r� �n�
nextmoduler r� r r r �locate� s" � �r� c C sT t | t�rt| |�}|du rtd| ��|| fS t| dd�}| t |t�r'|fS dfS )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� r r' r r r �resolve� s
� r� � Python Library Documentation: %sc C s� |du rt }t| |�\}}t|�}t�|�}|r*d|v r*|d|d|�d�� 7 }n
|r7||ur7|d|j 7 }t�|�s_t|�s_t� |�s_t�
|�s_t |�s_t |d�rW|j
}nt|�}|d7 }|| d |�||� S )zBRender text documentation, given an object or a path to an object.Nr z in z in module �
__origin__z objectrJ )r` r� r� r r� �rfindr, rZ r r[ r4 rH r� r� rC r� )r� r; r� �rendererr r' r$ r� r r r �
render_doc� s.
����
r� c
C sl z |du rt t| ||�� W dS |�t| ||t�� W dS ttfy5 } z t|� W Y d}~dS d}~ww )zCDisplay text documentation, given an object or a path to an object.N)r8 r� r] � plaintextr� r� �print)r� r; r� �outputrx r r r r? � s ��r? c
C s� z;t | |�\}}t�t|�t�||��}t|d ddd��
}|�|� W d � n1 s-w Y td|d � W dS tt fyT } z t|� W Y d}~dS d}~ww )z<Write HTML documentation to a file in the current directory.r rc rh )rd N�wrote)
r� �htmlr= r� r� r� r] r� r� r� )r� r� r r' r= r� rx r r r �writedoc s ���r� rI c C s2 |du ri }t �| g|�D ] \}}}t|� q
dS )zAWrite out HTML documentation for all modules in a directory tree.N)r� �
walk_packagesr� )r �pkgpath�doner� rX r� r r r � writedocs s
r� c @ s� e Zd Zi dd�dd�dd�dd�dd�d d
�d d �d
d�dd�dd�dd�dd�dd�dd�dd �d d �d d �i d d!�d"d#�d$d%�dd&�d#d'�d(d)�d*d+�d,d-�d.d/�d0d�d1d�d2d3�d4d5�d6d7�d d8�d9d:�dd;��d<d=i�Zd>d?� d@D �ZdAdBdCdDge�R dEdFdGdHdIdJdK�ZdLdMdNdOdPdQdRdSdTdUdVdWdWdXdXdY�Ze�� D ] \ZZ e D ]Z
e� e
e�Z ee vr�e dZ e Z e ee
< q�q�i d[d\�dSd]�d^d_�d`da�dbdc�ddde�dfdg�dhdi�djdk�dldm�dndo�dpdq�drds�dtdu�dvdw�dxd[�dyd[�i dzd{�dPd|�d}d~�dd��d�d��d�d#�d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d���i d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d��d�d��dTd��d�d��d�dl�d�d��d�d��d�d��dod��d�d���i d�d��d�d��d�d��d�d��dMd��d�d��d�d��d�dÓd�dœd+dƓddǓd�d �d�dʓd�d̓d�d�d�d6�d�d#��dd�d�d�d�dԜ�Z d�d�dׄZ
ed�dل �Zed�dۄ �Zd�d݄ Ze� Zefd�d߄Zd�d� Zd�d� Zd�d� Zd�d� Zd�d�d�Zd�d� Zd�d� Zd�d� Z d�d�d�Z d�d�d��Z d�d�� Z d�d�d��Z d�S )��Helper�FalserI �None�True�and�BOOLEAN�as�with�assert)r� rI �async)r� rI �await)r� rI �break)r� � while for�class)r� zCLASSES SPECIALMETHODS�continue)r� r� �def)�functionrI �del)r� � BASICMETHODS�elif�if�else)r� r� �except�try�finally�for)r� zbreak continue while�from�import�global)r� znonlocal NAMESPACES)r� �
TRUTHVALUE)r� �MODULES�in)r� �SEQUENCEMETHODS�is�
COMPARISON�lambda)r� r �nonlocal)r� zglobal NAMESPACES�not�or�pass)r� rI �raise)r� �
EXCEPTIONS�return)r� r )r� r� �while)r� z break continue if TRUTHVALUE)r� z CONTEXTMANAGERS EXCEPTIONS yield�yield)r� rI c C s g | ] }d D ]}|| �qqS )��'ra r )r� �prn r r r r� L r� zHelper.<listcomp>)rq �fr. �ur� z'''ra r� )�+r� �*�**r z//�%�<<�>>r �|�^�~r! r" �<=�>=�==�!=�<>)r! r" r� r� r� r� r� )r� r� ) z+=z-=z*=z/=z%=z&=z|=z^=z<<=z>>=z**=z//=)r� r� r r� r� r� )�j�J)�STRINGS� OPERATORSr� �UNARY�AUGMENTEDASSIGNMENT�BITWISE�COMPLEXzOPERATORS FORMATTING�POWERzTUPLES LISTS FUNCTIONSz ATTRIBUTES FLOAT MODULES OBJECTS�ELLIPSISzSLICINGS DICTIONARYLITERALSz def classr� � PRIVATENAMESzPRIVATENAMES SPECIALMETHODS�
BACKQUOTESzTUPLES FUNCTIONS CALLSzLISTS SUBSCRIPTS SLICINGS)r� r� �,r rd �:�@r� r� r� �`rb ru �[�]r� �TYPES)r zRSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect)�stringsz4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPES�
STRINGMETHODS)zstring-methodszSTRINGS FORMATTING�
FORMATTING)�
formatstringsr� �UNICODE)r� z:encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPES�NUMBERS)�numberszINTEGER FLOAT COMPLEX TYPES�INTEGER)�integersz int range�FLOAT)�floatingz
float mathr� )� imaginaryz
complex cmath� SEQUENCES)�typesseqz$STRINGMETHODS FORMATTING range LISTS�MAPPINGS� DICTIONARIESr )�typesfunctionsz def TYPES�METHODS)� typesmethodszclass def CLASSES TYPES� CODEOBJECTS)zbltin-code-objectszcompile FUNCTIONS TYPES� TYPEOBJECTS)zbltin-type-objectsz types TYPES� FRAMEOBJECTS�
TRACEBACKS�NONE)zbltin-null-objectrI )zbltin-ellipsis-object�SLICINGS�SPECIALATTRIBUTES)� specialattrsrI r )r z!class SPECIALMETHODS PRIVATENAMESr� )� typesmodulesr� �PACKAGES� EXPRESSIONS)zoperator-summaryz�lambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIESr� �
PRECEDENCE�OBJECTS)�objectsr� �SPECIALMETHODS)� specialnameszbBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSESr� )�
customizationz hash repr str SPECIALMETHODS�ATTRIBUTEMETHODS)zattribute-accesszATTRIBUTES SPECIALMETHODS�CALLABLEMETHODS)zcallable-typeszCALLS SPECIALMETHODSr� )�sequence-typesz(SEQUENCES SEQUENCEMETHODS SPECIALMETHODS�MAPPINGMETHODS)r zMAPPINGS SPECIALMETHODS�
NUMBERMETHODS)z
numeric-typesz*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS� EXECUTION)� execmodelz%NAMESPACES DYNAMICFEATURES EXCEPTIONS�
NAMESPACES)�namingz3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURES�DYNAMICFEATURES)zdynamic-featuresrI �SCOPING�FRAMESr� )r� ztry except finally raise� CONVERSIONS)� conversionsrI � IDENTIFIERS)� identifierszkeywords SPECIALIDENTIFIERS�SPECIALIDENTIFIERS)z
id-classesrI )zatom-identifiersrI �LITERALS)z
atom-literalsz=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALS�TUPLES�
TUPLELITERALS)� exprlistszTUPLES LITERALS�LISTS)ztypesseq-mutable� LISTLITERALSr$ )�listszLISTS LITERALS)� typesmapping�DICTIONARYLITERALSr' )r7 zDICTIONARIES LITERALS�
ATTRIBUTES)zattribute-referencesz(getattr hasattr setattr ATTRIBUTEMETHODS�
SUBSCRIPTS)�
subscriptionsr� r )�slicingsr� �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)�debugger�pdb)zcontext-managersr� )� CONDITIONAL�LOOPINGr� � DEBUGGING�CONTEXTMANAGERSNc C s || _ || _d S r )�_input�_output)r< �inputr� r r r r� � s
zHelper.__init__c C � | j ptjS r )rF r rM r r r r rH � r` z Helper.inputc C rI r )rG r rO r r r r r� � r` z
Helper.outputc C s2 t �� d d dkr| � dS d| jj| jjf S )NrQ rc �?rI z<%s.%s instance>)r �stackr. r! r" r r r r �__repr__� s �zHelper.__repr__c C s8 || j ur | �|� d S | �� | �� | 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__� s
zHelper.__call__c C s� | j �d� z | �d�}|sW d S W n ttfy Y d S w |�� }t|�dkrJ|d |d kr8dv rJn n|d |dd� vrJ|dd� }|�� d v rRd S |d
kr[| �� n| � |� q) NrP Tzhelp> rR r r r� rQ )rn �quitr )
r� r] �getliner^ �EOFErrorrS rT r
rN r rP r r r rO � s"
�,
�zHelper.interactc C s4 | j tju r
t |�S | j�|� | j�� | j �� S )z.Read one line, using input() when appropriate.)rH r rM r� r] rz r� )r< �promptr r r rT � s
zHelper.getlinec C s8 t |�t d�u r�|�� }|dkr| �� n|dkr | �� nv|dkr'| �� nm|dkr0| �� nd|d d� dkrB| �|�� d � nR|| jv rM| �|� nG|d v rYt t
|�d
� n;|| j v rd| � |� n0|| j
v ro| � |� n%|rzt |d
| jd � nt td
| jd � nt|t�r�| � nt |d
| jd � | j�d � d S )
NrI �keywords�symbols�topicsr � zmodules rQ )r� r� r� z Help on %s:)r� rP )rC rS � listkeywords� listsymbols�
listtopics� listmodulesr# rX �
showsymbolr? �evalrW � showtopicrY rG rD r r� r� r] rP r r r r s$ z Helper.helpc C s$ | j �d�dtjd d� �� 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 on the internet 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 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".
z%d.%drR )r� r] r r r r r r r rN s �z Helper.intror� �P c
C s� t t|��}|| }t|�| d | }t|�D ];}t|�D ].}|| | }|t|�k rL| j�|| � ||d k rL| j�dd|d t|| � � q | j�d� qd S )NrQ r� rP )rO r, rT rN r� r] ) r< �items�columnsrD �colwrQ �rowrR r� r r r rO , s $��z Helper.listc C � | j �d� | �| j�� � d S )NzN
Here is a list of the Python keywords. Enter any keyword to get more help.
)r� r] rO rW rt r r r r r[ 9 � zHelper.listkeywordsc C rg )Nzx
Here is a list of the punctuation symbols which Python assigns special meaning
to. Enter any symbol to get more help.
)r� r] rO rX rt r r r r r\ @ s zHelper.listsymbolsc C rg )NzN
Here is a list of available topics. Enter any topic name to get more help.
)r� r] rO rY rt r r r r r] H rh zHelper.listtopicsc C s* zdd l }W n ty | j�d� Y d S w | j�|| j�|��}|s0| j�dt|� � d S t|�td�u r>| � ||�S |\}}z|jj| }W n t
y^ | j�dt|� � Y d S w |� � d }|ro|pjdd | }|r�dd l }dd�
|�� � d } |�| d �}
|d
d�
|
� 7 }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
rI rP r� �Related help topics: rt �H z
%s
)�pydoc_data.topicsr� r� r] rY r rW r� rC ra �KeyErrorrS �textwraprU r# �wrapr8 ) r< �topic�
more_xrefs�
pydoc_data�target�label�xrefsr? rn r` � wrapped_textr r r ra O s8 � � zHelper.showtopicc C s� zddl }W n
ty Y dS w | j�|| j�|��}|s"td��t|t�r-| �||�S |\}}|jj| }|rA|p<dd | }||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)ri rI zcould not find topicrI r� ) rl r� rY r rW r� r rD � _gettopic)r< rp rq rr rs rt ru r? r r r rw o s �
zHelper._gettopicc C s* | j | }|�d�\}}}| �||� d S )Nr� )rX � partitionra )r< �symbolrs rp r� ru r r r r_ � s
zHelper.showsymbolc sx |r| j �d�|�� t|� d S | j �d� i }|fdd�� � fdd�}t� j� |d� | �|�� � | 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 sB |r|dd � dkr|d d� d }|� d�dk r d||< d S d S )N���� .__init__r r r rQ )�find)r rX r$ r r r r �callback� s
�z$Helper.listmodules.<locals>.callbackc s � d | d � d S r r r �r} r r �onerror� s z#Helper.listmodules.<locals>.onerror�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�
ModuleScanner�runrO rt )r< rw r r r r~ r r^ � s � zHelper.listmodulesr� )r� rb r )!r, r! r" rW � _strprefixes�_symbols_inverserX rc rp �symbols_ry r rY r� r1 rH r� rL r rM rR rO rT r rN rO r[ r\ r] ra rw r_ r^ r r r r r� s
�������� �
� � �
��������������� � � � � �!�"�#�'� �
������ �
� � �
��������������� � �!�"�%�&�'�(�*�+�-�.�/�0�1�2�3�4�5�6�7�9�:�;�<�=�>�?�@�A�B�C�D�E�F�G�H�I�J�K�L�M�N�O�P�
W
r� c @ s e Zd ZdZddd�ZdS )r� z7An interruptible scanner that searches module synopses.Nc C s� |r|� � }d| _i }tjD ]8}|dkrFd||< |d u r#|d |d� qt|�jp)d}|�d�d }|d | }|� � �|�dkrF|d ||� qtj |d�D ]�\} }}
| jrW n�|d u rb|d |d� qMzt�
| |�} W n t ys Y qMw | j } t
| d �r�z| �|�}
W n ty� |r�||� Y qMw tt�|
��p�d}t
| d
�r�| �|�}n-d }n*ztj�| �}W n ty� |r�||� Y qMw |jr�|j�� d nd}t|d d �}|d | }|� � �|�dkr�||||� qM|r�|� d S d S ) NF�__main__rQ rI rP r r r� �
get_source� get_filenamer� )r
rS r r� r� rA r# r| r� r� � _get_specr� r� r� r� r� r� rx �StringIOr� r� r� r� r� r� r$ )r< r} rw � completerr �seenrX r' r$ r� r� r� r� �sourcer r� r r r r� � sj
� �
�
� �
�zModuleScanner.runr )r, r! r" rA r� r r r r r� � s r� c C sZ dd� }dd� }t �� � t �d� t� j|| |d� W d � dS 1 s&w Y dS )zAPrint all the one-line module summaries that contain a substring.c S s6 |dd � dkr|d d� d }t ||od| � d S �Nrz r{ r z- )r� �r rX r$ r r r r} � s zapropos.<locals>.callbackc S � d S r r r r r r r � r6 zapropos.<locals>.onerror�ignorer� N)�warnings�catch_warnings�filterwarningsr� r� )rw r} r r r r r� � s
"�r� c s� ddl �ddl�ddl�ddl�G dd� d�jj�� G �fdd�d�jj��G � ����fdd�d�j�}|| ||�}|�� |j sP|j
sPt � d � |j sP|j
rE|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 @ s e Zd Zdd� Zdd� ZdS )z!_start_server.<locals>.DocHandlerc S sX | j �d�r d}nd}| �d� | �dd| � | �� | j�| �| j |��d�� dS ) 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.css�text/css� text/html�� z Content-Typez%s; charset=UTF-8rh N) r r� �
send_response� send_header� end_headers�wfiler] �
urlhandlerri )r< � content_typer r r �do_GET7 s
��z(_start_server.<locals>.DocHandler.do_GETc W r� r r )r< r� r r r � log_messageG s z-_start_server.<locals>.DocHandler.log_messageN)r, r! r" r� r� r r r r �
DocHandler5 s r� c s( e Zd Zdd� Z� fdd�Zdd� ZdS )z _start_server.<locals>.DocServerc S s6 || _ | j |f| _|| _| j�| | j| j� d| _d S �NF)�host�addressr} r> r� �handlerrS )r< r� �portr} r r r r� M s
z)_start_server.<locals>.DocServer.__init__c sB | j s� �| j�� gg g d�\}}}|r| �� | j r| �� d S ro )rS �select�socketru �handle_request� server_close)r< �rd�wr�ex�r� r r �serve_until_quitT s � z1_start_server.<locals>.DocServer.serve_until_quitc S s$ | j �| � | jr| �| � d S d S r )r> �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 � DocServerK s r� c s: e Zd Z�fdd�Z� ���fdd�Zdd� Zdd� Zd S )
z#_start_server.<locals>.ServerThreadc s2 || _ || _t|�| _� j�| � d| _d | _d S r� )r� r� rg r� �Threadr� �serving�error)r< r� r� r� )� threadingr r r� b s
z,_start_server.<locals>.ServerThread.__init__c
sz z&�j j�_� �_�jj� _t| j�� _�| j | j
| j �}|| _ |�
� W dS ty< } z
|| _W Y d}~dS d}~ww )zStart the server.N)�server�
HTTPServerr> r� r� �Message� MessageClass� staticmethodr� r� r� �ready� docserverr� r� r� )r< �docsvr�e)r� r� �email�httpr r r� j s
��z'_start_server.<locals>.ServerThread.runc S s, d| _ |j| _|j| _d| j| jf | _d S )NTz
http://%s:%d/)r� r� � server_portr� r] )r< r� r r r r� w s z)_start_server.<locals>.ServerThread.readyc S s& d| j _| �� d| _ d| _d| _dS )z&Stop the server and this thread nicelyTNF)r� rS rU 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�?)
� http.server�
email.messager� r� r� �BaseHTTPRequestHandlerr� r� rm r� r� �time�sleep)r� �hostnamer� r� �threadr )r� r� r� r� r� r� r �
_start_server� s 8 '
�r� r� c s, G �fdd�dt �}|� � � fdd��� fdd��� fdd��� fd d
��� fd d ��� fd
d��� fdd��� fdd��� �������fdd�}| �d�rU| dd� } |dkr�tj�tj�t��}tj�|| �}t|��}d�|� � �W d � S 1 s�w Y n|dkr�|| �S t
d|| f ��) 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 Zd Z� fdd�ZdS )z _url_handler.<locals>._HTMLDocc s d}d| }d||� � |f S )r: 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_path�css_link�� html_navbarr r r= � s �� �z#_url_handler.<locals>._HTMLDoc.pageN)r, r! r" r= r r� r r �_HTMLDoc� s r� c s> � � dt�� t�� d t�� f �} d| � � tjdd��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>
T)�terse)r$ rP �python_version� python_build�python_compiler)r� �r� r r r� � s
��z!_url_handler.<locals>.html_navbarc s� dd� } � � ddd�}dd� tjD �}� �|| �}|d� �d dd
|� g}i }tjD ] }|�� �||�� q*|�d � d d
�|�fS )zModule Index page.c S � d| | f S �NrY r �r' r r r � bltinlink� r& z3_url_handler.<locals>.html_index.<locals>.bltinlinkz7<big><big><strong>Index of Modules</strong></big></big>r� r� c S s g | ]}|d kr|�qS )r� r )r� r' r r r r� � s �z4_url_handler.<locals>.html_index.<locals>.<listcomp>z<p>zBuilt-in Modulesr� z|<p align=right><font color="#909090" face="helvetica,arial"><strong>pydoc</strong> by Ka-Ping Yee<[email protected]></font>zIndex of ModulesrI ) rB r r� rS rI r r
r rU )r� rB �namesr< r� r r� r r �
html_index� s" � �
�z _url_handler.<locals>.html_indexc s� g � � fdd�}t �� � t �d� dd� }t� j|| |d� W d � n1 s)w Y dd � }g }��d
d d �}� D ]
\}}|�||�| � q=|��d
| d dd�|�� }d|fS )zSearch results page.c s: |dd � dkr|d d� d }� � ||od| f� d S r� ry r� ��
search_resultr r r} � s z3_url_handler.<locals>.html_search.<locals>.callbackr� c S r� r r r r r r r � r6 z2_url_handler.<locals>.html_search.<locals>.onerrorr� Nc S r� r� r r� r r r r� � r& z4_url_handler.<locals>.html_search.<locals>.bltinlinkz5<big><big><strong>Search Results</strong></big></big>r� r� zkey = %sr� �<br>zSearch Results) r� r� r� r� r� rB r
rI rU ) rw r} r r� r� rB r' r$ r< r� r� r � html_search� s&
�� �z!_url_handler.<locals>.html_searchc sL dd� } � � ddd�}ttj�� �}� �|| �}|� �ddd|� }d|fS )z Index of topic texts available.c S r� �Nz <a href="topic?key=%s">%s</a>r r� r r r r�
r& z4_url_handler.<locals>.html_topics.<locals>.bltinlink�,<big><big><strong>INDEX</strong></big></big>r� r� �Topicsr� )rB r, r� rY rt rS rI )r� rB r� r< r� r r � html_topics� s � �z!_url_handler.<locals>.html_topicsc sL � � ddd�} ttj�� �}dd� }� �||�}| � �ddd|� }d|fS )zIndex of keywords.r� r� r� c S r� r� r r� r r r r�
r& z6_url_handler.<locals>.html_keywords.<locals>.bltinlink�Keywordsr� )rB r, r� rW rt rS rI )rB r� r� r< r� r r �
html_keywords
s � �z#_url_handler.<locals>.html_keywordsc s� t �� }t||�}|�| �\}}| |jv rd}nd}� �d| dd�}d� �|� }� �| dd|�}|rLt|� � �}dd � }� �
||�}� � d
dd|�}d || f d � |||f�fS )
zTopic or keyword help page.�KEYWORD�TOPICr} r� r� z
<pre>%s</pre>r� c S r� r� r r� r r r r� -
r& z7_url_handler.<locals>.html_topicpage.<locals>.bltinlinkrj z%s %srI )
rx r� r� rw rW rB rs rI r, r# rS rH rU )rp �buf�htmlhelpr< ru r; rB r� r� r r �html_topicpage
s,
� �
�z$_url_handler.<locals>.html_topicpagec s@ t | dd�}|d u r| dkrtd��t|�}� �|| �}||fS )NrQ )r� r� zcould not find object)r� r� r� r� )r] r; r; �contentr� r r � html_getobj6
s z!_url_handler.<locals>.html_getobjc sP � � ddd�}d�� fdd�tt|�|�D ��}|� �| dd|� }d| |fS ) Nz,<big><big><strong>Error</strong></big></big>r� r� r� c 3 s � | ]}� � |�V qd S r )r$ r r� r r r B
r z3_url_handler.<locals>.html_error.<locals>.<genexpr>z#bb0000z
Error - %s)rB rU r rC rI )r] r� rB r< r� r r �
html_error>
s � � � z _url_handler.<locals>.html_errorc
s` | }| � d�r
| dd� } z�| dv r�� \}}nw| dkr"�� \}}nm| dkr,�� \}}ncd| v r�| �d�\}}} |dkrC�| �\}}nL|d kr_z�| �\}}W n? ty^ �| �\}}Y n1w |d
kr�| dv rm�� \}}n"z�| �\}}W n ty� �| �\}}Y n w td ���| �\}}W n ty� } z
�||�\}}W Y d}~nd}~ww � �||�S ) z Generate an HTML page for url.r N���)rI r rY rW r� z
search?keyz topic?keyzget?keyz
bad pydoc url)r� rx r� r� r= )r] � complete_urlr; r� �opr� r� )r� r� r� r� r� r� r� r� r r �
get_html_pageH
sH
� � ��� z#_url_handler.<locals>.get_html_pager rQ Nr� rI r� z"unknown content type %r for url %s) r8 r� r r �dirname�realpathr� rU r� � readlinesrF )r] r� r� r� � path_herer� �fpr ) r� r� r� r� r� r� r� r� r� r � _url_handler� s,
(
"�r� T� localhost)� open_browserr� c C s� ddl }tt|| �}|jrt|j� dS |jr|d}|r!|�|j� zMz.td|j� t|� |jrOtd�}|� � }|dkr=n|dkrH|�|j� nt|� |js0W n t
t fy^ t� Y nw W |jrm|� � td� dS dS |jr{|� � td� w w dS ) 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> rn rq zServer stopped)
�
webbrowserr� r� r� r� r� r� r] rH r
r^ rU r� )r� r� r� r� � serverthread�server_help_msgr` r r r �browse}
sD
��
��
�
��r� c C s t | t�o | �tj�dkS r� )r rD r| r �sep)r~ r r r �ispath�
s r� c C sv d| v st j| v st �� | v rdS t j�t�}t j�|�}| �� }|| v r1t j�||�s1|�|� |� dt �� � |S )z�Ensures current directory is on returned path, and argv0 directory is not
Exception: argv0 dir is left alone if it's also pydoc's directory.
Returns a new path entry list, or None if no adjustment is needed.
rI Nr )
r �curdir�getcwdr r� r� �copy�samefile�remove�insert)�
given_path�argv0�
stdlib_dir�
script_dir� revised_pathr r r �_get_revised_path�
s
r c C s0 t tjtjd �} | dur| tjdd�< dS dS )z�Ensures current directory is on sys.path, and __main__ directory is not.
Exception: __main__ dir is left alone if it's also pydoc's directory.
r N)r r r �argv)r
r r r �_adjust_cli_sys_path�
s �r
c C s� ddl } G dd� dt�}t� z�| � tjdd� d�\}}d}d}d}d}d}|D ].\} }
| d kr5d
}d
}| d krAt|
� W dS | d krId
}|
}| d
krOd
}| dkrWd
}|
}q)|rdt|||d� W dS |sh|�|D ]W} t| �r�tj �
| �s�t d| � W dS z+t| �r�tj � | �r�t
| �} |r�t| �r�tj �| �r�t| � n
t| � nt�| � W qj ty� } z
t | � W Y d} ~ qjd} ~ ww W dS | j|fy� tj �tj �tjd ��d }
t dj|
tjd�� Y dS w )z@Command-line interface (looks at sys.argv to decide what to do).r Nc @ s e Zd ZdS )zcli.<locals>.BadUsageN)r, r! r" r r r r �BadUsage�
r� r rQ zbk:n:p:wFr� z-bTz-kz-pz-wz-n)r� r� zfile %r does not exista� pydoc - the Python documentation tool
{cmd} <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� r� r� r r� r� r r� r� r� r� r r� )r r �optsr� �writing� start_serverr� r� r� �opt�val�argrx r` r r r �cli�
sl �
���� ��r r� r� )r )r� r N)rI N)r� )`rA r� r� r� r� r� �importlib._bootstrapr� � importlib._bootstrap_external�importlib.machinery�importlib.utilr rx r r� rP rK r r r� r� r � urllib.parser� r� � collectionsr �reprlibr � tracebackr r r r( r@ r9 rH rO rW rY r_ rb ri rc �
IGNORECASErj rl rn rs r r� r� r� r� r� r� r� r� r� r� r� r r8 r r r5 r8 r7 r@ rF r? rk rU rN r� r� r` r� r� r� r� r? r� r� r� r r� r� r� r� r� r� r r
r r, r r r r �<module> s� *
3
'
0;* ; $ ,
�
�
=
n%
U
�