Google
Edit File: pydoc.cpython-39.pyc
a �i � � @ s* 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^�ZOd�d`da�ZPd�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 )�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 https://docs.python.org/X.Y/library/ This can be overridden by setting the PYTHONDOCS environment variable to a different URL or to a local directory containing the Library Reference Manual pages. �helpzKa-Ping Yee <ping@lfw.org>z26 February 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 ]H}tj�|p d�}tj�|�}||vrtj�|�r| �|� |�|� q| S )zAConvert sys.path into a list of absolute, existing, unique paths.�.)�sys�path�os�abspath�normcase�isdir�append)�dirsZnormdirs�dir�normdir� r � /usr/lib64/python3.9/pydoc.py�pathdirsR s r c C s t �| �ot| tj� S �N)�inspectZisclass� isinstance�types� GenericAlias��objectr r r �_isclass^ s r c C sN t j�| j�}|d u rd S | j�d�d d� D ]}t||�}q.t|�sJd S |S )Nr ���)r �modules�get� __module__� __qualname__�split�getattrr )�func�cls�namer r r � _findclassa s r& c C s� t �| �rH| jj}| j}t|�r>tt||d �d�| ju r>|}n|j}�n"t �| �r|| j}t | �}|d u svt||�| urzd S n�t � | �r�| j}| j}t|�r�|j d | | j kr�|}n|j}n�t | t �r�| j}|j}t |�}|d u s�t||�| ur�d S ntt �| ��st �| ��rf| j}| j}t||�| u�r.d S t �| ��rjt|dd �}t |t��rj||v �rj|| S nd S |jD ]F}ztt||��}W n t�y� Y �qpY n0 |d u�rp| S �qpd S )N�__func__r � __slots__)r �ismethodr' �__name__�__self__r r" � __class__� isfunctionr& � isbuiltinr r �property�fgetZismethoddescriptor�isdatadescriptor� __objclass__�ismemberdescriptor�dict�__mro__� _getowndoc�AttributeError)�objr% �selfr$ r# �slots�base�docr r r �_finddock sZ � � r= c C sd zJt �| d�}|du r W dS | turFt| �j}t|t�rF||krFW dS |W S ty^ Y dS 0 dS )zUGet the documentation string for an object if it is not inherited from its class.�__doc__N)r �__getattribute__�typer> r �strr7 )r8 r< Ztypedocr r r r6 � s r6 c C sN t | �}|du r6z t| �}W n ttfy4 Y dS 0 t|t�sDdS 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)r6 r= r7 � TypeErrorr rA r Zcleandoc)r r< r r r �_getdoc� s rC c C s, t | �pt�| �}|r(t�dd|�� �p*dS )z-Get the doc string or comments for an object.z^ * � )rC r Z getcomments�re�sub�rstrip)r �resultr r r �getdoc� s rI c C sf | � � �d�}t|�dkr&|d dfS t|�dkrX|d �� sX|d d�|dd� �fS dd�|�fS )z>Split a doc string into a synopsis line (if any) and the rest.� � r rD � N)�stripr! �lenrG �join)r< �linesr r r �splitdoc� s rQ 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 rS c C s< t �| �p8t| �p8t �| �p8t �| �p8t �| �p8t �| � S )z>Check if an object is of a type that probably means it's data.)r �ismoduler � isroutineZisframeZ istracebackZiscoder r r r �isdata� s ����rV c G s. |r*|d � | �|d ��} |dd� }q | S )z/Do a series of global replacements on a string.rK r rL N)rO r! )�text�pairsr r r �replace� s rY c C sX t | �|krTtd|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 � rL N�...)rN �max)rW �maxlen�preZpostr r r �cram� s $r_ 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_stripidrF �rW r r r �stripid� s rb c C s< t �| �rdS t �| �r8t| dd�}t �|�p4|du S dS )zo Returns True if fn is a bound method, regardless of whether fn was implemented in Python or in C. Tr+ NF)r r) r. r" rT )�fnr9 r r r �_is_bound_method� s rd c C s^ i }t �| t j�D ]\}}d||< q| jD ]}|�t|�� q*|�� D ]}t| |�||< qF|S �NrK )r � getmembersrU � __bases__�update� allmethods�keysr" )�cl�methods�key�valuer; r r r ri � s ri 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� predicateZyes�no�xr r r � _split_list s rt c C s\ | dv r dS | � d�r$| �d�r$dS | � d�r<t|d�r<dS |durL| |v S | � d� S dS ) z3Decide whether to show documentation on a variable.> �__path__r> � __loader__� __package__� __credits__r* � __cached__� __builtins__�__file__�__spec__r r r( � __author__� __version__�__date__r �__rK �_�_fieldsTN)� startswith�endswith�hasattr)r% �allr8 r r r � visiblename s r� c C sX g }t �| �D ]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_attrsr1 r r/ �fsetr )r �resultsr% �kindr$ rn r r r r� ) s r� c sZ t |dg ��z�fdd�t��D �� W n ty< i � Y n0 � fdd�}| j|d� dS )zGSort the attrs list in-place by _fields and then alphabetically by namer� c s i | ]\}}||t � � �qS r )rN )�.0�ir% )�fieldsr r � <dictcomp>: � z#sort_attributes.<locals>.<dictcomp>c s � � | d d�| d fS �Nr )r )�attr)� field_orderr r �<lambda>= r� z!sort_attributes.<locals>.<lambda>�rm N)r" � enumeraterB �sort)�attrsr Zkeyfuncr )r� r� r �sort_attributes4 s r� c C s: t j�| �r6dD ]$}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 �isfilerO )r �extr r r � ispackageB s r� c C s� | � � }|d d� dks |�� s0| � � }|sq0q|�� }|d d� dkrT|dd � }|d d� dkr�|dd � }|dd � dkr�|d d� }|�� s�| � � }|s�q�q�|�d�d �� }nd }|S ) NrK �#� zr"""rZ �"""r �\r )�readlinerM r! )�file�linerH r r r �source_synopsisJ s r� c C s2 t �| �j}|�| d�\}}|du s.||k �r.| �ttjj��rJtjj }n | �ttjj ��rftjj }nd}|du r�zt � | �}W n ty� Y dS 0 |� t|�}W d � n1 s�0 Y n^|d| �}tjjd| |d�}ztj�|�} W n Y dS 0 tjd= | j�r | j�� d nd}||f|| < |S )z.Get the one-line summary out of a module file.)NNNZ__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 r> � splitlines) �filename�cache�mtimeZ lastupdaterH Z loader_clsr� r� �spec�moduler r r �synopsis[ s6 ( � 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� �excrn �tb)r9 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� rn )r9 r� r r r �__str__� s zErrorDuringImport.__str__N)r* r r r> r� r� r r r r r� � s r� c C s� t jj}t| d��"}||�t|��k}W d � n1 s:0 Y tj�| �}tj� |�\}}|rtt j � || �}nt j � || �}t jj || |d�}zt j�|�W S t| t�� ��Y n0 dS )z<Import a Python source file or compiled file given its path.�rbNr� )r� r� � MAGIC_NUMBERr� �readrN 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 0 r� c s z^|rT� t jv rT� t jvrT� fdd�t jD �}� g| D ]}t j| ||< t j|= q8t� �}W nz t �� \}}}} � t jv r�tt j� j| ��n>|tu r�t|j| ��n(t |t �r�|j � kr�Y dS t� t �� ��Y n0 � � d�dd� D ],} zt || �}W q� t�y Y dS 0 q�|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 rK )r r �builtin_module_names� __import__r� r� r{ � SyntaxErrorr� � issubclass� ImportErrorr% r! r" r7 ) r � forceloadr� Zsubsrm r� r� rn 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/libraryNrL c G s� ||f| }zDt �|�r$| j|� W S t|�r8| j|� W S t �|�rN| j|� W S W n tyb Y n0 t �|�rx| j |� S | j |� S )z%Generate documentation for an object.) r rT � docmoduler �docclassrU � docroutiner7 r1 �docdata�docother)r9 r r% �argsr r r �document� s z Doc.documentc G s* d|odt |� t|�jf }t|��dS )z+Raise an exception for unimplemented types.z.don't know how to document object%s of type %s� N)�reprr@ r* rB )r9 r r% r� �messager r r �fail� s �zDoc.failZstdlibc C s� zt �|�}W n ty$ d}Y n0 tj�d| j�}tj�|�}t |t t��r�|j dv sx|� |�r�|� tj� |d��s�|j dvr�|� d�r�d|�d�|j �� f }q�tj� ||j �� d �}nd }|S ) z*Return the location of module docs or None� (built-in)r� ) �errno� exceptions�gc�imp�marshal�posix�signalr �_thread� zipimportz site-packages)z xml.etreeztest.pydoc_mod)zhttp://zhttps://z%s/%s�/�.htmlN)r � getabsfilerB r �environr r� r r r r@ r* r� rO rG �lower)r9 r Zbasedirr� �doclocr r r � getdocloc� s( ���� z Doc.getdocloc)N)N)r* r r r r� r r � version_infor� r� r� r� r� r� r� � docpropertyr� � sysconfigZget_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 s, t �| � d | _| _d| _d | _| _d S �N� � �d �r r� �maxlist�maxtuple�maxdict� maxstring�maxother�r9 r r r r� s zHTMLRepr.__init__c C s t |dddddd�S )N�&z&�<z<�>z>)rY �r9 rW r r r �escape s zHTMLRepr.escapec C s t �| |�S r )r r� �r9 r r r r r� s z HTMLRepr.reprc C sZ t t|�d�r@dd�t|�j�� � }t | |�r@t| |�||�S | �ttt |��| j ��S �Nr* �repr_r� ) r� r@ rO r* r! r" r r_ rb r� r �r9 rs �levelZ methodnamer r r �repr1 s zHTMLRepr.repr1c C s^ t || j�}t|�}d|v rJdt|dd�vrJd|d | �|� |d S t�dd| �|��S )Nr� �\\rD �rr z-((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)z <font color="#c040c0">\1</font>)r_ r r� rY r rE rF �r9 rs r �testZtestreprr r r � repr_string s �zHTMLRepr.repr_stringc C s@ z | � ttt|��| j��W S | � d|jj � Y S 0 d S �Nz <%s instance>)r r_ rb r� r r, r* �r9 rs r r r r � repr_instance* s zHTMLRepr.repr_instanceN) r* r r r> r� r r� r r �repr_strr Z 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,�ZeZd7d-d.�Z d8d/d0�Z dS )9�HTMLDocz'Formatter class for HTML documentation.c C s 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 )r9 �title�contentsr r r �page; s �z HTMLDoc.pagerD 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 )r9 r �fgcol�bgcol�extrasr r r �headingE s �zHTMLDoc.heading� Nr! c C s^ |du rdd| 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 ) r9 r r" r# r �widthZpreludeZ marginaliaZgaprH r r r �sectionP s � ��zHTMLDoc.sectionc G s d| }| j |g|�R � S )z$Format a section with a big heading.z <big><strong>%s</strong></big>)r( )r9 r r� r r r � bigsectionf s zHTMLDoc.bigsectionc C s& | � |�� �}t|dddddddd� S )z!Format literal preformatted text.� z r� r! rJ �<br> )r � expandtabsrY r r r r � preformatk s �zHTMLDoc.preformatr� c C s� d}t |�| d | }t|�D ]X}|dd| }t|| || | �D ]$}|t |�k rJ|||| � d }qJ|d }q d| S )z0Format a list of items into a multi-column list.rD rK z <td width="%d%%" valign=top>r r+ z</td>z7<table width="100%%" summary="list"><tr>%s</tr></table>)rN �range)r9 �list�formatZcolsrH �rows�colr� r r r � multicolumnq s zHTMLDoc.multicolumnc C s d| S )Nz <font color="#909090">%s</font>r r r r r �grey} r� 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 )r9 r% Zdictsr4 r r r �namelink s zHTMLDoc.namelinkc C sN |j tj�|j� }}t||�rDt||�|u rDd|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" rS )r9 r rR 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 |r,d||f }nd| }|rBd| }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)r5 )r4 )r9 Z modpkginfor% r r� �shadowed�urlrW 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 )r9 r; r r r r �filelink� s zHTMLDoc.filelinkc C s� |p| j }g }d}t�d�}|�||�} | s0�qh| �� \} } |�|||| � �� | �� \} } }}}}| r�|| ��dd�}|�d||f � n�|r�dt|� }|�d||| �f � n�|r�dt|� }|�d||| �f � n�|�r"|| | d � d k�r|�d | � ||� � n|�d | � n@|| | d � d k�rP|�| � ||||�� 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+))�"z"r5 z'http://www.rfc-editor.org/rfc/rfc%d.txtz)https://www.python.org/dev/peps/pep-%04d/rK �(zself.zself.<strong>%s</strong>NrD ) r rE �compile�search�spanr �groupsrY �intr6 rO )r9 rW r �funcs�classesrl r� �here�pattern�match�start�endr� �schemeZrfcZpepZselfdotr% r; r r r �markup� s8 zHTMLDoc.markupc C s� d}|D ]�}t |�t d�u r�|\}}|d }|| �||� }|r�||fkr�g }|D ]} |�| �| |�� qR|d d�|� d }|d }qt |�t g �u r|d| �|||� }qd | S ) zAProduce HTML for a class tree as given by inspect.getclasstree().rD r z"<dt><font face="helvetica, arial">r? �, �)z </font></dt>z <dd> %s</dd> z <dl> %s</dl> )r@ r7 r rO � formattree) r9 �treerR �parentrH �entry�c�bases�parentsr; r r r rP � s" � zHTMLDoc.formattreec # s� |j }z |j}W n ty& d}Y n0 |�d�}g }tt|�d �D ],}|�dd�|d|d � �|| f � qFd�||dd� �} d| } z&t� |�} t j � | �} � � | | �} W n ty� d} Y n0 g }t|d��r2t|j�}|dd � d k�r |dd� d k�r |d d� �� }|�d � �|� � t|d ��rT|�� �t|j��� |�rl| dd�|� } � �|�}|du�r�dt� }nd}� �| ddd| | �}t�|tj�}g i }}t�|t�D ]Z\}}|du�s�t�|��p�||u �r�t |||��r�|�||f� d| ||< ||< �q�|D ]�\}}|j D ]n}|j |j }}t j �!|�}||k�r:|�r:t||��r:t"||�|u �r:||v�r:|d | ||< ||< �q:�q,g i }}t�|tj#�D ]p\}}|du�s�t�$|��s�t�|�|u �r�t |||��r�|�||f� d| ||< t�%|��r�|| ||< �q�g } t�|t&�D ]&\}}t |||��rH| �||f� �qH� �'t(|�� j)||�} | �o�d| } |d| }t|d��rg } t*�+|j,�D ] \} }} | �||| df� �q�| �-� � �.| � j/�}!|� �0d dd |!� }n.|�r6� �.|� fd d ��}!|� �0d dd |!� }|�r�d!d"� |D �}"� �1t�2|"d�|�g}!|D ]"\}}|!�� �3|||||�� �qd|� �0d#dd$d%�|!�� }|�r�g }!|D ]"\}}|!�� �3|||||�� �q�|� �0d&dd'd%�|!�� }| �r4g }!| D ] \}}|!�� �3||�� �q�|� �0d(dd)d*�|!�� }t|d+��rh� �'t|j4�� j)�}!|� �0d,dd|!� }t|d-��r�� �'t|j5�� j)�}!|� �0d.dd|!� }|S )/z/Produce HTML documentation for a module object.Nr rK 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)rN z-<br><a href="%(docloc)s">Module Reference</a>rD �#ffffff�#7799eez<a href=".">index</a><br>r� z.html#z#-z <tt>%s</tt>z <p>%s</p> ru r zPackage Contentsz#aa55ccc s � � | d �S re )r9 ��tr r r r� 9 r� z#HTMLDoc.docmodule.<locals>.<lambda>ZModulesc S s g | ] \}}|�qS r r �r� rm rn r r r r� > r� z%HTMLDoc.docmodule.<locals>.<listcomp>ZClasses�#ee77aar� Z Functionsz#eeaa77ZDataz#55aa55r+ r} ZAuthorrx ZCredits)6r* �__all__r7 r! r. rN r rO r r� �urllib�parse�quoter= rB r� rA r~ rM r r r� �localsr% rf rT r � getmoduler� rg r r r r r" rU r. r- rV rM rI r- �pkgutil� iter_modulesru r� r3 r< r) rP � getclasstreer� r} rx )#r9 r r% �mod�ignoredr� �partsZlinksr� Z linkedname�headr r; r= r� �versionr� rH r rF Zcdictrm rn r; rR r� rE Zfdict�datar< �modpkgs�importer�ispkgr � classlistr r r r� � s� �� $ � � � � � ��� � � � � �zHTMLDoc.docmodulec s� �j }|p |}�j}g } | j�G �fdd�d�} | � �tt����} t| �dkr���� �d� | D ]} �d��| �j � � qd�d� � �������fdd�} ����fd d �}� �������fd d �}�fd d�t ��D �}i �|D ]j\}}}}d| d | �|< }zt �|�}W n t �y2 Y n0 z |�|< W q� t �yT Y q�0 q�|�rt| �rn| �� �n |d d �t|�fdd��\}}�tju�r��tju �r�|}�qXn"��u �r�d}nd����j � }|d7 }t|�� | d| |dd� �}| d| |dd� �}| d| |d d� �}|d | |d d� �}|d | |d d� �}|d!| |d"d� �}|g k�slJ �|}�qXd#�| �} ||k�r�d$||f }nd%|||f }|�r�g }|D ]} |���| �j �� �q�|d&d'�|� }d#}zt���}W n tt f�y d(}Y n0 |�r@t|�} | �r@| d)k�r@|��| � d* }t��} |�r\|| �pXd# } ��| �j�� ��} | �o|d+| } ��|d,d-| d.| �S )/z.Produce HTML documentation for a class object.c s e Zd Zdd� Z� fdd�ZdS )z(HTMLDoc.docclass.<locals>.HorizontalRulec S s d| _ d S r� �Zneedoner r r r r� h s z1HTMLDoc.docclass.<locals>.HorizontalRule.__init__c s | j r� d� d| _ d S )Nz<hr> rK rt r ��pushr r �maybej s z.HTMLDoc.docclass.<locals>.HorizontalRule.maybeN�r* r r r� rw r ru r r �HorizontalRuleg s ry rL z&<dl><dt>Method resolution order:</dt> z <dd>%s</dd> �</dl> c s� t ||�\}}|r���� �| � |D ]b\}}}}zt�|�}W n$ tyd ���||��� Y n 0 ���||��� ���� �d� q&|S )NrJ �rt rw r" � Exceptionr� r� ��msgr� rq �okr% r� �homeclsrn �rF rE �hr�mdictrj r rv r9 r r �spillz s � z HTMLDoc.docclass.<locals>.spillc sJ t ||�\}}|rF� �� �| � |D ] \}}}}���||��� q&|S r �rt rw r� r} �r� rj rv r9 r r �spilldescriptors� s z*HTMLDoc.docclass.<locals>.spilldescriptorsc s� t ||�\}}|r���� �| � |D ]r\}}}}��t�|�|��}t|�} | s`�d| � n0��t|��j�� ��} d| } �d|| f � �d� q&|S )Nz<dl><dt>%s</dl> z<dd><tt>%s</tt>z<dl><dt>%s%s</dl> rJ )rt rw r� r" rI rM r- ) r~ r� rq r r% r� r� rn r; r< r� r r � spilldata� s � z#HTMLDoc.docclass.<locals>.spilldatac s, g | ]$\}}}}t |� d �r||||f�qS �)r8 �r� �r� r% r� r$ rn r r r r� � s �z$HTMLDoc.docclass.<locals>.<listcomp>r� �-r c s | d � u S �NrL r r] �� thisclassr r r� � r� z"HTMLDoc.docclass.<locals>.<lambda>� defined here�inherited from %sz:<br> z Methods %sc S s | d dkS �NrK �methodr r] r r r r� � r� zClass methods %sc S s | d dkS �NrK z class methodr r] r r r r� � r� zStatic methods %sc S s | d dkS �NrK z static methodr r] r r r r� � r� zReadonly properties %sc S s | d dkS �NrK r� r r] r r r r� � r� zData descriptors %sc S s | d dkS �NrK r� r r] r r r r� � r� z Data and other attributes %sc S s | d dkS �NrK ro r r] r r r r� � r� rD z*<a name="%s">class <strong>%s</strong></a>z/<strong>%s</strong> = <a name="%s">class %s</a>�(%s)rN N�()r* z<tt>%s<br> </tt>z#000000z#ffc8d8rZ ) r* rg r r r �getmrorN rw r7 r r� r" r| rB �popleftrt �builtinsr r� rO � signature� ValueErrorrA r rI rM r- r( ) r9 r r% rj rE rF rk �realnamerU r ry �mror; r� r� r� r� rm r� r� rn �anchor� inherited�tagr rV �declr� �argspecr< r ) rF rE r� r� rj r rv r9 r� r r� \ s� � � � � � � � � � �� zHTMLDoc.docclassc C s | � d| �|� �S �z)Format an argument default value as text.�=)r4 r� r r r r � formatvalue� s zHTMLDoc.formatvaluec C s� |j }|p |}|r|j pdd | } d} d} t|�r�|jj} |rZ| |ur�d| �| |� } n0|jdurzd| �|jj|� } nd| �| |� } t�|�s�t�|�r�d} nd} ||kr�d | |f }nD|r�t�||g �|u r�d |j d | |f }d } n|}d | ||f }d}t� |��rjzt� |�}W n t t f�y< d}Y n0 |�rjt |�}|d k�rjd| }|d d� }|�std}| | | �|� | �o�| �d| � }| �r�d| S | �t|�| j|||�}|�o�d| }d||f S dS )z;Produce HTML documentation for a function or method object.rD 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>rK 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* rd r+ r, r7 r �iscoroutinefunction�isasyncgenfunction�getattr_staticrU r� r� rB rA r r4 rM rI r- )r9 r r% rj rE rF rl rk r� r� �note�skipdocs�imclass�asyncqualifierr Zreallinkr� r� r� r< r r r r� sl � ��� ��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> rz rD )r rM rI r- rO �r9 r r% rj rk r� rv r< r r r r� C s zHTMLDoc.docdatac G s |r d| pd}|| � |� S )z-Produce HTML documentation for a data object.z<strong>%s</strong> = rD �r� )r9 r r% rj rk Zlhsr r r r� S 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 |� ko dkn V qdS )i � i�� N)�ord�r� Zchr r r � <genexpr>] r� z HTMLDoc.index.<locals>.<genexpr>rD rK r[ r` )rg rh �anyr r� r3 r< r) )r9 r r: rp rq r% rr r r r r �indexX s z HTMLDoc.index)rD )r& rD Nr! )r� )N)NN)NNN)NN)N) r* r r r> r� �_repr_instancer� r r r% r( r) r- r3 r4 r6 r7 r9 r< r= rM rP r� r� r� r� r� r� r� r� r r r r r 2 s> � + y #� A r c @ s4 e Zd ZdZdd� Zdd� Zdd� ZeZdd � Zd S ) �TextReprzAClass for safely making a text representation of a Python object.c C s, t �| � d | _| _d| _d | _| _d S r� r r r r r r� k s zTextRepr.__init__c C sT t t|�d�r@dd�t|�j�� � }t | |�r@t| |�||�S ttt|��| j �S r ) r� r@ rO r* r! r" r_ rb r� r r r r r r q s zTextRepr.repr1c C sH t || j�}t|�}d|v rDdt|dd�vrDd|d | |d S |S )Nr� r rD r r )r_ r r� rY r r r r r x s zTextRepr.repr_stringc C s4 zt tt|��| j�W S d|jj Y S 0 d S r )r_ rb r� r r, r* r r r r r � s zTextRepr.repr_instanceN) r* r r r> r� r r r r r r r r r� i s r� c @ s~ e Zd ZdZe� ZejZdd� Zddd�Zdd� Z dd d �Z dd d�Z d dd�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.rD c s s | ]}|d | V qdS )�Nr r� r r r r� � r� z TextDoc.bold.<locals>.<genexpr>)rO r r r r �bold� s z TextDoc.bold� c s> |sdS � fdd�|� d�D �}|r4|d �� |d< d�|�S )z6Indent text by prepending a given prefix to each line.rD c s g | ] }� | �qS r r �r� r� ��prefixr r r� � r� z"TextDoc.indent.<locals>.<listcomp>rJ r )r! rG rO )r9 rW r� rP r r� r �indent� s zTextDoc.indentc C s$ | � |��� }| �|�d | d S )z&Format a section with a given heading.rJ r* )r� rG r� )r9 r r Zclean_contentsr r r r( � s zTextDoc.sectionNrD c s� d}|D ]�}t |�t d�u rr|\}}|| t|� � }|rh||fkrh� fdd�|D �} |dd�| � }|d }qt |�t g �u r|| �|� ||d � }q|S ) zBRender in text a class tree as returned by inspect.getclasstree().rD r c 3 s | ]}t |� �V qd S r �rS )r� rT �rR r r r� � r� z%TextDoc.formattree.<locals>.<genexpr>r� rN rJ r� )r@ rS rO rP ) r9 rQ rR rR r� rH rS rT rU rV r r� r rP � s �zTextDoc.formattreec C s |j }tt|��\}}| �d||o(d| �}t|dd�}| �|�}|dur`|| �d|d � }|rt|| �d|� }g } t�|t�D ]<\} } |dus�t� | �p�||u r�t | ||�r�| � | | f� q�g } t�|tj �D ]B\} } |dus�t� | �s�t� | �|u r�t | ||�r�| � | | f� q�g } t�|t�D ]&\} } t | ||��r(| � | | f� �q(g }t� }t|d��r�t�|j�D ]6\}}}|�|� |�r�|� |d � n |� |� �qr|�� || �d d �|�� }g }t�|tj�D ]0\} } | j �|d ��r�| |v�r�|� | � �q�|�r0|�� || �d d �|�� }| �r�dd� | D �}| �t�|d�|�g}| D ] \} } |� | �| | |�� �q^|| �dd �|�� }| �r�g }| D ] \} } |� | �| | |�� �q�|| �dd �|�� }| �r g }| D ]"\} } |� | j | | |dd�� �q�|| �dd �|�� }t|d��rzt |j �}|dd� dk�rj|dd� dk�rj|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 n0 || �d#|� }|S )$z5Produce text documentation for a given module object.�NAME� - ra 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 DESCRIPTIONru � (package)zPACKAGE CONTENTSrJ r Z SUBMODULESc S s g | ] \}}|�qS r r r_ r r r r� � r� z%TextDoc.docmodule.<locals>.<listcomp>rK �CLASSES� FUNCTIONS�F )r] ZDATAr~ rX rY r rZ �VERSIONr ZDATEr} ZAUTHORrx ZCREDITSr� �FILE)%r* rQ rI r( r" r� r rf r rf r� r rU r. rV �setr� rg rh ru �addr� rO rT r� rP ri r� r� rA r~ rM r r} rx r� rB )r9 r r% rj Zsynop�descrH r� r� rF rm rn rE ro rp Z modpkgs_namesrq rR rr Z submodulesrs r rn r� r r r r� � s� � � � � � � $ zTextDoc.docmodulec sX �j }|p |}�j}�jfdd�}||kr:d��|� }n��|�d | }|rlt||�} |dd�| � }g } | j�zt���} W n t t fy� d} Y n0 | r�t | �} | r�| dkrȈ|| d � t ��} | r�| d � t t����}t|�d k�r(�d � |D ]}�d ||� � �q�d � tdd� t���D �t jd�}t|�}d}|�r��d� |d|� D ]}�d | � �ql||k�r��dt || � d � �d � G �fdd�d�}|� � � ����fdd�}� ���fdd�}� ����fdd �}�fd d �t��D �}|�r$|�r(|�� �n |d d �t|�fd d!��\}}�tju�rl�tju �rl|}�qn ��u �r|d"}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 �|}�qd �| �} | �s<|d S |d ��| � � d0� d S )1z4Produce text documentation for a given class object.c S s t | |�S r r� )rT r� r r r �makename s z"TextDoc.docclass.<locals>.makename�class z = class r� rN Nr� rJ rL zMethod resolution order:r� rD c s s. | ]&}|j �d �s|jdkrt|j �V qdS )r� r� N)r* r� r rA )r� r$ r r r r� C s �z#TextDoc.docclass.<locals>.<genexpr>r� r� zBuilt-in subclasses:z ... and z other subclassesc s e Zd Zdd� Z� fdd�ZdS )z(TextDoc.docclass.<locals>.HorizontalRulec S s d| _ d S r� rt r r r r r� U s z1TextDoc.docclass.<locals>.HorizontalRule.__init__c s | j r� d� d| _ d S )NzF----------------------------------------------------------------------rK rt r ru r r rw W s z.TextDoc.docclass.<locals>.HorizontalRule.maybeNrx r ru r r ry T s ry c s� t ||�\}}|r|� �� �| � |D ]T\}}}}zt�|�}W n$ tyd ���||��� Y q&0 ���||���� q&|S r r{ r} �r� rj r rv r9 r r r� ] s �z TextDoc.docclass.<locals>.spillc sJ t ||�\}}|rF� �� �| � |D ] \}}}}���||��� q&|S r r� r} r� r r r� n s z*TextDoc.docclass.<locals>.spilldescriptorsc s� t ||�\}}|r�� �� �| � |D ]\\}}}}t|�}zt�|�} W n tyd |j| } Y n0 ��j| |�d|d�d � q&|S )Nr� )r] r< rJ )rt rw rI r" r7 �__dict__r� ) r~ r� rq r r% r� r� rn r< r8 r� r r r� w s �z#TextDoc.docclass.<locals>.spilldatac s, g | ]$\}}}}t |� d �r||||f�qS r� r� r� r r r r� � s �z$TextDoc.docclass.<locals>.<listcomp>r c s | d � u S r� r r] r� r r r� � r� z"TextDoc.docclass.<locals>.<lambda>r� r� z Methods %s: c S s | d dkS r� r r] r r r r� � r� zClass methods %s: c S s | d dkS r� r r] r r r r� � r� zStatic methods %s: c S s | d dkS r� r r] r r r r� � r� zReadonly properties %s: c S s | d dkS r� r r] r r r r� � r� zData descriptors %s: c S s | d dkS r� r r] r r r r� � r� z Data and other attributes %s: c S s | d dkS r� r r] r r r r� � r� z | ) r* rg r r� �maprO r r r� r� rB rA rI r r� rN �sortedr@ �__subclasses__r� r� r� rt r� r rS r� r� rG )r9 r r% rj rk r� rU r� r rV r r� r� r< r� r; Z subclassesZno_of_subclassesZMAX_SUBCLASSES_TO_DISPLAYZ subclassnamery r� r� r� r� r� r� r )r� rj r rv r9 r� r r� s� � �� � � � � � � � � zTextDoc.docclassc C s d| � |� S r� r� r r r r r� � s zTextDoc.formatvaluec C s� |j }|p |}d}d}t|�rn|jj}|rB||urndt||� }n,|jdur`dt|jj|� }ndt||� }t�|�s�t�|�r�d} nd} ||kr�| �|�} n,|r�t� ||g �|u r�d}| �|�d | } d} t� |��r:zt� |�} W n t t f�y d} Y n0 | �r:t| �} |d k�r:| �|�d } | dd � } | �sDd } | | | | } |�rb| d S t|��pnd}| d |�o�| �|��� d S dS )z;Produce text documentation for a function or method object.rD r r� Nr� r� r� rK � = r� z lambda r r� rJ )r* rd r+ r, rS r r� r� r� r� rU r� r� rB rA rI r� rG )r9 r r% rj rk r� r� r� r� r� r r� r� r� r< r r r r� � sT � � zTextDoc.docroutinec C sT g }|j }|r$|| �|�� |d� t|�p.d}|rJ|| �|�� |d� d�|�S )z1Produce text documentation for a data descriptor.rJ rD )r r� rI r� rO r� r r r r� � s zTextDoc.docdatac C s� | � |�}|rF|r|d p d| }|t|� } | dk rF|d| � d }|rX| �|�d pZd| }|slt|�}|r�|d| �t|�� d 7 }|S )z-Produce text documentation for a data object.r� rD r Nr[ rJ )r� rN r� rI r� rA ) r9 r r% rj rR r] r< r� r� Zchopr r r r� � s zTextDoc.docother)r� )NrD )NN)NN)NNN)NNN)NNNNN)r* r r r> r� r� r� r� r� r( rP r� r� r� r� r� r� r� r r r r r� � s e 7 r� c @ s e Zd ZdZdd� ZdS )� _PlainTextDocz2Subclass of TextDoc which overrides string stylingc C s |S r r r r r r r� s z_PlainTextDoc.boldN)r* r r r> r� r r r r r� s r� c C s t � at| � dS )zCThe first time this is called, determine what kind of pager to use.N)�getpager�pagerra r r r r� s r� c sZ t tjd�stS t tjd�s tS tj�� r4tj�� s8tS tj�d�pNtj�d�� � r�tj dkrj� fdd�S tj�d�dv r�� fd d�S � fd d�S tj�d�dv r�tS tj dkr�d d� S t td �r�t� d �dkr�dd� S ddl } | � � \}}t� |� zRt td ��r,t� d| �dk�r,dd� W t�|� S tW t�|� S W t�|� n t�|� 0 dS )z2Decide what method to use for paging through text.�isattyZMANPAGERZPAGER�win32c s t t| �� �S r �� tempfilepager�plainra �Z use_pagerr r r� # r� zgetpager.<locals>.<lambda>ZTERM)ZdumbZemacsc s t t| �� �S r )� pipepagerr� ra r� r r r� % r� c s t | � �S r �r� ra r� r r r� ' r� c S s t t| �d�S )Nzmore <r� ra r r r r� + r� �systemz(less) 2>/dev/nullr c S s t | d�S )NZlessr� ra r r r r� - r� Nz more "%s"c S s t | d�S )NZmorer� ra r r r r� 4 r� )r� r �stdin� plainpager�stdoutr� r r� r �platformr� �tempfile�mkstemp�close�unlink�ttypager)r� �fdr� r r� r r� s> � �r� c C s t �dd| �S )z%Remove boldface formatting from text.z.rD )rE rF ra r r r r� : s r� c C s� ddl }|j|d|jd�}zVtj|jdd��2}z|�| � W n tyN Y n0 W d � n1 sd0 Y W n ty� Y n0 z|� � W q�W q� ty� Y q�0 q�dS )z3Page through text by feeding it to another program.r NT)�shellr� �backslashreplace)�errors) � subprocess�Popen�PIPE�io� TextIOWrapperr� �write�KeyboardInterruptr� �wait)rW �cmdr� �proc�piper r r r� > s ( r� c C s� ddl }|�� ��}tj�|d�}t|ddtjdkr<t�d�ndd��}|� | � W d � n1 sd0 Y t� |d | d � W d � n1 s�0 Y dS ) z<Page through text by invoking a program on a temporary file.r Nz pydoc.out�wr� r� )r� �encodingz "r> ) r� �TemporaryDirectoryr r rO r� r r� �device_encodingr� r� )rW r� r� �tempdirr� r� r r r r� U s � �(r� c C s$ t tjdd �pd}| �|d��|�S )Nr �utf-8r� )r" r r� �encode�decode)rW r r r r �_escape_stdouta s r c C s� t t| ���d�}z2ddl}tj�� }|�|�}|�|� dd� }W n& t t t j fyj d}dd� }Y n0 �zDzt tj�dd��}W n ty� d}Y n0 |dkr�d }|d }}tj�d�|d|� �d � ||d� �r�tj�d � tj�� |� } | d v �rtj�d � �q�n,| d v �rFtj�d || d � |d }q�| dv �rj|| | }|dk �rjd}tj�dd�|||| � � d � || }q�W |�r�|�||j|� n|�r�|�||j|� 0 dS )z%Page through text on a text terminal.rJ r Nc S s t j�d�S re )r r� r� r r r r r� n r� zttypager.<locals>.<lambda>c S s t j�� d d� d d� S )Nr rK )r r� r� r r r r r� q r� �LINESrK � z -- more --)�q�Qz )� rJ )�b�B�)r� r r! �ttyr r� �filenoZ tcgetattrZ setcbreakr� r7 r� �UnsupportedOperationrD r r� r r� r� r� rO �flushZ tcsetattrZ TCSAFLUSH) rW rP r r� �oldZgetchar�hr ZincrT r r r r� f sN & �r� c C s t j�tt| ��� dS )z>Simply print unformatted text. This is the ultimate fallback.N)r r� r� r� r ra r r r r� � s r� c C s� t �| �r>| jtjv r d| j S t| d�r4d| j S d| j S t �| �rRd| j S t �| �rtd| jj | jj| jf S t � | �r�d| jj | jj| jf S t | �r�d| j S t � | �r�d | j S t � | �r�d | j S t| �jS ) z/Produce a short description of the given thing.zbuilt-in module ru zpackage zmodule zbuilt-in function zgetset descriptor %s.%s.%szmember descriptor %s.%s.%sr� z function zmethod )r rT r* r r� r� r. Zisgetsetdescriptorr2 r r3 r r- r) r@ )�thingr r r �describe� s2 � � r c C s� dd� | � d�D �}d\}}|t|�k r\td�|d|d � �|�}|r\||d }}q q\q |rf|}nt}||d� D ]*}zt||�}W qv ty� Y dS 0 qv|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� NrK )r! rN r� rO r� r" r7 )r r� rl r� �nZ nextmoduler r� r r r �locate� s r c C sV t | t�r0t| |�}|du r(td| ��|| fS t| dd�}| t |t�rL|ndfS dS )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 rA r r� r" )r r� r r% r r r �resolve� s � r � Python Library Documentation: %sc C s� |du r t }t| |�\}}t|�}t�|�}|rTd|v rT|d|d|�d�� 7 }n|rn||urn|d|j 7 }t�|�s�t|�s�t� |�s�t� |�s�t |�s�t |d�r�|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 objectr* )rW r r r rf �rfindr* rT r rU r1 rC r� r r@ r� )r r r� Zrendererr r% r� r� r r r � render_doc� s. ���� r c C sh z2|du r t t| ||�� n|�t| ||t�� W n0 ttfyb } zt|� W Y d}~n d}~0 0 dS )zCDisplay text documentation, given an object or a path to an object.N)r� r r� � plaintextr� r� �print)r r r� �outputrn r r r r< � s r< c C s� ztt | |�\}}t�t|�t�||��}t|d ddd��}|�|� W d � n1 sZ0 Y td|d � W n0 tt fy� } zt|� W Y d}~n d}~0 0 dS )z<Write HTML documentation to a file in the current directory.r� r r )r NZwrote) r �htmlr r r� r� r� r" r� r� )r r� r r% r r� rn r r r �writedoc� s (r% rD c C s2 |du r i }t �| g|�D ]\}}}t|� qdS )zAWrite out HTML documentation for all modules in a directory tree.N)rg � walk_packagesr% )r �pkgpath�donerq rR rr r r r � writedocs s r) c J @ s. e Zd Zdddddddddddd d d d d dddddddddddddddddd d d d �$Zd d!� d"D �Zd#d$d%d&ge�R d'd(d)d*d+d,d-�Zd.d/d0d1d2d3d4d5d6d7d8d9d9d:d:d;�Ze�� D ]:\ZZ e D ],Z e� e e�Z ee vr�e d< e Z e ee < q�q�d=d>d?d@dAdBdCdDdEdFdGdHdIdJdKdLdLdMdNdOdPdQddRdSdSdTdUdVdWdXdYdZd[d\d]d^d_d_d`dadbdcdddedfdgdhdidjdkdldmdndodpdqdrdsdtdudvdwdxdydzd{dd d|d}d~dd��IZ 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 )��HelperrD �BOOLEAN�with)�assertrD )�asyncrD )�awaitrD )�break� while for)�classzCLASSES SPECIALMETHODS)�continuer1 )�functionrD )�del� BASICMETHODS�if)�elser1 �try)�forzbreak continue while�import)�globalznonlocal NAMESPACES)r7 � TRUTHVALUE)r; �MODULES)�in�SEQUENCEMETHODS� COMPARISON)�lambdar� )�nonlocalzglobal NAMESPACES)�passrD )�raise� EXCEPTIONS)�returnr� )r9 rF )�whilez break continue if TRUTHVALUE)r, z CONTEXTMANAGERS EXCEPTIONS yield)�yieldrD )$�False�None�True�__peg_parser__�and�asr- r. r/ r0 r2 r3 �defr5 �elifr8 �except�finallyr: �fromr< r7 r; r? �isrB rC �not�orrD rE rG r9 rH r, rI c C s g | ]}d D ] }|| �q qS )��'r> r )r� �pr r r r r� E r� zHelper.<listcomp>)r �fr �urY z'''r> r� )�+r� �*�**r� z//�%�<<�>>r �|�^�~r r �<=�>=�==�!=�<>)r r rf rg rh ri rj )r� re ) z+=z-=z*=z/=z%=z&=z|=z^=z<<=z>>=z**=z//=)ra rb r rc rd re )�j�J)�STRINGS� OPERATORSrA �UNARY�AUGMENTEDASSIGNMENT�BITWISE�COMPLEXzOPERATORS FORMATTING�POWERzTUPLES LISTS FUNCTIONSz ATTRIBUTES FLOAT MODULES OBJECTS�ELLIPSISzSLICINGS DICTIONARYLITERALSz def classrm � PRIVATENAMESzPRIVATENAMES SPECIALMETHODSZ BACKQUOTESzTUPLES FUNCTIONS CALLSzLISTS SUBSCRIPTS SLICINGS)r` r_ �,r r[ �:�@r� r� r� �`r? rO �[�]r� )r zRSTRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect)�stringsz4str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPES)zstring-methodszSTRINGS FORMATTING)Z formatstringsrn )r| z:encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPES)ZnumberszINTEGER FLOAT COMPLEX TYPES)Zintegersz int range)Zfloatingz float math)Z imaginaryz complex cmath)Ztypesseqz$STRINGMETHODS FORMATTING range LISTS� DICTIONARIES)Ztypesfunctionsz def TYPES)Z typesmethodszclass def CLASSES TYPES)zbltin-code-objectszcompile FUNCTIONS TYPES)zbltin-type-objectsz types TYPES�TYPES)zbltin-null-objectrD )zbltin-ellipsis-object�SLICINGS)Z specialattrsrD )r z!class SPECIALMETHODS PRIVATENAMES)Z typesmodulesr; )zoperator-summaryz�lambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIES� EXPRESSIONS)Zobjectsr~ )Z specialnameszbBASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS NUMBERMETHODS CLASSES)Z customizationz hash repr str SPECIALMETHODS)zattribute-accesszATTRIBUTES SPECIALMETHODS)zcallable-typeszCALLS SPECIALMETHODS)�sequence-typesz(SEQUENCES SEQUENCEMETHODS SPECIALMETHODS)r� zMAPPINGS SPECIALMETHODS)z numeric-typesz*NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS)Z execmodelz%NAMESPACES DYNAMICFEATURES EXCEPTIONS)Znamingz3global nonlocal ASSIGNMENT DELETION DYNAMICFEATURES)zdynamic-featuresrD � NAMESPACES)r� ztry except finally raise)Z conversionsrD )Z identifierszkeywords SPECIALIDENTIFIERS)z id-classesrD )zatom-identifiersrD )z atom-literalsz=STRINGS NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALS� SEQUENCES)Z exprlistszTUPLES LITERALS)ztypesseq-mutable� LISTLITERALS)ZlistszLISTS LITERALS)Z typesmapping�DICTIONARYLITERALS)r4 zDICTIONARIES LITERALS)zattribute-referencesz(getattr hasattr setattr ATTRIBUTEMETHODS)Z subscriptionsr@ )Zslicingsr@ )Zcallsr� )Zpowerr� )Zunaryr� )�binaryr� )Zshiftingr� )Zbitwiser� )Z comparisonszEXPRESSIONS BASICMETHODS)ZbooleanszEXPRESSIONS TRUTHVALUEr- )Z assignmentrp )Z augassign� NUMBERMETHODSr5 rG )Zcompoundzfor while break continue)�truthz if while and or not BASICMETHODS)ZdebuggerZpdb)zcontext-managersr, )Ir~ rm Z STRINGMETHODSZ FORMATTING�UNICODEZNUMBERSZINTEGER�FLOATrr r� ZMAPPINGSr� ZMETHODSZ CODEOBJECTSZ TYPEOBJECTSZ FRAMEOBJECTSZ TRACEBACKS�NONErt ZSPECIALATTRIBUTESr� r> ZPACKAGESr� rn Z PRECEDENCEZOBJECTSZSPECIALMETHODSr6 ZATTRIBUTEMETHODSZCALLABLEMETHODSr@ ZMAPPINGMETHODSr� Z EXECUTIONr� ZDYNAMICFEATURESZSCOPINGZFRAMESrF Z CONVERSIONSZ IDENTIFIERSZSPECIALIDENTIFIERSru ZLITERALSZTUPLESZ TUPLELITERALSZLISTSr� r} r� Z ATTRIBUTESZ SUBSCRIPTSr ZCALLSrs ro ZBINARYZSHIFTINGrq rA r+ Z ASSERTIONZ ASSIGNMENTrp ZDELETIONZ RETURNINGZ IMPORTINGZ CONDITIONALZLOOPINGr= Z DEBUGGINGZCONTEXTMANAGERSNc C s || _ || _d S r )�_input�_output)r9 �inputr# r r r r� � s zHelper.__init__c C s | j p tjS r )r� r r� r r r r r� � s z Helper.inputc C s | j p tjS r )r� r r� r r r r r# � s z Helper.outputc C s2 t �� d d dkr | � dS d| jj| jjf S )NrK rZ �?rD z<%s.%s instance>)r �stackr, r r r r r r �__repr__� s �zHelper.__repr__c C s6 || j ur| �|� n | �� | �� | 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� �r9 Zrequestr r r �__call__� s zHelper.__call__c C s� | j �d� z| �d�}|s W q�W n ttfy< Y q�Y n0 |�� }t|�dkr�|d |d krndv r�n n |d |dd� vr�|dd� }|�� dv r�q�|d kr�| �� q | � |� q d S ) NrJ zhelp> rL r r rX rK )r �quitr ) r# r� �getliner� �EOFErrorrM rN r� r� r r� r r r r� � s ,� zHelper.interactc C s8 | j tju rt |�S | j�|� | j�� | j �� S dS )z.Read one line, using input() when appropriate.N)r� r r� r# r� r r� )r9 �promptr r r r� � s zHelper.getlinec C s< t |�t d�u �r|�� }|dkr,| �� n�|dkr>| �� n�|dkrP| �� n�|dkrb| �� n�|d d� dkr�| �|�� d � n�|| jv r�| �|� nj|d v r�t t |�d � nR|| j v r�| � |� n<|| j v r�| � |� n&|r�t |d | jd � nt td | jd � n$t|t��r | � nt |d | jd � | j�d � d S ) NrD �keywords�symbols�topicsr � zmodules rK )rL rJ rK z Help on %s:)r# rJ )r@ rM � listkeywords� listsymbols� listtopics� listmodulesr! r� � showsymbolr< �evalr� � showtopicr� r� rA r r* r# r� r� 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.%drL )r# r� r0 r r� r r r r r� s �z Helper.intror� �P c C s� t t|��}|| }t|�| d | }t|�D ]v}t|�D ]\}|| | }|t|�k r<| j�|| � ||d k r<| j�dd|d t|| � � q<| j�d� q0d S )NrK r� rJ )r/ r� rN r. r# r� ) r9 �items�columnsr' Zcolwr1 �rowr2 r� r r r r/ % s &z Helper.listc C s | j �d� | �| j�� � d S )NzN Here is a list of the Python keywords. Enter any keyword to get more help. )r# r� r/ r� rj r r r r r� 2 s zHelper.listkeywordsc C s | j �d� | �| j�� � d S )Nzx Here is a list of the punctuation symbols which Python assigns special meaning to. Enter any symbol to get more help. )r# r� r/ r� rj r r r r r� 9 s zHelper.listsymbolsc C s | j �d� | �| j�� � d S )NzN Here is a list of available topics. Enter any topic name to get more help. )r# r� r/ r� rj r r r r r� A s zHelper.listtopicsc C s, z dd l }W n ty, | j�d� Y d S 0 | j�|| j�|��}|s`| j�dt|� � d S t|�td�u r|| � ||�S |\}}z|jj| }W n( t y� | j�dt|� � Y d S 0 |� � d }|r�|p�dd | }|�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 rD rJ r� �Related help topics: rN �H z %s )�pydoc_data.topicsr� r# r� r� r r� r� r@ r� �KeyErrorrM �textwraprO r! �wrapr� ) r9 �topic� more_xrefs� pydoc_data�target�label�xrefsr< r� rW Z wrapped_textr r r r� H s4 zHelper.showtopicc C s� z ddl }W n ty Y dS 0 | j�|| j�|��}|sDtd��t|t�rZ| �||�S |\}}|jj| }|r�|pxdd | }||fS )a* Return unbuffered tuple of (topic, xrefs). If an error occurs here, the exception is caught and displayed by the url handler. This function duplicates the showtopic method but returns its result directly so it can be formatted for display in an html page. r N)r� rD zcould not find topicrD r� ) r� r� r� r r� r� r rA � _gettopic)r9 r� r� r� r� r� r� r< r r r r� h s zHelper._gettopicc C s* | j | }|�d�\}}}| �||� d S )Nr� )r� � partitionr� )r9 �symbolr� r� r� r� r r r r� � s zHelper.showsymbolc sv |r | j �d�|�� t|� nR| 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 s> |r$|dd � dkr$|d d� d }|� d�dk r:d||< d S )N���� .__init__r� r r rK )�find)r rR 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� r0 �apropos� ModuleScanner�runr/ rj )r9 rm r r� r r� r r� � s � zHelper.listmodules)NN)r� r� )rD )rD )rD )!r* r r r� Z _strprefixesZ_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* sD �(� � �W r* c @ s e Zd ZdZddd�ZdS )r� z7An interruptible scanner that searches module synopses.Nc C s |r |� � }d| _i }tjD ]p}|dkr d||< |d u rF|d |d� q t|�jpRd}|�d�d }|d | }|� � �|�dkr |d ||� q tj |d�D �]V\} }} | jr� �q�|d u r�|d |d� q�zt� | |�} W n t y� Y q�Y n0 | j } t | d ��rjz| �|�} W n& t�y6 |�r.||� Y q�Y n0 tt�| ���pJd}t | d ��rd| �|�}nd }n^ztj�| �}W n& t�y� |�r�||� Y q�Y n0 |j�r�|j�� d nd}t|d d �}|d | }|� � �|�dkr�||||� q�|�r |� d S ) NF�__main__rK rD rJ r r� r� � get_source� get_filenamer{ )r� r� r r� r� r> r! r� rg r& � _get_specr� r� r� r� r| r� r� �StringIOr� r� r� r� r� r� r" )r9 r� rm Z completerr� �seenrR r% r� rq rr r� r� �sourcer r� r r r r� � s^ zModuleScanner.run)NNN)r* r r r> r� r r r r r� � s r� c C sX dd� }dd� }t �� �, t �d� t� j|| |d� W d � n1 sJ0 Y dS )zAPrint all the one-line module summaries that contain a substring.c S s6 |dd � dkr |d d� d }t ||o.d| � d S �Nr� r� r� z- )r" �r rR r� r r r r� � s zapropos.<locals>.callbackc S s d S r r r� r r r r� � s zapropos.<locals>.onerror�ignorer� N)�warnings�catch_warnings�filterwarningsr� r� )rm 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 s�|j s�t � d � q~|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�rd}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-8r N) r r� Z send_responseZ send_headerZ end_headersZwfiler� � urlhandlerr )r9 � content_typer r r �do_GET0 s ��z(_start_server.<locals>.DocHandler.do_GETc W s d S r r )r9 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 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� �handlerr� )r9 r� �portr� r r r r� F s z)_start_server.<locals>.DocServer.__init__c s> | j s2� �| j�� gg g d�\}}}|r | �� q | �� d S re )r� �select�socketr Zhandle_requestZ server_close)r9 Zrd�wr�ex�r� r r �serve_until_quitM s z1_start_server.<locals>.DocServer.serve_until_quitc S s | j �| � | jr | �| � d S r )r; �server_activater� r r r r r� T s z0_start_server.<locals>.DocServer.server_activateN)r* r r r� r� r� r r� r r � DocServerD 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� rD r� �Threadr� �serving�error)r9 r� r� r� )� threadingr r r� [ s z,_start_server.<locals>.ServerThread.__init__c sz zJ�j j�_� �_�jj� _t| j�� _�| j | j | j �}|| _ |� � W n* tyt } z|| _W Y d}~n d}~0 0 dS )zStart the server.N)�server� HTTPServerr; r� r� ZMessageZ MessageClass� staticmethodr� r� r� �ready� docserverr� r| r� )r9 Zdocsvr�e)r� r� �email�httpr r r� c s z'_start_server.<locals>.ServerThread.runc S s, d| _ |j| _|j| _d| j| jf | _d S )NTz http://%s:%d/)r� r� Z server_portr� r; )r9 r� r r r r� p s z)_start_server.<locals>.ServerThread.readyc S s& d| j _| �� d| _ d| _d| _dS )z&Stop the server and this thread nicelyTNF)r� r� rO r� r; r r r r �stopv s z(_start_server.<locals>.ServerThread.stopN)r* r r r� r� r� r� r )r� r� r� r� r� r r � ServerThreadY s r� g{�G�z�?) Z http.serverZ email.messager� r� r� ZBaseHTTPRequestHandlerr� r� rJ r� r� �time�sleep)r� �hostnamer� r� �threadr )r� r� r� r� r� r� r � _start_server� s 8 ' r� r� c s6 G �fdd�dt �}|� � � fdd��� fdd��� fdd��� fd d ��� fd d ��� fd d��� fdd��� fdd��� �������fdd�}| �d�r�| dd� } |dk�rtj�tj�t��}tj�|| �}t|�� }d�|� � �W d � S 1 �s0 Y n|dk�r"|| �S t d|| f ��dS ) 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 )r9 r r �css_pathZcss_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)Zterse)r r� Zpython_versionZ python_buildZpython_compiler)rn �r$ r r r� � s ��z!_url_handler.<locals>.html_navbarc s� dd� } � � ddd�}dd� tjD �}� �|| �}|d� �d dd |� g}i }tjD ]}|�� �||�� qT|�d � d d �|�fS )zModule Index page.c S s d| | f S �Nr8 r �r% r r r � bltinlink� s 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<ping@lfw.org></font>zIndex of ModulesrD ) r% r r� r3 r) r r r� rO )r r% �namesr r� r r� r r � html_index� s" � � �z _url_handler.<locals>.html_indexc s� g � � fdd�}t �� �4 t �d� dd� }t� j|| |d� W d � n1 sR0 Y dd � }g }��d d d �}� D ]\}}|�||�| � qz|��d | d dd�|�� }d|fS )zSearch results page.c s: |dd � dkr |d d� d }� � ||o0d| f� d S r� ro r� �Z search_resultr r r� � s z3_url_handler.<locals>.html_search.<locals>.callbackr� c S s d S r r r� r r r r� � s z2_url_handler.<locals>.html_search.<locals>.onerrorr� Nc S s d| | f S r� r r� r r r r � s 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� r% r r) rO ) rm r� r� r r� r% r% r� r r� r r � html_search� s$ 0� �z!_url_handler.<locals>.html_searchc sL dd� } � � ddd�}ttj�� �}� �|| �}|� �ddd|� }d|fS )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>.bltinlink�,<big><big><strong>INDEX</strong></big></big>r[ r\ ZTopicsr` )r% r� r* r� rj r3 r) )r r% 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 s d| | f S r r r� r r r r s z6_url_handler.<locals>.html_keywords.<locals>.bltinlinkZKeywordsr` )r% r� r* r� rj r3 r) )r% r r r r� r r � html_keywords s � �z#_url_handler.<locals>.html_keywordsc s� t �� }t||�}|�| �\}}| |jv r0d}nd}� �d| dd�}d� �|� }� �| dd|�}|r�t|� � �}dd � }� � ||�}� � d dd|�}d || f d � |||f�fS ) zTopic or keyword help page.ZKEYWORDZTOPICrW r[ r\ z <pre>%s</pre>r` c S s d| | f S r r r� r r r r & s z7_url_handler.<locals>.html_topicpage.<locals>.bltinlinkr� z%s %srD ) r� r� r* r� r� r% rM r) r� r! r3 r( rO )r� �bufZhtmlhelpr r� r r% r r� r r �html_topicpage s, � � �z$_url_handler.<locals>.html_topicpagec s@ t | dd�}|d u r$| dkr$td��t|�}� �|| �}||fS )NrK )r� rK zcould not find object)r r� r r� )r; r8 r �contentr� r r � html_getobj/ 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� ; r� z3_url_handler.<locals>.html_error.<locals>.<genexpr>z#bb0000z Error - %s)r% rO r r@ r) )r; r� r% r r� r r � html_error7 s � � �z _url_handler.<locals>.html_errorc sp | }| � d�r| dd� } �z| dv r2�� \}}n�| dkrF�� \}}n�| dkrZ�� \}}n�d| v �r | �d�\}}} |dkr��| �\}}n�|d kr�z�| �\}}W n ty� �| �\}}Y n0 nZ|d k�r| dv r�� \}}n2z�| �\}}W n t�y �| �\}}Y n0 ntd ��n �| �\}}W n4 t�yb } z�||�\}}W Y d}~n d}~0 0 � �||�S ) z Generate an HTML page for url.r� N���)rD r� r� r� r� z search?keyz topic?keyzget?keyz bad pydoc url)r� r� r� r| r )r; Z complete_urlr r �opr� r� )r$ r r r r r r r r r � get_html_pageA s> $z#_url_handler.<locals>.get_html_pager� rK Nr� rD r� z"unknown content type %r for url %s) r r� r r �dirname�realpathr{ rO r� � readlinesrB )r; r� r� r Z path_herer� �fpr ) r$ r r r r r� r r r r � _url_handler� s* ( 0 r T� localhost)� open_browserr� c C s� ddl }tt|| �}|jr(t|j� dS |jr�d}|rB|�|j� z�zZtd|j� t|� |jr�td�}|� � }|dkr|q�qZ|dkr�|�|j� qZt|� qZW n t t fy� t� Y n0 W |jr�|� � td� n|jr�|� � td� 0 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> r r zServer stopped) � webbrowserr� r r� r" r� r� r; r� r� r� r� r� )r� r r� r Z serverthreadZserver_help_msgr� r r r �browsev s8 �r c C s t | t�o| �tj�dkS r� )r rA r� r �sep)rs r r r �ispath� s r c C sv d| v s t j| v s t �� | v r"dS t j�t�}t j�|�}| �� }|| v rbt j�||�sb|�|� |� 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. rD Nr ) r �curdir�getcwdr r r{ �copy�samefile�remove�insert)Z given_pathZargv0Z stdlib_dirZ script_dir� revised_pathr r r �_get_revised_path� s r$ c C s, t tjtjd �} | dur(| tjdd�< 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� �zx| � tjdd� d�\}}d}d}d}d}d}|D ]\\} } | d krld }d }| d kr�t| � W dS | d kr�d }| }| d kr�d }| dkrTd }| }qT|r�t|||d� W dS |s�|�|D ]�} t| ��rtj � | ��st d| � �q�z`t| ��r&tj � | ��r&t | �} |�rXt| ��rNtj �| ��rNt| � nt| � n t�| � W q� t�y� } zt | � W Y d} ~ q�d} ~ 0 0 q�W nL | j|f�y� tj �tj �tjd ��d } t dj| tjd�� Y n0 dS )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' rK 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� r0 r )r( r' Zoptsr� �writingZ start_serverr r� r� �opt�val�argrn r� r r r �cli� s` $ �r. r� )NN)r )r )r r N)r r N)r )rD N)r� )r )`r> ra r} r rx r� Zimportlib._bootstrapr� Z importlib._bootstrap_external�importlib.machinery�importlib.utilr r� r rg r� rE r r� r� r� r � urllib.parserb r� � collectionsr �reprlibr � tracebackr r r r& r= r6 rC rI rQ rS rV rY r_ r@ � IGNORECASEr` rb rd ri rt 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 rW 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