-Phl3 * d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
m Z ddl m
Z
ddlmZ ddlmZ ddlZddlmZ dd lmZ ej j d
Zd Z d Z d
Z d Z d Z d Z!d Z"d Z#d Z$d Z%d Z&ddZ'dS )zQParser for Jupyter notebooks.
Class that holds the Jupyter notebook information
N) defaultdict)partial)count)Path)ExtensionError )split_code_and_text_blockszsphinx-galleryc
t j } g dt | d z ddt | d z dd| d ddddddt | d z d j t j d
d d d
ddd}|S )z=Returns a dictionary with the elements of a Jupyter notebook.zPython r python) display_namelanguagenameipython)r versionz.pyz
text/x-pythonz{}.{}.{}N )codemirror_modefile_extensionmimetyper nbconvert_exporterpygments_lexerr )
kernelspec
language_info )cellsmetadatanbformatnbformat_minor)sys version_infostrformat)
py_versionnotebook_skeletons W/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/sphinx_gallery/notebook.pyjupyter_notebook_skeletonr% s !J !*C
1
,>,> > $ 3z!}#5#55 -6*Q-#P#P"' + &."+c*Q-.@.@"@,:,c.>rr.BC
' * c t dd }d || | | d S )z Helper to fill in directives.infodanger)notewarningz6r )dictr!
capitalizegroupstrip)match directivedirective_to_alerts r$
directive_funr3 : s[ 68<<< C J J9%y';';'='=u{{1~~?S?S?U?U r& c d} t j || }|sn+| d }| d t | z
}t j dt j | dt j }| | | }|r| nt | }t j
| || }d| d d| d } | d
| d | z | |d
z } D| S ) a+ Rewrite code blocks to use Markdown's preferred backtick notation.
Backtick notation preserves syntax highlighting.
Parameters
----------
text: str
A mostly converted string of markdown text. May contain zero, one,
or multiple code blocks in code-block format.
z4[ \t]*\.\. code-block::[ \t]*(\S*)\n[ \t]*\n([ \t]+)T r z^(?!z
)[ \t]*\S+z```
z
```
Nr ) researchr. spanlencompileescape MULTILINEstarttextwrapdedentrstrip)
text
code_regex
code_blockindent start_indexendcode_end_match end_indexcontentsnew_codes
r$ convert_code_to_mdrL B sG IJJYz400
!!!$$ oo''*S[[8 j>6!2!2>>> MM D+66.<KN((***#d)) ?4 I(=#>??FFHHA))!,,AAAAA*joo''**+h6ijj9II J Kr& c ~ d}t j d | t j }t j |fd| } t j dt j }t j |d | } t j dt j }t j |d| } d }|D ]O} t j d
| z t j }
t j |
t
t | | } Pt j d t j } t j | d
| } t j d } t j | d| } t j d }
t j |
d| } t j dt j }t j |d
| } t j dt j }t j dt j t j |fd| } t | } | S )a Converts reST from docstrings and text blocks to markdown for Jupyter notebooks.
Parameters
----------
text: str
reST input to be converted to MD
gallery_conf : dict
The sphinx-gallery configuration dictionary.
target_dir : str
Path that notebook is intended for. Used where relative paths
may be required.
heading_levels: dict
Mapping of heading style ``(over_char, under_char)`` to heading level.
Note that ``over_char`` is `None` when only underline is present.
z=`:.'"~^_*+#<>-z(?P\A|^[ \t]*\n)(?:(?P[{0}])(?P=over)*\n[ \t]*)?(?P\S[^\n]*)\n(?P(?(over)(?P=over)|[{0}]))(?P=under)*$)flagsc dj d| dd z g| dd R S )Nz
{1}{0} {2}#overunderpreheading)r! r. )r0 heading_levelss r$ zrst2md.. sM )l) .VW!=!=> >
[[
*
*
r& z"^\.\. math::((?:.+)?(?:\n+^ .+)*)c v d | d S )Nz \begin{{align}}{0}\end{{align}}r )r! r. r/ )r0 s r$ rV zrst2md.. s+ 8?? A@T@T@V@VWW r& z
:math:`(.+?)`z$\1$)r+ r* z ^\.\. %s::((?:.+)?(?:\n+^ .+)*))r1 z^ *\.\. _.*:.*$\n z`([^`]*?)\s*<([^`]*)>`_z[\1](\2)z:ref:``z'^\s*\.\. contents::.*$(\n +:\S+: *$)*\nz'^\.\. image::(.*$)((?:\n +:\S+:.*$)*)\nz\n +:(\S+): +(.*)$c
d t | d t j d| d pd S )Nz
r z \1="\2"r5 rX )r! generate_image_srcr. r/ r7 sub)r0 gallery_conf
image_opts
target_dirs r$ rV zrst2md.. s] *11 u{{1~~ 3 3 5 5|Z P P F:{EKKNN,@b A A
r& ) r7 r; r! Mr\ DOTALLr r3 rL )rB r] r_ rU adornment_charactersheadingsmath_eq inline_math
directivesr1 directive_refootnote_links
embedded_urisrefsrJ imagesr^ s ``` @r$ rst2mdrl ` s; $ .z
F' ( (d H 6
D j>bdKKKG
6WW D
* -ry99K
6+w - -D$J W W z /) ;24
vlGMY$O$O$OQUVVZ 4BDAAAN
6."d + +DJ 9::M
6-d 3 3D
:i D
6$T " "DzDBDQQQH
6(B % %D
ZB"$
O
O
OF 1>>>J
6
D d # #D Kr& c t t j d| r| S |d sd| d z S | d r |d }| d } t j || dt j }t |d t rQ|d }t j ||d }|| t j d z S t |d 5 }t j | }ddd n # 1 swxY w Y n!# t $ r t# d| d w xY wt% j | }d
|d d | d
S )aF Modify image path for notebook, according to "notebook_images" config.
URLs are unchanged.
If "notebook_images" config is a str, it is used as a prefix to image path, relative
to "src_dir". If "notebook_images" is `True`, image is embedded as URI. If
"notebook_images" is `False`, "file://" is prepended.
z https?://notebook_imageszfile:///src_dirrbNzUnable to open z to generate notebook data URIzdata:r z;base64,ascii)r7 r0 lstrip
startswithospathjoinreplacesep
isinstancer relpathopenbase64 b64encodereadOSErrorr mimetypes
guess_typedecode)
image_pathr] r_ full_pathprefixrel_path
image_filedata mime_types r$ r[ r[ s
x j)) ) * 2:,,S1111 S!! ,!),
&&s++
Z););C)H)HIII, 01377 D /07??9l9.EFF((5555 i&&
;* '
(9(9::
;
;
;
;
;
;
;
;
;
;
;
;
;
;
; K)KKK
(33 Cy|CCT[[-A-ACCCs0 E$ %'E E$ E E$ E E$ $ Fc |d }|d }t }|t || t || || |t || |S )aL Generate a Jupyter notebook file cell-by-cell.
Parameters
----------
script_blocks : list
Script execution cells.
gallery_conf : dict
The sphinx-gallery configuration dictionary.
target_dir : str
Path that notebook is intended for. Used where relative paths
may be required.
first_notebook_celllast_notebook_cell)r%
add_code_cell
fill_notebook)
script_blocksr] r_
first_cell last_cell
work_notebooks r$ jupyter_notebookr sk 34J 12I-//M mZ000- jIII mY/// r& c v ddddig | gd}| d | dS )zhAdd a code cell to the notebook.
Parameters
----------
code : str
Cell content
codeN collapsedF) cell_typeexecution_countr outputssourcer )r/ append)r r code_cells r$ r r sO %(::<<. I '!!),,,,,r& c J di |gd}| d | dS )zzAdd a markdown cell to the notebook.
Parameters
----------
markdown : str
Markdown cell content.
markdown)r r r r N)r )r r
markdown_cells r$ add_markdown_cellr s4 #-"
SSM'!!-00000r& c \ d}d}t j || D ]}||| d }|r$| st | | | d }| d }t
| | ||d S )a Promote Jupyter cell magic in text blocks to code block in notebooks.
Parses a block of markdown text looking for code blocks starting with a
Jupyter cell magic (e.g. %%bash). Whenever one is found, the text before it
and the code (as a runnable code block) are added to work_notebook. Any
remaining text is returned.
Parameters
----------
markdown : str
Markdown cell content.
z*\n?```\s*[a-z]*\n(%%(?:[\s\S]*?))\n?```\n?r r N)r7 finditerr9 isspacer r. r )r r cell_magic_regextext_cell_start
magic_cell
text_blockrD s r$ promote_jupyter_cell_magicr s EOk"2H== 1 1
o
0A0A!0D DE
9j 0 0 2 2 9 mZ 8 8 8$//++A. %%a((
mZ0000 O$$ %%r& c t d t fd }|D ]\ }}}|dk rt | | |d du rt |dz ||| }ndd l} | j |fd
d d |d }|d
r7t
| | }
|
r$|
st | |
t | | d S )zWrites the Jupyter notebook cells.
If available, uses pypandoc to convert rst to markdown.
Parameters
----------
script_blocks : list
Each list element should be a tuple of (label, content, lineno).
r )r> c " t S )N)next)heading_level_counters r$ rV z fill_notebook..= s .C)D)D r& r pypandocFr6 r Nmdrst)tor! promote_jupyter_magic) r r r rl r convert_textr r r ) r r r] r_ rU blabelbcontentlinenor r remainingr s @r$ r r 2 s6 "NNN !D!D!D!DEEN$1 ; ; & V - 2 2 2 2J'500! tO\:~ 180 !%e 7CJ7O 34
; 6}h O O @Y%6%6%8%8 @%mY???!-::::+; ;r& c t |d 5 }t j | |d ddd dS # 1 swxY w Y dS )z.Saves the Jupyter work_notebook to write_file.wr5 )rE N)r| jsondump)r
write_fileout_nbs r$
save_notebookr V s
j# 3& -22223 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3s 6::c 8 ddl m} t j d }| ddd | | | } t
j |j }|| | | j
D ]}t | \ }}t d
| t j | } t! |t
j | | }
t# |
t% | d d S ) zExposes the jupyter notebook renderer to the command line.
Takes the same arguments as ArgumentParser.parse_args.
`sphinx_gallery_conf` functions same as in `conf.py`.
r ) gen_galleryz!Sphinx-Gallery Notebook converter) descriptionpython_src_file+z\Input Python file script to convert. Supports multiple files and shell wildcards (e.g. *.py))nargshelpNz Converting z.ipynb)rX r argparseArgumentParser add_argument
parse_argscopydeepcopyDEFAULT_GALLERY_CONFupdater r printru rv dirnamer r r with_suffix) args namespacesphinx_gallery_confr parserr] src_file file_confblocksr_
example_nbs r$ python_to_jupyter_clir ` s8
$1T
U
U
UF
T9 - -D =!ABBL& /000 ( H H 6x @ @ 6
&H&&'''W__X..
%fdmL.I.I:VV
j$x.."<"r s
# # # # # # ( ( ( ( ( ( 8 8 8 8 8 8 & &'7 8 8 6 !; !; !;H3 3 3 H H H H H Hr&