Mh_ dZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z gdZ Gdd eZd ZGd d ZGd deZGddeZGddeeZGddZGddeeZGddeeZ d=dZedkrddlZejd !Zed"d#d$d%&ed'd(d$d)&ed*d+dd,-ed.d/d0d1-ed2d3d$d4&ed5d6dd7-ed8d9d:;eZeej dej!ej"ej#ej$ej%ej&<dSdS)>aModule for interactive demos using IPython. This module implements a few classes for running Python scripts interactively in IPython for demonstrations. With very simple markup (a few tags in comments), you can control points where the script stops executing and returns control to IPython. Provided classes ---------------- The classes are (see their docstrings for further details): - Demo: pure python demos - IPythonDemo: demos with input to be processed by IPython as if it had been typed interactively (so magics work, as well as any other special syntax you may have added via input prefilters). - LineDemo: single-line version of the Demo class. These demos are executed one line at a time, and require no markup. - IPythonLineDemo: IPython version of the LineDemo class (the demo is executed a line at a time, but processed via IPython). - ClearMixin: mixin to make Demo classes with less visual clutter. It declares an empty marquee and a pre_cmd that clears the screen before each block (see Subclassing below). - ClearDemo, ClearIPDemo: mixin-enabled versions of the Demo and IPythonDemo classes. Inheritance diagram: .. inheritance-diagram:: IPython.lib.demo :parts: 3 Subclassing ----------- The classes here all include a few methods meant to make customization by subclassing more convenient. Their docstrings below have some more details: - highlight(): format every block and optionally highlight comments and docstring content. - marquee(): generates a marquee to provide visible on-screen markers at each block start and end. - pre_cmd(): run right before the execution of each block. - post_cmd(): run right after the execution of each block. If the block raises an exception, this is NOT called. Operation --------- The file is run in its own empty namespace (though you can pass it a string of arguments as if in a command line environment, and it will see those as sys.argv). But at each stop, the global IPython namespace is updated with the current internal demo namespace, so you can work interactively with the data accumulated so far. By default, each block of code is printed (with syntax highlighting) before executing it and you have to confirm execution. This is intended to show the code to an audience first so you can discuss it, and only proceed with execution once you agree. There are a few tags which allow you to modify this behavior. The supported tags are: # stop Defines block boundaries, the points where IPython stops execution of the file and returns to the interactive prompt. You can optionally mark the stop tag with extra dashes before and after the word 'stop', to help visually distinguish the blocks in a text editor: # --- stop --- # silent Make a block execute silently (and hence automatically). Typically used in cases where you have some boilerplate or initialization code which you need executed but do not want to be seen in the demo. # auto Make a block execute automatically, but still being printed. Useful for simple code which does not warrant discussion, since it avoids the extra manual confirmation. # auto_all This tag can _only_ be in the first block, and if given it overrides the individual auto tags to make the whole demo fully automatic (no block asks for confirmation). It can also be given at creation time (or the attribute set later) to override what's in the file. While _any_ python file can be run as a Demo instance, if there are no stop tags the whole file will run in a single block (no different that calling first %pycat and then %run). The minimal markup to make this useful is to place a set of stop tags; the other tags are only there to let you fine-tune the execution. This is probably best explained with the simple example file below. You can copy this into a file named ex_demo.py, and try running it via:: from IPython.lib.demo import Demo d = Demo('ex_demo.py') d() Each time you call the demo object, it runs the next block. The demo object has a few useful methods for navigation, like again(), edit(), jump(), seek() and back(). It can be reset for a new run via reset() or reloaded from disk (in case you've edited the source) via reload(). See their docstrings below. Note: To make this simpler to explore, a file called "demo-exercizer.py" has been added to the "docs/examples/core" directory. Just cd to this directory in an IPython session, and type:: %run demo-exercizer.py and then follow the directions. Example ------- The following is a very simple example of a valid demo file. :: #################### EXAMPLE DEMO ############################### '''A simple interactive demo to illustrate the use of IPython's Demo class.''' print('Hello, welcome to an interactive IPython demo.') # The mark below defines a block boundary, which is a point where IPython will # stop execution and return to the interactive prompt. The dashes are actually # optional and used only as a visual aid to clearly separate blocks while # editing the demo code. # stop x = 1 y = 2 # stop # the mark below makes this block as silent # silent print('This is a silent block, which gets executed but not printed.') # stop # auto print('This is an automatic block.') print('It is executed without asking for confirmation, but printed.') z = x + y print('z =', x) # stop # This is just another normal block. print('z is now:', z) print('bye!') ################### END EXAMPLE DEMO ############################ N)Pathmarquee)openpy) py3compat)Demo IPythonDemoLineDemoIPythonLineDemo DemoErrorceZdZdS)r N__name__ __module__ __qualname__P/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/IPython/lib/demo.pyr r srr cFtjd|ztjS)Nz^\s*#\s+\s+%s\s*$)recompile MULTILINE)marks rre_markrs :047 E EErceZdZedZedZedZedZ d d Zd Z d Z d Z dZ dZ dZd!dZd!dZdZd"dZd"dZdZdZd"dZd#dZdZdZdZdS)$rz-*\s?stop\s?-*silentautoauto_allNFterminaldefaultc t|drd|_|dkrd|_nF||_n>||_|dkr*tj|\}} | |_n||_|gt j|z|_||_||_ t} d|_ n#t$r d|_ YnwxYw|j r7| j |_| j|_| j|_| j|_| |_t,j|||_t,jd|_||_|r$t,jd|_|d S) aMake a new demo object. To run the demo, simply call the object. See the module docstring for full details and an example (you can use IPython.Demo? in IPython to see it). Inputs: - src is either a file, or file-like object, or a string that can be resolved to a filename. Optional inputs: - title: a string to use as the demo name. Of most use when the demo you are making comes from an object that has no filename, or if you want an alternate denotation distinct from the filename. - arg_str(''): a string of arguments, internally converted to a list just like sys.argv, so the demo script can see a similar environment. - auto_all(None): global flag to run all blocks automatically without confirmation. This attribute overrides the block-level tags and applies to the whole demo. It is an attribute of the object, and can be changed at runtime simply by reassigning it to a boolean value. - format_rst(False): a bool to enable comments and doc strings formatting with pygments rst lexer - formatter('terminal'): a string of pygments formatter name to be used. Useful values for terminals: terminal, terminal256, terminal16m - style('default'): a string of pygments style name to be used. readzfrom a file-like objectrTF)stylepy3rstN) hasattrfnametitleospathsplitshlexsys_argvrsrc get_ipythoninside_ipython NameErroruser_nsip_ns pycolorize ip_colorize showtraceback ip_showtbrun_cell ip_run_cellshellpygments formattersget_formatter_by_name formatterlexersget_lexer_by_name python_lexer format_rst rst_lexerreload) selfr/r)arg_strrrCr?r$filepathfilenameips r__init__z Demo.__init__sJ 3   #2DJ{{6 " DJ{{')w}}S'9'9$8% "  G 4 44    (B"&D   ( ( ("'D    (   " "zDJ!}D !/DN!{D !DJ!,BB9INCPP$O==eDD$  F%_>>uEEDN sB..CCct|dr |j|jt|jdr|j|_dSt j|j|_dS)zLoad file object.fobjNr#)r'rMcloser/ropenr(rFs rfloadz Demo.fload!si 4  TY%: 9??    48V $ $ 0DIII DJ//DIIIrcdtjj_djjD}fd|D_fd|D_ j 3tj |d_ ntj _ g}fd}t|D]F\}}j |r|||1||Gj d|d|d<t#|_|_t)t+jj_dS)-Reload source from disk and initialize state.rc:g|]}||Srstrip).0bs r zDemo.reload..2s%MMMa1M MMMrc^g|])}tj|*Sr)bool re_silentfindallrWrXrFs rrYzDemo.reload..3s1GGGAT^33A6677GGGrc^g|])}tj|*Sr)r[re_autor]r^s rrYzDemo.reload..4s1EEE!T\11!4455EEErNrc:jd|S)Nr)r`sub)srFs rzDemo.reload..?st|//155r)rQjoinrstrip_encoding_cookierMr/re_stopr,_silent_autorr[ re_auto_allr] enumerateappendrblennblocks src_blockslistmap highlightsrc_blocks_coloredreset)rFsrc_bro auto_stripirXs` rrEz Demo.reload-s wwv;DIFFGGMM4<+=+=dh+G+GMMMGGGGGGG EEEEuEEE  =  !1!9!9%(!C!CDDDMM //DM 5555 U## % %CAaz!} %!!**Q--0000!!!$$$$(,,R 1 >> 1 : $#'s4>$/'J'J"K"K rc0i|_d|_d|_dS)z8Reset the namespace and seek pointer to restart the demoFrN)r3finished block_indexrPs rrtz Demo.resetQs   rcL|dks ||jkrtd|zdS)Nrzinvalid block index %s)rn ValueErrorrFindexs r_validate_indexzDemo._validate_indexWs3 77eT\))5=>> >*)rct| |jrtddS|j}n|||S)zjGet the current block index, validating and checking status. Returns None if the demo is finishedNz@Demo finished. Use .reset() if you want to rerun it.)ryprintrzrr}s r _get_indexzDemo._get_index[sJ =} XYYYt$EE   ' ' ' rcl|dkr |j|z}||||_d|_dS)zMove the current seek pointer to the given block. You can use negative indices to seek from the end, with identical semantics to those of Python lists.rFN)rnrrzryr}s rseekz Demo.seekis@ 77L5(E U###  rc@||j|z dS)z5Move the seek pointer back num blocks (default is 1).NrrzrFnums rbackz Demo.backts" $"3&'''''rc@||j|zdS)zzJump a given number of blocks relative to the current one. The offset can be positive or negative, defaults to 1.Nrrs rjumpz Demo.jumpxs$ $"3&'''''rcD|d|dS)z4Move the seek pointer back one block and re-execute.rN)rrPs ragainz Demo.again~s  !  rc||}|dS|dkr|dz}|j|j|}|jj|dt t|dd5}|}dddn #1swxYwY||j|<| ||j |<||_ |dS)aEdit a block. If no number is given, use the last block executed. This edits the in-memory copy of the demo, it does NOT modify the original source file. If you want to do that, simply open the file in an editor and use reload() when you make changes to the file. This method is meant to let you change a block during a demonstration for explanatory purposes, without damaging your original script.Nrrrzutf-8)encoding) rr; mktempfilerohookseditorrOrr#rrrsrz)rFr~rIf new_blocks reditz Demo.edits"&& = F 77 QJE:(()?@@ !,,, $x..# 8 8 8 !AI ! ! ! ! ! ! ! ! ! ! ! ! ! ! !"+)- )B)B&  s B**B.1B.c  ||}|dSt|d|jd|d|j|z dz dt|j|t jdS)zShow a single block on screenN< > block #  (r remaining)) rrrr)rnrssysstdoutflushr}s rshowz Demo.shows&& = F dlll JJJuuuT\%-?-A-A-ACDD E E E d%e,--- rc |j}|j}|j}|j}|j}t |jD]o\}}||r)t |d|d|d||z dz dn(t |d|d|d||z dz dt |dptj d S) z*Show entire demo on screen, block by blockrz> SILENT block # rrrr endN) r)rnrhrrkrsrrrr)rFr(r)rnrrr~blocks rshow_allz Demo.show_alls   ,,$T%<== " "KE%e} >ggg$uuUUU75=???<==>>>>ggg$uuUUU75=???<==>>> %S ! ! ! ! ! rc0t||jdSz/Execute a string with one or more lines of codeN)execr3rFsources rr9z Demo.run_cells VT\"""""rc ||}|dS |j}|j|}|xjdz c_|j|r+t |d|d|j|z dz dn||||j s |j |rt |dn[t |dd tj }|rt |d dS tj}|jt_||||t_n#|t_wxYw |jr|j|jn)#|jr||j YnxYw|j|jkr_|d }|r?t t |t |d d|_dSdS)abrun a block of the demo. If index is given, it should be an integer >=1 and <= nblocks. This means that the calling convention is one off from typical Python lists. The reason for the inconsistency is that the demo always prints 'Block n/N, and N is the total, so it would be very odd to use zero-indexing here.NrzExecuting silent block # rrzoutput:z(Press to quit, to execute...rrzBlock NOT executed)rIz END OF DEMOz0Use .reset() if you want to rerun it.T)rrrorzrhrrnpre_cmdrrririnputrVrargvr.r9post_cmdr1r4updater3r8r(ry)rFr~r next_blockans save_argvmq1s r__call__z Demo.__call__se&& = F 0lG/J    !  |E" ggg$uuT\%%7%9%9%9;<<====  %   =DJu$5''),,----''"LMMSVWWWW#/++1133Cgg&:;;<<< %H = j))) $9$$$$ " 0 !!$,///  4" 4 333  t| + +,,}--C Xc dll#UVVWWW DMMM , +s%D F5)AE</ F5<F  F55$GN*c$t|||S)z0Return the input string centered in a 'marquee'.rrFtxtwidthrs rrz Demo.marqueess5&&&rcdS)z*Method called before executing each block.NrrPs rrz Demo.pre_cmd rcdS)z)Method called after executing each block.NrrPs rrz Demo.post_cmdrrc 2tj||j}|jr\ddlm}g}|D]N}|d|jjkrt|ddkr|tj|ddd|jz }|tj|ddd|j z }|tj|ddd|jz }|d|j j kro| |j j |ddf|ttj|ddd|j ddz }9| |P|}tj||jS) z3Method called on each block to highlight it contentr)TokenrN)r<lexrBrCpygments.tokenrStringDocrmrDCommentSinglerlrpformatr?)rFrtokensrtokstokens rrrzDemo.highlights}eT%677 ?  , , , , , ,D ' '8u|///CaMMA4E4EHLq"1"t7HIIIDHLq!B$HHHDHLq"##8IJJJDD1X!555KK!5uQx{ CDDDDeAhqrrlDN!K!KLLSbSQQDDKK&&&&Fvt~666r)rrNFr r!)r)Nrrr)rrrrrgr\r`rjrKrQrErtrrrrrrrrrr9rrrrrrrrrrrs'+,,G'(##I'&//G'*%%KHM-6QQQQf 0 0 0"""H ???      ((((((((  <    $### 4!4!4!4!p''''      77777rrceZdZdZdZdS)r aDClass for interactive demos with IPython's input processing applied. This subclasses Demo, but instead of executing each block by the Python interpreter (via exec), it actually calls IPython on it, so that any input filters which may be in place are applied to the input block. If you have an interactive environment which exposes special input processing, you can use this class instead to write demo scripts which operate exactly as if you had typed them interactively. The default Demo class requires the input to be valid, pure Python code. c:|j|dSr)r;r9rs rr9zIPythonDemo.run_cell,s  F#####rN)rrr__doc__r9rrrr r s-  $$$$$rr ceZdZdZdZdS)r aDemo where each line is executed as a separate block. The input script should be valid Python code. This class doesn't require any markup at all, and it's meant for simple scripts (with no nesting or any kind of indentation) which consist of multiple lines of input to be executed, one at a time, as if they had been typed in the interactive prompt. Note: the input can not have *any* indentation, which means that only single-lines of input are accepted, not even function definitions are valid.c||j}d|D}t|}d||_dg|z|_dg|z|_d|_||_ ||_ tt|j |j |_|dS)rSc:g|]}||SrrU)rWls rrYz#LineDemo.reload..Ds%999qwwyy91999rrFTN)rQrM readlinesrmrer/rhrirrnrorprqrrrsrt)rFlinesrurns rrEzLineDemo.reload?s )--//99e999e**''%.. ''/ &.  ! #'s4>$/'J'J"K"K rN)rrrrrErrrr r 1s-  rr ceZdZdZdS)r zBVariant of the LineDemo class whose input is processed by IPython.N)rrrrrrrr r TsLLDrr c eZdZdZddZdZdS) ClearMixinaUse this mixin to make Demo classes with less visual clutter. Demos using this mixin will clear the screen before every block and use blank marquees. Note that in order for the methods defined here to actually override those of the classes it's mixed with, it must go /first/ in the inheritance tree. For example: class ClearIPDemo(ClearMixin,IPythonDemo): pass will provide an IPythonDemo class with the mixin's features. rrrcdS)z7Blank marquee that returns '' no matter what the input.rrrs rrzClearMixin.marqueehsrrc&ddlm}|dS)zVMethod called before executing each block. This one simply clears the screen.r) _term_clearN)IPython.utils.terminalr)rFrs rrzClearMixin.pre_cmdls% 766666 rNr)rrrrrrrrrrrYsA  rrceZdZdS) ClearDemoNrrrrrrsDrrceZdZdS) ClearIPDemoNrrrrrrwrrrFTr native...c|rt}nt}||||||}|jsK| tjd|zn#t $rt dYnwxYw|jIdSdS)N)rCr?r$r r)rrryrrKeyboardInterruptexit) file_pathnoclearrCr?r$r delimiter demo_classdemos rslider{s  :iJ)!H 6 6 6Dm   OD9, - - - -     GGGGG  msA A('A(__main__zRun python demos) descriptionz --noclearz-C store_truez#Do not clear terminal on each slide)actionhelpz--rstz-rz'Highlight comments and dostrings as rstz --formatterz-fzDpygments formatter name could be: terminal, terminal256, terminal16m)r!rz--stylez-sr!zpygments style namez--autoz-az0Run all blocks automatically withoutconfirmationz --delimiterz-dz+slides delimiter added after each slide runfilerzpython demo file)nargsr)rrCr?r$rr)FTr rFr)'rr*rr-rr<pathlibrIPython.utils.textr IPython.utilsrr__all__ Exceptionr rrr r r rrrrrargparseArgumentParserparser add_argument parse_argsargsrrr&r?r$rrrrrrsjjj &&&&&& ###### I I I FFFU7U7U7U7U7U7U7U7p $$$$$$$$$$     t   F     k(   4     4        *[   @J49     zOOO $X $1C D D DF  T,BDDD lFHHH  tZ3444  42444 $|'(((  tUJLLL a/111     D E$)A, N$*tyN$$$$$$)r