B Z[T@sdZddlZddlZddlmZddlmZddlmZddl m Z dd l m Z dd l mZdd lmZddlZGd d d eZGdddeZdS)zTest NbConvertAppN) TestsBase)PostProcessorBase)onlyif_cmds_exist) nbconvertapp)Exporter)check_help_all_output)tempdirc@seZdZddZdS) DummyPostcCstd|dS)NzDummy:%s)print)selffilenamer@lib/python3.7/site-packages/nbconvert/tests/test_nbconvertapp.py postprocessszDummyPost.postprocessN)__name__ __module__ __qualname__rrrrrr sr c@seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ e ddddZe ddddZddZe dddZe dddZe dd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Ze ddd.d/Zd0d1Zd2d3Zd4d5Zd6d7Zd8d9Zd:d;Z dd?Z"d@dAZ#dBdCZ$dDdEZ%e dddFdGZ&e ddHdIZ'e ddJdKZ(e ddLdMZ)dNS)OTestNbConvertAppz Collection of NbConvertApp testsc Cs6|$|jddd\}}|d|WdQRXdS)z-Will help show if no notebooks are specified?z --log-level 0T)ignore_return_codez --help-allN)create_temp_cwd nbconvertassertIn)r outerrrrrtest_notebook_help!s z#TestNbConvertApp.test_notebook_helpcCs tddS)z"ipython nbconvert --help-all worksrN)r )r rrrtest_help_output'sz!TestNbConvertApp.test_help_outputc CsF|dg0|dtjds(ttjds8tWdQRXdS)z= Do search patterns work for notebook names? znotebook*.ipynbz!--to python *.ipynb --log-level 0z notebook1.pyz notebook2.pyN)rrospathisfileAssertionError)r rrr test_glob+s zTestNbConvertApp.test_globc Csr|`|dgd|dtjddtjtjddsJttjtjddsdtWdQRXdS) zJ Do search patterns work for subdirectory notebook names? znotebook*.ipynbzsubdir/z--to python --log-level 0 subdirz*.ipynbz notebook1.pyz notebook2.pyN)r copy_files_torrrjoinr r!)r rrrtest_glob_subdir4s  z!TestNbConvertApp.test_glob_subdirc Cs^|L|dgd|dtjddtjds@ttjdsPtWdQRXdS) z'build_directory affects export locationznotebook*.ipynbzsubdir/z)--to python --log-level 0 --output-dir . r#z*.ipynbz notebook1.pyz notebook2.pyN)rr$rrrr%r r!)r rrrtest_build_dir?s  zTestNbConvertApp.test_build_dirc Csr|`|dgd|dtjddtjtjddsJttjtjddsdtWdQRXdS)z| Test that nbconvert can convert file using a full qualified name for a package, import and use it. znotebook*.ipynbr#z=--to nbconvert.tests.fake_exporters.MyExporter --log-level 0 z*.ipynbznotebook1.test_extznotebook2.test_extN)rr$rrrr%r r!)r rrr test_convert_full_qualified_nameHs  z1TestNbConvertApp.test_convert_full_qualified_namec CsF|dg0|dtjdr(ttjds8tWdQRXdS)z2 Do explicit notebook names work? znotebook*.ipynbz#--log-level 0 --to python notebook2z notebook1.pyz notebook2.pyN)rrrrr r!)r rrr test_explicitTs zTestNbConvertApp.test_explicitc Cs|dgt~}tj|d}d}t|d}||WdQRX|d|tj dsht td}| }WdQRX||kst WdQRXWdQRXdS)z"--template '/path/to/template.tpl'znotebook*.ipynbzmytemplate.tplzsuccess!wNz%--log-level 0 notebook2 --template %sznotebook2.html) rr TemporaryDirectoryrrr%openwriterr r!read)r Ztdtemplate test_outputftextrrrtest_absolute_template_file]s  z,TestNbConvertApp.test_absolute_template_filec Cs|dgtdtjdd}d}t|d}||WdQRX|d|tjdsht td}| }WdQRX||kst WdQRXdS) z#Test --template 'relative/path.tpl'znotebook*.ipynbZrelativezpath.tplzsuccess!r*Nz%--log-level 0 notebook2 --template %sznotebook2.html) rrmkdirrr%r,r-rr r!r.)r r/r0r1r2rrrtest_relative_template_filejs   z,TestNbConvertApp.test_relative_template_fileZpandocZxelatexc CsB|dg,tdd|dtjds4tWdQRXdS)zS Generate PDFs with graphics if notebooks have spaces in the name? znotebook2.ipynbznotebook with spaces.ipynbzd--log-level 0 --to pdf "notebook with spaces" --PDFExporter.latex_count=1 --PDFExporter.verbose=Trueznotebook with spaces.pdfN)rrrenamerrr r!)r rrrtest_filename_spacesxs  z%TestNbConvertApp.test_filename_spacesc Cs6|dg |dtjds(tWdQRXdS)zT Check to see if pdfs compile, even if strikethroughs are included. znotebook2.ipynbzY--log-level 0 --to pdf "notebook2" --PDFExporter.latex_count=1 --PDFExporter.verbose=Truez notebook2.pdfN)rrrrr r!)r rrrtest_pdfs zTestNbConvertApp.test_pdfc Cs6|dg |d\}}|d|WdQRXdS)zDo post processors work?znotebook1.ipynbzV--log-level 0 --to python notebook1 --post nbconvert.tests.test_nbconvertapp.DummyPostzDummy:notebook1.pyN)rrr)r rrrrrtest_post_processorsz$TestNbConvertApp.test_post_processorc Cs|dgr|dtjds(ttd}|}WdQRX|dtjds^ttd}|}WdQRXWdQRX|| d| d|| d| ddS) zCheck for extra CR charactersznotebook2.ipynbz"--log-level 0 --to latex notebook2z notebook2.texNz!--log-level 0 --to html notebook2znotebook2.html z ) rrrrr r!r,r.Z assertEqualcount)r r1ZtexZhtmlrrrtest_spurious_crs    z!TestNbConvertApp.test_spurious_crc CsZ|dgD|dtjds(ttd}d|ksBtWdQRXWdQRXdS)z)Is embedded png data well formed in HTML?znotebook2.ipynbz7--log-level 0 --to HTML notebook2.ipynb --template fullznotebook2.htmlzdata:image/png;base64,b'N)rrrrr r!r,r.)r r1rrrtest_png_base64_html_oks   z(TestNbConvertApp.test_png_base64_html_okc CsZ|dgD|dtjds(ttd}d|ksBtWdQRXWdQRXdS)z+ Do export templates work? znotebook2.ipynbz)--log-level 0 --to slides notebook2.ipynbznotebook2.slides.htmlz /reveal.cssN)rrrrr r!r,r.)r r1rrr test_templates   zTestNbConvertApp.test_templatec CsP|dg:|dtjds(t|dtjdsBtWdQRXdS)ztest --output=outputfile[.ext]znotebook1.ipynbz8--log-level 0 --to python notebook1.ipynb --output nb.pyznb.pyz6--log-level 0 --to python notebook1.ipynb --output nb2znb2.pyN)rrrrexistsr!)r rrrtest_output_exts   z TestNbConvertApp.test_output_extc CsF|dg0|dtjds(ttjds8tWdQRXdS)z[ Can a search pattern be used along with matching explicit notebook names? znotebook*.ipynbzA--log-level 0 --to python *.ipynb notebook1.ipynb notebook2.ipynbz notebook1.pyz notebook2.pyN)rrrrr r!)r rrrtest_glob_explicits z#TestNbConvertApp.test_glob_explicitc CsF|dg0|dtjds(ttjds8tWdQRXdS)zY Can explicit notebook names be used and then a matching search pattern? znotebook*.ipynbzA--log-level 0 --to=python notebook1.ipynb notebook2.ipynb *.ipynbz notebook1.pyz notebook2.pyN)rrrrr r!)r rrrtest_explicit_globs z#TestNbConvertApp.test_explicit_globc CsH|ddg0|dtjds*ttjdr:tWdQRXdS)z/ Does the default config work? znotebook*.ipynbzjupyter_nbconvert_config.pyz --log-level 0z notebook1.pyz notebook2.pyN)rrrrr r!)r rrrtest_default_configs z$TestNbConvertApp.test_default_configc CsJ|dddg0|dtjdr,ttjds Verify that the output suffix is not applied z empty.ipynboutputz>empty.ipynb --to notebook --FilesWriter.build_directory=outputzoutput/empty.ipynbN)rrErr4rrr r!)r rrrtest_different_build_dirs    z)TestNbConvertApp.test_different_build_dirc Cs\|J|d|dtjds.ttjdr>ttjdrNtWdQRXdS)z@ Verify that the notebook is converted in place z empty.ipynbzempty.ipynb --inplacezempty.nbconvert.ipynbz empty.htmlN)rrErrrr r!)r rrr test_inplace%s    zTestNbConvertApp.test_inplacec Cs|dg|dtjds(ttdd&}|}d|ksHtd|ksTtWdQRX|dtjdsxttdd&}|}d|kstd|kstWdQRXWdQRXdS) zM Verify that the html has no prompts when given --no-prompt. znotebook1.ipynbz3notebook1.ipynb --log-level 0 --no-prompt --to htmlznotebook1.htmlrz In [zOut[Nz'notebook1.ipynb --log-level 0 --to html)rrrrr r!r,r.)r r1r2text2rrrtest_no_prompt0s      zTestNbConvertApp.test_no_promptc Cs|dg|dtjds(ttdd2}|}d|ksHtd|ksTtd|ks`tWdQRX|d tjdsttdd2}|}d|kstd|kstd|kstWdQRXWdQRXdS) zJ Verify that the html has no input when given --no-input. znotebook1.ipynbz2notebook1.ipynb --log-level 0 --no-input --to htmlznotebook1.htmlrMz In [zOut[ax,y,z = symbols('x y z')Nz'notebook1.ipynb --log-level 0 --to html)rrrrr r!r,r.)r r1r2rNrrr test_no_inputBs"          zTestNbConvertApp.test_no_inputc Cs|dg|d\}}|d\}}|d\}}d|ksDtd|ksPtd|ks\td|kshtd|ksttd|ksttt|dWdQRXWdQRXdS) z Verify that conversion is aborted with '--execute' if an error is encountered, but that conversion continues if '--allow-errors' is used in addition. znotebook3*.ipynbz'--to markdown --stdout notebook3*.ipynbz6--to markdown --allow-errors --stdout notebook3*.ipynbz@--execute --allow-errors --to markdown --stdout notebook3*.ipynbZ23Z42z1--execute --to markdown --stdout notebook3*.ipynbN)rrr!pytestZraisesOSError)r output1_output2Zoutput3rrrtest_allow_errorshs       z"TestNbConvertApp.test_allow_errorsc CsR|dg<|jddd\}}d|ks,td|ks8td|ksDtWdQRXdS) zg Verify that the stderr output contains the traceback of the cell execution exception. znotebook3_with_errors.ipynbz<--execute --to markdown --stdout notebook3_with_errors.ipynbT)rz#print("Some text before the error")z4raise RuntimeError("This is a deliberate exception")z,RuntimeError: This is a deliberate exceptionN)rrr!)r rTZ error_outputrrrtest_errors_print_tracebacks    z,TestNbConvertApp.test_errors_print_tracebackc Cs|dg,|d\}}d|ks(td|ks4tWdQRX|dg,|d\}}d|ksftd|ksrtWdQRXdS) z Verify that input cells use fenced code blocks with the language name in nb.metadata.kernelspec.language, if that exists znotebook1*.ipynbz&--to markdown --stdout notebook1.ipynbz ```pythonz```Nznotebook_jl*.ipynbz(--to markdown --stdout notebook_jl.ipynbz```julia)rrr!)r rSrTrUrrr test_fenced_code_blocks_markdowns  z1TestNbConvertApp.test_fenced_code_blocks_markdownc Csh|dgRtd$}|}|jd|d\}}WdQRXd|ksNtd|ksZtWdQRXdS)zH Verify that conversion can be done via stdin to stdout znotebook1.ipynbz--to markdown --stdin --stdout)stdinNz ```pythonz```)rior,r.encoderr!)r r1notebookrSrTrrr!test_convert_from_stdin_to_stdouts    z2TestNbConvertApp.test_convert_from_stdin_to_stdoutc Cs|dg|td }|}|jd|dWdQRXtjdsNt td&}|}d|ksnt d|kszt WdQRXWdQRXdS)z? Verify that conversion can be done via stdin. znotebook1.ipynbz--to markdown --stdin)rYNz notebook.mdz ```pythonz```) rrZr,r.r[rrrr r!)r r1r\rSrrrtest_convert_from_stdins    z(TestNbConvertApp.test_convert_from_stdinc Cs8|ddg |dtjds*tWdQRXdS)zG Generate PDFs with an image linked in a markdown cell zlatex-linked-image.ipynbz testimage.pngz!--to pdf latex-linked-image.ipynbzlatex-linked-image.pdfN)rrrrr r!)r rrrtest_linked_imagess z#TestNbConvertApp.test_linked_imagesc Cs8|ddg |dtjds*tWdQRXdS)zf Verify that latex conversion succeeds with a notebook with an embedded .jpeg znotebook4_jpeg.ipynbzcontainerized_deployments.jpegz--to latex notebook4_jpeg.ipynbznotebook4_jpeg.texN)rrrrr r!)r rrrtest_embedded_jpegs  z#TestNbConvertApp.test_embedded_jpegc Cs`|dgJ|dtjds(ttd}|}d|ksHtWdQRXWdQRXdS)zs Check to see if markdown conversion embeds PNGs, even if an (unsupported) PDF is present. zmarkdown_display_priority.ipynbz=--log-level 0 --to markdown "markdown_display_priority.ipynb"zmarkdown_display_priority.mdzAmarkdown_display_priority_files/markdown_display_priority_0_1.pngN) rrrrr r!rZr,r.)r r1Zmarkdown_outputrrrtest_markdown_display_prioritys  z/TestNbConvertApp.test_markdown_display_priorityc Csdd}|ddgBt}tj|jd}|d|||sLt | WdQRX|ddg|d|d st WdQRX|ddg|d |d st WdQRXdS) zF Check if figure files are copied to configured path. cSstt|dkS)Nr)lenrlistdir)rrrr fig_existsszFTestNbConvertApp.test_write_figures_to_custom_path..fig_existsznotebook4_jpeg.ipynbzcontainerized_deployments.jpegfileszN--log-level 0 notebook4_jpeg.ipynb --to rst --NbConvertApp.output_files_dir={}NzR--log-level 0 notebook4_jpeg.ipynb --to rst --NbConvertApp.output_files_dir=outputrJz+--log-level 0 notebook4_jpeg.ipynb --to rstZnotebook4_jpeg_files) rr r+rrr%namerformatr!Zcleanup)r rdZ output_dirrrrr!test_write_figures_to_custom_paths(    z2TestNbConvertApp.test_write_figures_to_custom_pathN)*rrr__doc__rrr"r&r'r(r)r3r5rr7r8r9r<r=r>r@rArBrCrDrFrGrHrIrKrLrOrPrVrWrXr]r^r_r`rarhrrrrrsL                    &    r)rirrZbaserZpostprocessorsrZ tests.utilsrrrZnbconvert.exportersrZtraitlets.tests.utilsr Ztestpathr rQr rrrrrs