Rc@sdZddlZddlZddlZddlZddlZddlZyddlmZWn!e k rddlmZnXddl Z ddl Z ddl m Z ddlmZddlmZe jdy:ddlmZmZdd lmZdd lmZWne k r4e d nXed \ZZZd ZdefdYZ defdYZ!dZ"dZ#e$dkrej%j&d rej'dne#dGHndS(s&Sphinx directive to support embedded IPython code. This directive allows pasting of entire interactive IPython sessions, prompts and all, and their code will actually get re-executed at doc build time, with all prompts renumbered sequentially. It also allows you to input code as a pure python input by giving the argument python to the directive. The output looks like an interactive ipython section. To enable this directive, simply list it in your Sphinx ``conf.py`` file (making sure the directory where you placed it is visible to sphinx, as is needed for all Sphinx directives). By default this directive assumes that your prompts are unchanged IPython ones, but this can be customized. The configurable options that can be placed in conf.py are ipython_savefig_dir: The directory in which to save the figures. This is relative to the Sphinx source directory. The default is `html_static_path`. ipython_rgxin: The compiled regular expression to denote the start of IPython input lines. The default is re.compile('In \[(\d+)\]:\s?(.*)\s*'). You shouldn't need to change this. ipython_rgxout: The compiled regular expression to denote the start of IPython output lines. The default is re.compile('Out\[(\d+)\]:\s?(.*)\s*'). You shouldn't need to change this. ipython_promptin: The string to represent the IPython input prompt in the generated ReST. The default is 'In [%d]:'. This expects that the line numbers are used in the prompt. ipython_promptout: The string to represent the IPython prompt in the generated ReST. The default is 'Out [%d]:'. This expects that the line numbers are used in the prompt. ToDo ---- - Turn the ad-hoc test() function into a real test suite. - Break up ipython-specific functionality from matplotlib stuff into better separated code. Authors ------- - John D Hunter: orignal author. - Fernando Perez: refactoring, documentation, cleanups, port to 0.11. - VáclavŠmilauer : Prompt generalizations. - Skipper Seabold, refactoring, cleanups, pure python addition iN(tmd5(t directives(tnodes(t DirectivetAgg(tConfigtInteractiveShell(t ProfileDir(tiosrUnable to import the necessary objects from IPython. You may need to install or upgrade your IPython installation.icCsIg}|jd}t|}d}d } x||kr@Pn||} |d7}| j} | jdr|jt| fq0n| jdr| } q0n|j| } | rt| j d| j d} }ddj d gtt | d}t|}g}x}||kr||}|j|}|sV|jdrZPn1|j|r~|d||7}n |j||d7}qW|jt | |dj |ffq0n|j| }|r0t|j d|j d} }||dkr+dj |g||}n|jt |fPq0q0|S( s part is a string of ipython text, comprised of at most one input, one ouput, comments, and blank lines. The block parser parses the text into a list of:: blocks = [ (TOKEN0, data0), (TOKEN1, data1), ...] where TOKEN is one of [COMMENT | INPUT | OUTPUT ] and data is, depending on the type of token:: COMMENT : the comment string INPUT: the (DECORATOR, INPUT_LINE, REST) where DECORATOR: the input decorator (or None) INPUT_LINE: the input as string (possibly multi-line) REST : any stdout generated by the input line (not OUTPUT) OUTPUT: the output string, possibly multi-line s iit#t@is %s:tt.N(tsplittlentNonetstript startswithtappendtCOMMENTtmatchtinttgrouptjointstrtINPUTtOUTPUT(tparttrgxintrgxouttfmtintfmtouttblocktlinestNtit decoratortlinet line_strippedtmatchintlinenot inputlinet continuationtNctresttnextlinetmatchouttoutput((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt block_parserfsT     %*   %%tEmbeddedSphinxShellcBsteZdZdZdZedZdZdZdZ dZ dZ d Z d Z d ZRS( s1An embedded IPython instance to run inside SphinxcCs'tj|_t}t|j_ddg|j_t|j_ t|j_ d|j_ t j dd}d}tjj||}tj|}tjd|d|}|jt_|jt_||_|jj|_|jj|_d |_d |_t|_t|_t|_t|_dS( Nsimport numpy as npsfrom pylab import *tNoColortprefixtprofile_tauto_profile_sphinx_buildtconfigt profile_dirR ( t cStringIOtStringIOtcoutRtFalsetGlobaltdisplay_bannert exec_linesRtautocallt autoindenttcolorsttempfiletmkdtemptostpathRRtcreate_profile_dirtinstanceRtstdouttstderrtIPtuser_nstuser_global_nstinputR/t is_verbatimt is_doctestt is_suppresst_pyplot_imported(tselfR6ttmp_profile_dirtprofnametpdirtprofileRJ((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt__init__s0             cCs$|jjd|jjddS(Ni(R:tseekttruncate(RR((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt clear_coutscCs~tj}|jj}zX|jt_|j||j}|sl|jd}|jj|d|nWd|t_XdS(s#process the input, capturing stdoutit store_historyN( tsysRHRJtinput_splitterR:tpushtpush_accepts_moretsource_raw_resettrun_cell(RRR%R[RHtsplittertmoret source_raw((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytprocess_input_lines     c Cs|j}|j}|jd}|d}tjjtjj|||}d|g}xV|dD]J}|jd\} } | j} | j} |jd| | fqgWtjj |} dj|} | | fS(s # build out an image directive like # .. image:: somefile.png # :width 4in # # from an input like # savefig somefile.png width=4in t is .. image:: %sit=s :%s: %ss ( t savefig_dirt source_dirR RDREtrelpathRRRtbasename( RRR$RhRitsaveargstfilenametoutfilet imagerowstkwargtargtvalt image_filetimage_directive((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt process_image s       cCs|\}}}d}d}|dkp-|j} |dkpB|j} |dkpW|j} |dk or|jd} |jd} t| dkr| ddkr| jdqnd djd gtt |d }t|}| r |j |\}}ng}t }xt | D]\}}|j d rJt}n|d kr| r~|jd|jjd7_n|j|dtd||f}n,| s|j|dtnd||f}| s&|j|q&q&W| rt|jr| r|j|n|jjd |jj}| rV| rV|j|n|rl|jdn|jjd || || ||fS(s#Process data block for INPUT token.s @verbatims@doctests @suppresss@savefigs iiR s %s:R it;iR[s%s %sN(RRNRORPRR RRRRRuR;t enumeratetendswithtTrueReRJtexecution_countRR:RXtreadRY(RRtdatat input_promptR(R$RMR,RsRtRNRORPt is_savefigt input_linesR*R+trett is_semicolonR#R%tformatted_lineR/((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt process_input)sV *    c Cs|r|j}|}|dk r|j}|j|} | dkrjd||f} t| n|t|j}||krd|||f} t| qqndS(s$Process data block for OUTPUT token.is-output prompt="%s" does not match out line=%ssUdoctest failure for input_lines="%s" with found_output="%s" and submitted output="%s"N(RRtfindt RuntimeErrorR( RRR|t output_promptRR/RORst submittedtfoundtindte((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytprocess_outputms      cCs|js|gSdS(s'Process data fPblock for COMMENT token.N(RP(RRR|((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytprocess_comments cCs|jd|}|jddt|jddt|j|dt|jddt|jddt|jdS(s/ Saves the image file to disk. splt.gcf().savefig("%s")sbookmark ipy_thisdirR[scd -b ipy_savedirscd -b ipy_thisdirsbookmark -d ipy_thisdirN(t ensure_pyplotReR;RZ(RRRstcommand((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt save_images  cCsg}d}d}|jj}|j|}|j|}d}d} x|D]\} } | tkru|j| } nc| tkr|j| ||\} }}} }} n-| t kr|j | |||| |} n| rK|j | qKqKW|dk r|j |n|| fS(sZ process block from the block_parser and return a list of processed lines N( RRJRztpromptint promptoutRRRRRRtextendR(RRR RR/RR(R}RRsRtttokenR|tout_dataRO((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt process_blocks,     *     cCs$|jr dS|jddtdS(Nsimport matplotlib.pyplot as pltR[(RQReR;(RR((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyRs  cCsag}t}t}d}|j}d}x3t|D]%\}} | j} t| sk|j| q4n| jdr|j| gd| kr4t }q4q4n| jdr|j| gq4nddj dgtt |d} |sfd ||| f} |j| |d 7}yt j | |jd Wq#tk rbt }|}q#Xnd | | f} |j| yt j d j |||d !} t| jdt jrxI| jdjD]!}t|t jrt}qqWn|jd t}Wntk r"nX|r4|j|jd dt|jt}q4q4W|S(s content is a list of strings. it is unedited directive conent This runs it line by line in the InteractiveShell, prepends prompts as needed capturing stderr and stdout, then returns the content as a list as if it were ipython code iR tsavefigR u %s:R R iu%s %sius s plt.clf()R[N(R;RRRwRRRRRRyRRtasttparset Exceptiont isinstancetbodyt FunctionDeftReturnRReRZ(RRtcontentR/Rt multilinetmultiline_startRtctR(R%R&R*tmodifiedtmodtelement((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytprocess_pure_pythonsb      *            (t__name__t __module__t__doc__RWRZRyReRuRRRRRRR(((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyR1s 0    D    # tIpythonDirectivecBs{eZeZdZdZeZiejd6ej d6ej d6ej d6Z e Z dZ dZdZd ZRS( iitpythontsuppresstverbatimtdoctestc Cs|jjjjj}|jjjjjj}|j}tj j |jjj }|dkri|j }nt|tr|d}ntj j||}|j}|j}|j}|j}||||||fS(Ni(tstatetdocumenttsettingstenvR6tapptconfdirtipython_savefig_dirRDREtdirnametcurrent_sourceRthtml_static_pathRtlistRt ipython_rgxintipython_rgxouttipython_promptintipython_promptout( RRR6RRhRiRRRR((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytget_config_optionss        c CsgtjtjD]}|jdr|^q}|rtjjtj|d}t|jj d}|j j j |kr|j jjjd|j j_qng}|j\}}}}} } ||j _||j _| |j _| |j _||j _||j _|j jd|dt|j j|j j j |krtjdddt\} }t|d } | j|j j j d| jn||| | fS( Ntseen_docis isbookmark ipy_savedir %sR[R3ttextta( RDtlistdirRBttempdirRRERtopenR{R RRRtshellRJthistory_managertresetRzRRRRRRhRiReR;RZtmkstempRytwritetclose( RRR#t seen_docstfnametdocsRhRiRRRRtfdtfout((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytsetup3s2        cCs'|jjddt|jjdS(Nsbookmark -d ipy_savedirR[(RReR;RZ(RR((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytteardown_scCs,t}|j\}}}}|j}d|k|j_d|k|j_d|k|j_d|jkr|j}|jj ||_ndj |jj d}ddg} g} x|D]} t | ||||} t | r|jj| \} }x;| D]3}| jg|j dD]}d |^q&q W|dk r`| j|q`qqWx>| D]6}| jd| j|j d| jdqkWt | d kr|rdj | GHq|jj| |jjjd ndj | }tj||}d |d <|jgS(NRRRRs s s.. code-block:: ipythonR s %siitipythontlanguage(R;RtoptionsRRPRORNt argumentsRRRR R0RRRRRt state_machinet insert_inputRtsourceRt literal_blockR(RRtdebugRRRRRRtpartsR!tfiguresRR trowstfiguretrowR%Rttxtnode((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pytrunesD      1      (RRRyt has_contenttrequired_argumentstoptional_argumentstfinal_argumuent_whitespaceRt unchangedtflagt option_specR1RRRRR(((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyRs       , cCs|t_|jdt|jddt|jdtjdt|jdtjdt|jddt|jd d tdS( NRRRsIn \[(\d+)\]:\s?(.*)\s*RsOut\[(\d+)\]:\s?(.*)\s*RsIn [%d]:RsOut[%d]:( RRt add_directiveRtadd_config_valueRRytretcompile(R((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyRs   cCsddddddddg}|d }t}xW|D]O}|jd }td d dd |d|ddddddddddq8WdS(Ns6 In [9]: pwd Out[9]: '/home/jdhunter/py4science/book' In [10]: cd bookdata/ /home/jdhunter/py4science/book/bookdata In [2]: from pylab import * In [2]: ion() In [3]: im = imread('stinkbug.png') @savefig mystinkbug.png width=4in In [4]: imshow(im) Out[4]: s In [1]: x = 'hello world' # string methods can be # used to alter the string @doctest In [2]: x.upper() Out[2]: 'HELLO WORLD' @verbatim In [3]: x.st x.startswith x.strip s6 In [130]: url = 'http://ichart.finance.yahoo.com/table.csv?s=CROX\ .....: &d=9&e=22&f=2009&g=d&a=1&br=8&c=2006&ignore=.csv' In [131]: print url.split('&') ['http://ichart.finance.yahoo.com/table.csv?s=CROX', 'd=9', 'e=22', 'f=2009', 'g=d', 'a=1', 'b=8', 'c=2006', 'ignore=.csv'] In [60]: import urllib s\ In [133]: import numpy.random @suppress In [134]: numpy.random.seed(2358) @doctest In [135]: numpy.random.rand(10,2) Out[135]: array([[ 0.64524308, 0.59943846], [ 0.47102322, 0.8715456 ], [ 0.29370834, 0.74776844], [ 0.99539577, 0.1313423 ], [ 0.16250302, 0.21103583], [ 0.81626524, 0.1312433 ], [ 0.67338089, 0.72302393], [ 0.7566368 , 0.07033696], [ 0.22591016, 0.77731835], [ 0.0072729 , 0.34273127]]) st In [106]: print x jdh In [109]: for i in range(10): .....: print i .....: .....: 0 1 2 3 4 5 6 7 8 9 s In [144]: from pylab import * In [145]: ion() # use a semicolon to suppress the output @savefig test_hist.png width=4in In [151]: hist(np.random.randn(10000), 100); @savefig test_plot.png width=4in In [151]: plot(np.random.randn(10000), 'o'); s # use a semicolon to suppress the output In [151]: plt.clf() @savefig plot_simple.png width=4in In [151]: plot([1,2,3]) @savefig hist_simple.png width=4in In [151]: hist(np.random.randn(10000), 100); s # update the current fig In [151]: ylabel('number') In [152]: title('normal distribution') @savefig hist_with_text.png In [153]: grid(True) is RRRRR(itcontent_offsett block_textRR(tdictR tipython_directiveR(texamplesRtexampleR((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyttests         t__main__t_statics!All OK? Check figures in _static/((RR8RDRR\RBRthashlibRt ImportErrort matplotlibtsphinxtdocutils.parsers.rstRtdocutilsRtsphinx.util.compatRtusetIPythonRRtIPython.core.profiledirRt IPython.utilsRtrangeRRRR0tobjectR1RRRRREtisdirtmkdir(((s`/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/sphinxext/ipython_directive.pyt5sF             ^L