python (3.12.0)
̑eO. * d Z ddlmZ ddlmZmZmZmZ ddlm Z ddl
m Z m Z m
Z
ddlmZmZmZmZ ddl
mZ ddlmZ G d d
e Z G d d e Z G d
de Z G d de Zd Zd Z e dk( r ddl m Z e ddd ddl m!Z! e!e yy)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 0 e Zd ZdZd ZddZd Zd Zd Zy)
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 t j | d || _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _
d| _ g | _ d| _
d | _ y )NT)convert_charrefs Fr )r __init__texttagschartagsshowhdrlinklevelprehprefix nested_dl
simplelisttocheaderprevtag)selfr s @/BuggyBox/python/3.12.0/bootstrap/lib/python3.12/idlelib/help.pyr zHelpParser.__init__3 sm D48
c | xj |z
c_ | j dk( rd| _ ydt | j z | _ y)z#Change indent (+1, 0, -1) and tags.r r lN)r strr )r& amts r' indentzHelpParser.indentC s4
c
**/B s3tzz?/B r( c d}|D ]
\ }}|dk( s |} d}|dk( r|dgk( r d| _ n|dk( r|dk( r d| _ n|d k( rO| j rC| j d
s4| j j d d }|r|j sd
nd}nj|dk( r|dk( r d| _ nW|dk( r|dk( r d| _ nD|dk( r d| _ n6|dv r6|j
d dk7 r
d}d| _ nd| _ | j n|dk( r| j d
kD rd| _
n|dk( r| j rdnd}n|dk( r| j sd
nd}d| _
n|dk( r| j d}n|dk( r7d| _ | j r | j j d d
d | _
nY|d k( r
|d k( rd| _ nG|d k( r|| _
n:|d!v r6| j r#d| _ | j j d d
|| _
| j r3| j j d || j | j
f d|f| _ y")#z Handle starttags in help.html.r classsection)ididleTdivclearerFpr zend-1c linestartzend-1cz
spanr versionmodifiedem)ulolsimpledlliz
* z
* dtddendpreblocka
headerlinkh1)h2h3N)r r% r getisspacer findr" r- r r! r insertr r r$ )r& tagattrsclass_rD vslastlines r' handle_starttagzHelpParser.handle_starttagH s DAqG|
) .)9 9 DI
E\f 1 DI
CZDLL a yy}}%7BH"8+;+;+=4A
F]v !DM
F]v): : DM
D[ DM
L
{{8$*"&"' KKM
D[zzA~!%
D[ //xA
D[ "nn$A "DN
D[ KKMA
E\DHyy /"DI
CZFl 2 DL
D[DI
L
yy /DI 99 II UA 4=='A B c{ r( c p |dv rg| j rS|dk( rdn|dk( rdnd}| j j || j z | j j d f d| _ nB|dv rd| _ n6|d k( rd
| _ n)|d k( rd
| _ d| _ n|d v r| j d
d
|f| _ y)z Handle endtags in help.html.rF rG rH rH z rG z r rL )r7 r9 rD Fr )r: rA r; r= N) r r# appendr$ r indexr r r r r- r% )r& rM r- s r'
handle_endtagzHelpParser.handle_endtag s $ $yy(+t *$'4K& !3TYY__X5N OPDI
N
" DM
CZ DL
E\ DHDI
&
& KKO s| r( c X | j r| j s| j r|n|j dd }| j dk( r |d|j d | _ | j dv ro| j dk7 r=|dt | j | j k( r|t | j d }| xj |j z
c_ | j j d|| j | j f yyy# t $ r
d| _ Y w xY w) z"Handle date segments in help.html.r6 rF r r rU NrB )r r r replacer rW r
ValueErrorlenr$ stripr rL r )r& datads r' handle_datazHelpParser.handle_data s 99T\\ dll4&=AyyD &#$Qqwws|#4DL yy ..LLB&aDLL)*dll:#dll+,-A qwwy( II UA 4=='A B *9
" &#%DL&s
D D)(D)N) ) __name__
__module__ __qualname____doc__r r- rS rX ra r( r' r r * s# C
8#t$*Cr( r c e Zd ZdZd Zd Zy)HelpTextzDisplay help.html.c
~ t j dddd }t j dddd }d|z dz }t j | |d d
d d
|| | j g d
}| j g d }|df| d< | j d|ddf | j d|ddf | j d|ddf | j d|ddf | j d|dfd | j d |d fd d!d"d#$ | j d%d d & | j d'd(d(& | j d)d*d*& | j d+d,d,& t
| | _ t |d-. 5 }|j }d/d/d/ | j j d0| d1< y/# 1 sw Y *xY w)2z'Configure tags and feed file to parser.main EditorWindowwidthint)typeheight wordr )wraphighlightthicknesspadx borderwidthrm rp )
TkDefaultFontarial helvetica) TkFixedFontmonacocourier r r9 italicr rF boldrG rH r z#f6f6ff)r
backgroundrC
rb solidz#eeffcc)r lmargin1rx reliefr l1)r lmargin2l22 l3K l4d zutf-8)encodingNdisabledstate) r GetOptionr
r findfont
tag_configurer parseropenreadfeed) r& parentfilenameuwideuhigh
normalfont fixedfontfcontentss r' r zHelpText.__init__ s ""6>7O""6>8%PE Q
dFA !5 H ]]#JK
MM"FG "B'V 4z2x&@A 4z2v&>? 4z2v&>? 4z2v&>? 5 29M :YOb g) E 4"r: 4"r: 4"r: 4#< &
(W
- vvxH ""W
s 9F33F<c ( |D ] }|j d t j | D v r-t j |d| }|j d c S |j d t j
| D v s|c S y)z4Return name of first font family derived from names.c 3 < K | ] }|j y wNlower.0xs r' <genexpr>z$HelpText.findfont.<locals>.<genexpr> s Ka K )rootT)nameexistsr familyc 3 < K | ] }|j y wr r r s r' r z$HelpText.findfont.<locals>.<genexpr> s "G&' #$'') "Gr N)r tkfontnamesFontactualfamilies)r& r r r s r' r zHelpText.findfont s} Dzz| K6<<T3J KK {{TE{{}X.. "G+1??+E"G G
r( N)rc rd re rf r r rg r( r' ri ri s #: r( ri c e Zd ZdZd Zd Zy) HelpFramez&Display html text, scrollbar, and toc.c t j | | t | | x| _ }t | | _ d| d< | j
j
d|d | j | x| _ }t | |j x| _ }|j |d< | j dd | j dd |j ddd
|j ddd |j dd
d y )Nzhelpframe.TFramestyler )r )commandyscrollcommandr rb weightnw)rowcolumnstickynsew ns)r r ri r r r configuretoc_menur# r yviewscrollset rowconfigurecolumnconfiguregrid)r& r r r r# r s r' r zHelpFrame.__init__ s
tV$#D(33 D6]
*W
/D <N O t,,3 (tzz BB f!'
!A& Qq ) Qq. a& 1 !D 1r( c t | d }t |d }j j D ] \ }}|j ||ffd ||d< |S )z+Create table of contents as drop-down menu.TOC)r F)tearoffc & j | S r )r )dexr s r' <lambda>z$HelpFrame.toc_menu.<locals>.<lambda> s tzz# r( )labelr menu)r
r r r# add_command)r& r r# droplblr s ` r' r zHelpFrame.toc_menu s\ E*C' PHC 330N O PF
r( N)rc rd re rf r r rg r( r' r r s ,2 r( r c e Zd ZdZd Zy)
HelpWindowz!Display frame with rendered html.c t j | | | j | | j d| j t | | j
ddd | j dd | j dd y )NWM_DELETE_WINDOWr r )r r r rb r ) r r wm_titleprotocoldestroyr r grid_columnconfiguregrid_rowconfigure)r& r r titles r' r zHelpWindow.__init__ ss $'
e
($,,7$!&&aQv&F !!!A!. q +r( N)rc rd re rf r rg r( r' r r s
',r( r c t t t t t t ddddd } t t t t d }t | d 5 }t |d 5 }|D ]$ }|j |j
d z & d
d
d
d
d
d
t | d | y
# 1 sw Y "xY w# 1 sw Y &xY w) 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.
Docbuildhtmllibraryz idle.html help.htmlrbwb
Nz copied to )r r r __file__r writerstripprint)srcdstinnoutlines r'
copy_stripr s . wwwwx'8 9:; 7FI{ <C
wwx();
7C
c4 -C
c4 - -D IIdkkme+ , -- -
SESE
"# - - - -s$ '
C 4*C C C C Cc t t t t d }t | syt | |dt
z y)z7Create HelpWindow; called from Idle Help event handler.r NzIDLE Help (%s))r r r r r r r )r r s r'
show_idlehelpr s8 GGH -. <H ( vx!1N4D!DEr( __main__)rk zidlelib.idle_test.test_helpr F) verbosityexit)runN)"rf html.parserr os.pathr r r r platformr tkinterr r
r tkinter.ttkr r
r r r r idlelib.configr r ri r r r r rc unittestrk idlelib.idle_test.htestr rg r( r' <module>r s 4 # 2 2 # ( ( ; ; " #{C {C|' t ' T 8, , $@F z &!%@+
r( 
Browse
Usage
Versions