3
f=, @ s d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z m Z m
Z
mZ ddlmZmZ ddl
mZ ddlmZ G d d
d
eZG d d d e
ZG d
d de ZG dd de Zdd Zdd Ze 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: diplay About Idle dialog
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)ToplevelFrameTextMenu)
Menubutton Scrollbar)font)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 sZ t j| dd || _d| _d| _d| _d| _d| _d| _d| _ d| _
d| _ g | _ d| _
d S )NT)Zconvert_charrefs Fr )r __init__texttagschartagsshowhdrlinklevelprehprefix nested_dl
simplelisttocheader)selfr r 1/opt/alt/python36/lib64/python3.6/idlelib/help.pyr 3 s zHelpParser.__init__ c C s0 | j |7 _ | j dkr dn dt| j | _d S )Nr r l)r strr )r amtr r r! indentB s zHelpParser.indentc C s d}x |D ]\}}|dkr
|}q
W d}|dkr@|dkr@d| _ n|dkrZ|dkrZd| _ n|dkrr|d krrd
}nv|d kr|d krd | _n\|d kr|d
krd| _nB|dkrd| _n0|d#kr|jdd$krd}d| _nd| _| j n|dkr
| jdkrd| _n|dkr&| jr dnd}n|dkrH| js|d kr|| _
n,|d%kr| j rd| _ | jj dd
|| _
| j r| jj d|| j
| jf d"S )&z Handle starttags in help.html.r classZdivZsectionTZ
sphinxsidebarFpfirstz
spanr ZversionmodifiedemulolZsimpler"
Zdlr Zliz
* z
* ZdtddendpreblockaZ
headerlinkh1h2h3N)r, r- )r4 r5 )
r r findr r& r r r r insertr r r )r tagZattrsZclass_r2 vsr r r! handle_starttagF sd
zHelpParser.handle_starttagc C s |dkrT| j d | jr|dkr$dn|dkr0dnd}| jj|| j | jjdf nJ|dkrdd| _n:|d krtd | _n*|d
krd | _ d| _
n|dkr| j dd dS )z Handle endtags in help.html.r3 r4 r5 r z z r r8 r* r+ r2 Fr r, r/ r- r" )r% N)r3 r4 r5 )r* r+ )r, r/ r- r6 ) r& r r appendr r indexr r r r )r r9 r& r r r!
handle_endtag| s
zHelpParser.handle_endtagc
C s | j r| j r| jr|n
|jdd}| jdkrby|d|jd | _W n tk
r` d| _Y nX | jd
kr| jdkr|dt| j | jkr|t| jd }| j |j
7 _ | j j d || j| j
f dS ) z"Handle date segments in help.html.r. r3 r r r4 r5 Nr0 )r3 r4 r5 )r r r replacer r> r
ValueErrorlenr stripr r8 r )r datadr r r! handle_data s
zHelpParser.handle_dataN)r" ) __name__
__module__ __qualname____doc__r r& r< r? rG r r r r! r * s
6r 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 | jd
ddg}| jdddg}|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}|j }W d3Q R X | jj
| d4| d5< d3S )6z'Configure tags and feed file to parser.mainZ EditorWindowwidthint)typeheight Zwordr )ZwrapZhighlightthicknessZpadx borderwidthrN rQ Z
TkDefaultFontZarialZ helveticaZ TkFixedFontZmonacoZcourier r r+ Zitalic)r r3 Zboldr4 r5 r z#f6f6ff)r
backgroundr1
r" Zsolidz#eeffcc)r lmargin1rU ZreliefrZ l1)r] Zlmargin2l22 l3K l4d zutf-8)encodingNZdisabledstate) r Z GetOptionr
r findfontZ
tag_configurer parseropenreadZfeed) r parentfilenameZuwideZuhighZ
normalfontZ fixedfontfcontentsr r r! r s0
zHelpText.__init__c C sn xh|D ]`}|j dd tj| dD krDtj|d| d}|j d S |j dd tj| dD kr|S qW dS ) z4Return name of first font family derived from names.c s s | ]}|j V qd S )N)lower).0xr r r! s z$HelpText.findfont..)rootT)nameexistsrs Zfamilyc s s | ]}|j V qd S )N)ro )rp rq r r r! rr s N)ro tkfontnamesZFontZactualZfamilies)r rw rt r r r r! rg s
zHelpText.findfontN)rH rI rJ rK r rg r r r r! rL s rL c @ s e Zd ZdZdd Zdd ZdS ) HelpFramez&Display html text, scrollbar, and toc.c C s t j| | t| | | _}|d | d< | j| | _}t| |jd | _}|j |d< | j
ddd | j ddd |j dddd |j ddd d |j dd
d d d S ) NrZ )commandZyscrollcommandr r" )weightZnw)rowcolumnstickynsew ns)
r r rL r toc_menur r
yviewscrollsetZ rowconfigureZcolumnconfiguregrid)r rk rl r r r r r r! r s
zHelpFrame.__init__c sT t | dd}t|dd}x. jjD ]"\}}|j||f fdd d q"W ||d< |S ) z+Create table of contents as drop-down menu.ZTOC)r F)Ztearoffc s
j | S )N)r )dex)r r r! s z$HelpFrame.toc_menu..)Zlabelry Zmenu)r r rh r Z add_command)r r r ZdropZlblr r )r r! r s zHelpFrame.toc_menuN)rH rI rJ rK r r r r r r! rx s rx c @ s e Zd ZdZdd ZdS )
HelpWindowz!Display frame with rendered html.c C sZ t j| | | j| | jd| j t| |jdddd | jddd | jddd d S )NZWM_DELETE_WINDOWr r~ )r| r{ r} r" )rz ) r r Zwm_titleZprotocolZdestroyrx r Zgrid_columnconfigureZgrid_rowconfigure)r rk rl titler r r! r s
zHelpWindow.__init__N)rH rI rJ rK r r r r r! r s r c C s t tttttddddd} t tttd}t| d<}t|d&}x |D ]}|j|j d qRW W d
Q R X W d
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 proceedure above to generate a maintenance
version.
ZDocZbuildZhtmlZlibraryz idle.htmlz help.htmlrbwb
Nz copied to )r r r __file__ri 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.z help.htmlNzIDLE Help (%s))r r r r r r r )rk rl r r r!
show_idlehelp s r __main__)rM zidlelib.idle_test.test_helpr F) verbosityexit)runN)!rK Z html.parserr Zos.pathr r r r platformr Ztkinterr r r
r Z tkinter.ttkr r
r rv Zidlelib.configr r rL rx r r r rH ZunittestrM Zidlelib.idle_test.htestr r r r r! s$ v*