]c@s)dZddlmZddlZddlZddlZddlZddlmZm Z ddl m Z ddl m Z mZmZddlmZmZddlmZmZmZmZmZmZmZmZdd lmZd d lmZm Z dd l!m"Z"m#Z#m$Z$m%Z%m&Z&d d l'm(Z(d dl)m*Z*d dl+m,Z,defdYZ-iZ.e.j/ee.j/idd6dd6dd6dd6dd6dd6dd6d d!6iZ0e0j/ee0j/iiie1d"6d#6d$fd%6iie1d&6d#6d'fd(6iie1d)6d*6d+fd,6iid-d.6d*6d/fd06iie2d16d2d36d*6id4d56d66d7fd86iie2d16d2d36d*6id4d56d66ie1d"6d96d:fd;6iie1d<6e1d=6d>6d?fd@6iie1d=6e1dA6d>6dBfdC6d*e fdDYZ3e3j4Z5Z6dS(EsuNbConvert is a utility for conversion of .ipynb files. Command-line interface for the NbConvert conversion utility. i(tprint_functionN(tfilltdedent(tindent(t JupyterAppt base_aliasest base_flags(tcatch_config_errort Configurable(tUnicodetListtInstancetDottedObjectNametTypetBooltdefaulttobserve(t import_itemi(tget_export_namest get_exporter(t exporterst preprocessorstwriterstpostprocessorst __version__(t NbConvertBase(tConversionException(tunicode_stdin_streamt DottedOrNonecBseZdZdZdZRS(sjA string holding a valid dotted object name in Python, such as A.b3._c Also allows for None type. ucCs?|dk r7t|dkr7tt|j||S|SdS(Ni(tNonetlentsuperRtvalidate(tselftobjtvalue((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyR ,s(t__name__t __module__t__doc__t default_valueR (((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyR&ssNbConvertApp.export_formatttosTemplateExporter.template_filettemplatesNbConvertApp.writer_classtwriters NbConvertApp.postprocessor_classtpostsNbConvertApp.output_basetoutputsFilesWriter.build_directorys output-dirs SlidesExporter.reveal_url_prefixs reveal-prefixs!NotebookExporter.nbformat_versiontnbformattenabledtExecutePreprocessors%Execute the notebook prior to export.texecutet allow_errorssContinue notebook execution even if one of the cells throws an error and include the error message in the cell output (the default behaviour is to abort conversion). This flag is only relevant if '--execute' was specified, too.s allow-errorst from_stdint NbConvertAppsgread a single notebook file from stdin. Write the resulting notebook with default basename 'notebook.*'tstdint StdoutWritert writer_classs1Write notebook output to stdout instead of files.tstdouttuse_output_suffixtnotebookt export_formatttbuild_directoryt FilesWritersuRun nbconvert in place, overwriting the existing notebook (only relevant when converting to notebook format)tinplacetClearOutputPreprocessors\Clear output of current file and save in place, overwriting the existing notebook. s clear-outputtexclude_input_prompttexclude_output_prompttTemplateExporters9Exclude input and output prompts from converted document.s no-promptt exclude_inputs}Exclude input cells and output prompts from converted document. This mode is ideal for generating code-free reports.sno-inputcBseZdZeZdZeZeZ e ddZ e Z e ddZedZeddd jd eZeedd jd eZed dd jd eZedjdeZeddddeZedddjd eZidd6dd6dd6ZedeZ e!ddZ"eddddeZ#e$ddjd eZ%id d!6Z&ed9deZ(e!d"d#Z)ed$dd%jd eZ*ed&de+dd'jdejd eZ,e gdd(jd eZ-ee+dd)jd eZ.e/d9d*Z0d+Z1d,Z2d-Z3d.Z4d/Z5d0Z6d9d1Z7d2Z8d3Z9d9d4Z:d5Z;d6Z<d7Z=d8Z>RS(:sAApplication used to convert from notebook file type (``*.ipynb``)sjupyter-nbconvertt log_levelcCstjS(N(tloggingtINFO(R!((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyt_log_level_defaultstclassescCs~tg}xnttttfD]Z}xQt|D]C}t||}t|tr/t |t r/|j |q/q/WqW|S(N( RRRRRtdirtgetattrt isinstancettypet issubclassRtappend(R!RHtpkgtnametcls((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyt_classes_defaults uThis application is used to convert notebook files (*.ipynb) to various other formats. WARNING: THE COMMANDLINE INTERFACE MAY CHANGE IN FUTURE RELEASES.R;thelps{overwrite base name use for output files. can only be used when converting one notebook at a time. tconfigsWhether to apply a suffix prior to the extension (only relevant when converting to notebook format). The suffix is determined by the exporter, and is usually '.nbconvert'.s{notebook_name}_filessDirectory to copy extra files (figures) to. '{notebook_name}' in the string will be converted to notebook basename.u The simplest way to use nbconvert is > jupyter nbconvert mynotebook.ipynb which will convert mynotebook.ipynb to the default format (probably HTML). You can specify the export format with `--to`. Options include {formats}. > jupyter nbconvert --to latex mynotebook.ipynb Both HTML and LaTeX support multiple output templates. LaTeX includes 'base', 'article' and 'report'. HTML includes 'basic' and 'full'. You can specify the flavor of the format used. > jupyter nbconvert --to html --template basic mynotebook.ipynb You can also pipe the output to stdout, rather than a file > jupyter nbconvert mynotebook.ipynb --stdout PDF is generated via latex > jupyter nbconvert mynotebook.ipynb --to pdf You can get (and serve) a Reveal.js-powered slideshow > jupyter nbconvert myslides.ipynb --to slides --post serve Multiple notebooks can be given at the command line in a couple of different ways: > jupyter nbconvert notebook*.ipynb > jupyter nbconvert notebook1.ipynb notebook2.ipynb or you can specify the notebooks list in a config file, containing:: c.NbConvertApp.notebooks = ["my_notebook.ipynb"] > jupyter nbconvert --config mycfg.py tformatss!nbconvert.writers.base.WriterBases`Instance of the writer class used to write the results of the conversion.t allow_noneR=s]Writer class used to write the results of the conversions#nbconvert.writers.files.FilesWritert fileswriters#nbconvert.writers.debug.DebugWritert debugwriters%nbconvert.writers.stdout.StdoutWritert stdoutwriterR6cCsH|d}|j|jkr5|j|j}nt||_dS(Ntnew(tlowertwriter_aliasesRtwriter_factory(R!tchangeRZ((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyt_writer_class_changeds s/nbconvert.postprocessors.base.PostProcessorBasesfInstance of the PostProcessor class used to write the results of the conversion.scPostProcessor class used to write the results of the conversions1nbconvert.postprocessors.serve.ServePostProcessortservetpostprocessor_classcCsQ|d}|j|jkr5|j|j}n|rMt||_ndS(NRZ(R[tpostprocessor_aliasesRtpostprocessor_factory(R!R^RZ((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyt_postprocessor_class_changeds  shttps://unpkg.com/sURL base for ipywidgets packagethtmlsThe export format to be used, either one of the built-in formats {formats} or a dotted object name that represents the import path for an `Exporter` classsList of notebooks to convert. Wildcards are supported. Filenames passed positionally will be added to the list. s"read a single notebook from stdin.cCsB|jtt|j||j|j|jdS(s<Initialize application, notebooks, writer, and postprocessorN(t init_syspathRR3t initializetinit_notebookst init_writertinit_postprocessor(R!targv((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRgs    cCstjjdtjdS(s)Add the cwd to the sys.path ($PYTHONPATH)iN(tsystpathtinserttostgetcwd(R!((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRf!scCs|jr|j}n |j}g}x|D]x}tj|}|jtj|d|sv|jjd|nx*|D]"}||kr}|j|q}q}Wq+W||_dS(sConstruct the list of notebooks. If notebooks are passed on the command-line, they override (rather than add) notebooks specified in config files. Glob each notebook to replace notebook patterns with filenames. s.ipynbspattern %r matched no filesN(t extra_argst notebookstglobtextendtlogtwarningRN(R!tpatternst filenamestpatternt globbed_filestfilename((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRh%s      cCs`|ji|jd6|jd||_t|jdr\|jjdkr\t|_ndS(s*Initialize the writer (which is stateless)RZtparentR<R;N(R_R6R]R*thasattrR<tFalseR8(R!((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRiDs$cCs<|ji|jd6|jr8|jd||_ndS(s1Initialize the postprocessor (which is stateless)RZR|N(RdRaRct postprocessor(R!((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRjKs cCs!tt|j|jdS(s4Run start after initialization process has completedN(RR3tstarttconvert_notebooks(R!((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRQscCstjj|}||jd }|jrt|jdtrtjj|j\}}||jj kr||_qn|j}n|j j d|i}|j |d<||d<|j jd|}||d<|j|d<|S( sStep 1: Initialize resources This initializes the resources dictionary for a single notebook. Returns ------- dict resources dictionary for a single notebook that MUST include the following keys: - config_dir: the location of the Jupyter config directory - unique_key: the notebook name - output_files_dir: a directory where output files (not including the notebook itself) should be saved t.tfile_extensionsNotebook name is '%s't config_dirt unique_keyt notebook_nametoutput_files_dirtipywidgets_base_url(RoRmtbasenametrfindt output_baseRJtexporterR~tsplitextRRutdebugRRtformatR(R!tnotebook_filenameRRtbasetextt resourcesR((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytinit_single_notebook_resourcesVs"        cCsyO|dk r0|jj|d|\}}n|jj|d|\}}Wn7tk r|jjd|dt|jdnX||fS(sUStep 2: Export the notebook Exports the notebook to a particular format according to the specified exporter. This function returns the output and (possibly modified) resources from the exporter. Parameters ---------- notebook_filename : str name of notebook file. resources : dict input_buffer : readable file-like object returning unicode. if not None, notebook_filename is ignored Returns ------- output dict resources (possibly modified) RsError while converting '%s'texc_infoiN( RRt from_filet from_filenameRRuterrortTruetexit(R!RRt input_bufferR,((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytexport_single_notebooks !" cCspd|krtdn|d}|jrQ|j rQ||jdd7}n|jj||d|}|S(sStep 3: Write the notebook to file This writes output from the exporter to file using the specified writer. It returns the results from the writer. Parameters ---------- output : resources : dict resources for a single notebook including name, config directory and directory to save output Returns ------- file results from the specified writer output of exporter Rs<unique_key MUST be specified in the resources, but it is nott output_suffixR;R(tKeyErrorR8RtgetR*twrite(R!R,RRt write_results((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytwrite_single_notebooks   cCs,t|dr(|jr(|j|ndS(sStep 4: Post-process the written file Only used if a postprocessor has been specified. After the converted notebook is written to a file in Step 3, this post-processes the notebook. RN(R}R(R!R((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytpostprocess_single_notebookscCs|dkr(|jjd||jn|jjd|j|j|}|j||d|\}}|j||}|j|dS(s%Convert a single notebook. Performs the following steps: 1. Initialize notebook resources 2. Export the notebook to a particular format 3. Write the exported notebook to file 4. (Maybe) postprocess the written file Parameters ---------- notebook_filename : str input_buffer : If input_buffer is not None, conversion is done and the buffer is used as source into a file basenamed by the notebook_filename argument. sConverting notebook %s to %ssConverting notebook into %sRN(RRutinfoR:RRRR(R!RRRR,R((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytconvert_single_notebooks cCs|jdkrDt|jdkrD|jjd|jdnt|j}|d|j|_ t|jdkr|j r|j t jdn|j sx=|jD]}|j |qWnt}|j dd|d S( s4Convert the notebooks in the self.notebook traitlet R;is UsageError: --output flag or `NbConvertApp.output_base` config option cannot be used when converting multiple notebooks. RTiisnotebook.ipynbRN(RRRrRuRRRR:RTRR2t print_helpRlRR(R!RQRR((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyRs$    cCsd}xz|jjD]i\}\}}|dj|7}|tt|dd7}|ttdt|dd7}qW|S(sK Return a string containing descriptions of all the flags. s"The following flags are defined: s{} iPs s Long Form: (tflagstitemsRRRtstr(R!Rtflagtcfgtfhelp((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytdocument_flag_helps "+cCs@d}x3|jjD]"\}}|dj||7}qW|S(s-Return a string containing all of the aliasess#The folowing aliases are defined: s **{}** ({}) (taliasesRR(R!Rtaliastlongname((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytdocument_alias_helpscsfddddddgD}d|jD}gjD]}||krH|^qH|ds tappRR*t preprocessorRcSs#h|]}|D] }|qqS(((RRR((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pys s totherst {section} Options ----------------------- R;tsections,.. image:: _static/{image}_inheritance.png timages css|]}|jVqdS(N(tclass_config_rst_doc(RR((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pys ,ss : s \: (RRR*(tvaluesRRRttitletjointreplace(R!t categoriest accounted_forRtheadertsectionsR((R!s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pytdocument_config_optionss /   %N(?R$R%R&RtversionRPtnbconvert_aliasesRtnbconvert_flagsRRRGR RHRRR t descriptionttagRRRR8RRRtexamplesR R*R R6R\R R]RR_RRRaRbRRcRdRR~R:RrR2RRgRfRhRiRjRRRRRRRRRR(((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyR3s         )                   ) "    (7R&t __future__RRERlRoRsttextwrapRRtipython_genutils.textRtjupyter_core.applicationRRRttraitlets.configRRt traitletsR R R R R RRRttraitlets.utils.importstringRtexporters.baseRRt nbconvertRRRRRt utils.baseRtutils.exceptionsRtutils.ioRRRtupdateRRR~R3tlaunch_instancetmaintlaunch_new_instance(((s5lib/python2.7/site-packages/nbconvert/nbconvertapp.pyts    :(