Current File : //usr/local/lib/python3.8/idlelib/__pycache__/help.cpython-38.pyc
U
qaK. @ s d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z m Z m
Z
ddlmZmZmZmZ ddl
mZ ddlmZ G d d
d
eZG d d d e ZG d
d deZG dd de Zdd Zdd Z e dkrddl m Z e dddd ddl m!Z! e!e d S ) a help.py: Implement the Idle help menu.
Contents are subject to revision at any time, without notice.
Help => About IDLE: display About Idle dialog
<to be moved here from help_about.py>
Help => IDLE Help: Display help.html with proper formatting.
Doc/library/idle.rst (Sphinx)=> Doc/build/html/library/idle.html
(help.copy_strip)=> Lib/idlelib/help.html
HelpParser - Parse help.html and render to tk Text.
HelpText - Display formatted help.html.
HelpFrame - Contain text, scrollbar, and table-of-contents.
(This will be needed for display in a future tabbed window.)
HelpWindow - Display HelpFrame in a standalone window.
copy_strip - Copy idle.html to help.html, rstripping each line.
show_idlehelp - Create HelpWindow. Called in EditorWindow.help_dialog.
)
HTMLParser)abspathdirnameisfilejoin)python_version)ToplevelTextMenu)Frame
Menubutton ScrollbarStylefont)idleConfc @ s: e Zd ZdZdd ZdddZdd Zd d
Zd d Zd
S )
HelpParsera~ Render help.html into a text widget.
The overridden handle_xyz methods handle a subset of html tags.
The supplied text should have the needed tag configurations.
The behavior for unsupported tags, such as table, is undefined.
If the tags generated by Sphinx change, this class, especially
the handle_starttag and handle_endtags methods, might have to also.
c C s` t j| dd || _d| _d| _d| _d| _d| _d| _d| _ d| _
d| _ g | _ d| _
d | _d S )NT)Zconvert_charrefs Fr )r __init__texttagschartagsshowhdrlinklevelprehprefix nested_dl
simplelisttocheaderprevtag)selfr r# (/usr/local/lib/python3.8/idlelib/help.pyr 3 s zHelpParser.__init__ c C s0 | j |7 _ | j dkr dn dt| j | _dS )z#Change indent (+1, 0, -1) and tags.r r lN)r strr )r" Zamtr# r# r$ indentC s zHelpParser.indentc C s8 d}|D ]\}}|dkr|}qd}|dkr<|dkr<d| _ n|dkrV|dkrVd| _ n|dkr| jr| jd s| jd
d }|r| sd nd
}nv|dkr|dkrd| _n\|dkr|dkrd| _nB|dkrd| _n0|dkr|ddkrd
}d| _nd| _| n|dkr,| j d kr
d| _
n|dkrH| jrBdnd}n|dkrj| j
s^d nd
}d| _
n|dkr| d
}n|dkrd| _ | j r| j dd d | _
nZ|d kr|d krd| _n>|d kr|| _
n,|d kr
| j rd| _| j dd || _
| j r*| j d|| j
| jf d|f| _d!S )"z Handle starttags in help.html.r classZdivsectionTZ
sphinxsidebarFpr zend-1c linestartzend-1cz
spanr Zversionmodifiedem)ulolZsimpleZdlZliz
* z
* ZdtddendpreblockaZ
headerlinkh1)h2h3N)r r! r getisspacer findr r( r r r insertr r r )r" tagZattrsclass_r5 vsZlastliner# r# r$ handle_starttagH sh
zHelpParser.handle_starttagc C s |dkr^| j dkst| jrV|dkr(dn|dkr4dnd}| j|| j | jdf d| _nH|d krnd| _ n8|d
kr~d | _
n(|d krd | _ d| _n|d
kr| d d |f| _
dS )z Handle endtags in help.html.r6 r7 r8 r r8 z r7 z r r< )r- r. r5 Fr )r/ r2 r0 r1 N)r AssertionErrorr r appendr r indexr r r r r( r! )r" r= r( r# r# r$
handle_endtag s&
zHelpParser.handle_endtagc C s | j r| js| jr|n
|dd}| jdkr`z|d|d | _W n tk
r^ d| _Y nX | jdkr| jdkr|dt| j | jkr|t| jd }| j |
7 _ | j d|| j| j
f dS ) z"Handle date segments in help.html.r, r6 r r rB Nr3 )r r r replacer rE r
ValueErrorlenr stripr r< r )r" datadr# r# r$ handle_data s
zHelpParser.handle_dataN)r% ) __name__
__module__ __qualname____doc__r r( rA rF rN r# r# r# r$ r * s
:r c @ s e Zd ZdZdd Zdd ZdS )HelpTextzDisplay help.html.c
C sv t jddddd}t jddddd}d| d }tj| |d d
d d
||d | d
ddg}| dddg}|df| d< | jd|ddfd | jd|ddfd | jd|d dfd | jd |d dfd | jd |dfd d! | jd"|d#fd$d%d&d'd( | jd)d$d$d* | jd+d,d,d* | jd-d.d.d* | jd/d0d0d* t| | _t|d1d2}| }W 5 Q R X | j
| d3| d4< d5S )6z'Configure tags and feed file to parser.mainZ EditorWindowwidthint)typeheight Zwordr )wrapZhighlightthicknessZpadx borderwidthrU rX Z
TkDefaultFontZarialZ helveticaZ TkFixedFontZmonacoZcourier r r. Zitalicr r6 Zboldr7 r8 r z#f6f6ff)r
backgroundr4
r% Zsolidz#eeffcc)r lmargin1r] Zreliefrb l1)re Zlmargin2l22 l3K l4d zutf-8)encodingdisabledstateN) r Z GetOptionr r findfontZ
tag_configurer parseropenreadZfeed) r" parentfilenameZuwideZuhighZ
normalfontZ fixedfontfcontentsr# r# r$ r s>
zHelpText.__init__c C sr |D ]h}| dd tj| dD krFtj|d| d}| d S | dd tj| dD kr| S qdS ) z4Return name of first font family derived from names.c s s | ]}| V qd S Nlower.0xr# r# r$ <genexpr> s z$HelpText.findfont.<locals>.<genexpr>)rootT)nameexistsr familyc s s | ]}| V qd S rx ry r{ r# r# r$ r~ s N)rz tkfontnamesZFontactualfamilies)r" r r r r# r# r$ rp s
zHelpText.findfontN)rO rP rQ rR r rp r# r# r# r$ rS s rS c @ s e Zd ZdZdd Zdd ZdS ) HelpFramez&Display html text, scrollbar, and toc.c C s t | | t| | | _}t|| _d| d< | jjd|d d | | | _}t | |j
d | _ }|j |d< | j
ddd | jddd |jddd
d |jddd d |jdd
dd d S )Nzhelpframe.TFramestylerb )rb )commandZyscrollcommandr r% ZweightZnw)rowcolumnstickynsew ns)r r rS r r r Z configuretoc_menur r
yviewscrollsetZ rowconfigureZcolumnconfiguregrid)r" rt ru r r r r# r# r$ r s
zHelpFrame.__init__c sP t | dd}t|dd} jjD ]"\}}|j||f fdd d q ||d< |S ) z+Create table of contents as drop-down menu.ZTOCr F)Ztearoffc s
| S rx )r )dexr r# r$ <lambda> z$HelpFrame.toc_menu.<locals>.<lambda>)Zlabelr Zmenu)r r
rq r Z add_command)r" r r ZdropZlblr r# r r$ r s zHelpFrame.toc_menuN)rO rP rQ rR r r r# r# r# r$ r s r c @ s e Zd ZdZdd ZdS )
HelpWindowz!Display frame with rendered html.c C sZ t | | | | | d| j t| |jdddd | jddd | jddd d S )NZWM_DELETE_WINDOWr r )r r r r% r ) r r Zwm_titleprotocolZdestroyr r Zgrid_columnconfigureZgrid_rowconfigure)r" rt ru titler# r# r$ r s
zHelpWindow.__init__N)rO rP rQ rR r r# r# r# r$ r s r c
C s t tttttddddd} t tttd}t| d8}t|d"}|D ]}|| d qPW 5 Q R X W 5 Q R X t| d
| d S ) a^ Copy idle.html to idlelib/help.html, stripping trailing whitespace.
Files with trailing whitespace cannot be pushed to the git cpython
repository. For 3.x (on Windows), help.html is generated, after
editing idle.rst on the master branch, with
sphinx-build -bhtml . build/html
python_d.exe -c "from idlelib.help import copy_strip; copy_strip()"
Check build/html/library/idle.html, the help.html diff, and the text
displayed by Help => IDLE Help. Add a blurb and create a PR.
It can be worthwhile to occasionally generate help.html without
touching idle.rst. Changes to the master version and to the doc
build system may result in changes that should not changed
the displayed text, but might break HelpParser.
As long as master and maintenance versions of idle.rst remain the
same, help.html can be backported. The internal Python version
number is not displayed. If maintenance idle.rst diverges from
the master version, then instead of backporting help.html from
master, repeat the procedure above to generate a maintenance
version.
ZDocZbuildZhtmlZlibraryz idle.html help.htmlrbwb
z copied to N)r r r __file__rr writerstripprint)srcdstZinnoutliner# r# r$
copy_strip s (r c C s4 t tttd}t|s dS t| |dt dS )z7Create HelpWindow; called from Idle Help event handler.r NzIDLE Help (%s))r r r r r r r )rt ru r# r# r$
show_idlehelp s r __main__)rT zidlelib.idle_test.test_helpr F) verbosityexit)runN)"rR Z html.parserr Zos.pathr r r r platformr tkinterr r r
Z tkinter.ttkr r r
r r r Zidlelib.configr r rS r r r r rO ZunittestrT Zidlelib.idle_test.htestr r# r# r# r$ <module> s$ ~*
Mini Shell