jQldZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z mZmZmZmZmZddlmZddlmZddlmZmZmZmZmZmZmZmZdd l m!Z!dd l"m#Z#dd l$m%Z%d d l&m'Z'dgZ(ej)*e+Z,ej)-ej).e,dZ/ide%j0de%j1de%j2de%j3de%j4de%j5de%j6de%j7de%j8de%j9de%j:de%j;de%j<de%j=de%j>de%j?d e%j@id!e%jAd"e%jBd#e%jCd$e%jDd%e%jEd&e%jFd'e%jGd(e%jHd)e%jId*e%jJd+e%jKd,ejLd-d.d/d0d1d2d3e%jMd4e%jNd5e%jOiZPd6ZQd7ZRGd8d9e ZSGd:d;e'ZTdS)rBIsT[Q00escape_html_keep_quotescHtjt|dS)NF)quoter;r?s rArBrBJsSVV5)I)I)IrCescape_html_scriptc.|ddS)N/z\/)replacer?s rArBrBKsAIIc5$9$9rC clean_htmlstrip_trailing_newline text_base64c|D]c\}}t|tr+||vri||<t|||||s||=E|||d^|||<d|S)z]Recursively update one dictionary using another. None values will delete their keys. N)items isinstancedictrecursive_updatepop)targetnewkvs rArRrRTs  1 a   q VAY * * *!9 1I Y JJq$    F1II MrCc>tj|tddS)zEmit a deprecation warning. stacklevelN)warningswarnDeprecationWarning)msgs rA deprecatedr`js  M#)a888888rCc$eZdZdZdZdZdZdS)ExtensionTolerantLoaderaNA template loader which optionally adds a given extension when searching. Constructor takes two arguments: *loader* is another Jinja loader instance to wrap. *extension* is the extension, which will be added to the template name if finding the template without it fails. This should include the dot, e.g. '.tpl'. c"||_||_dS)zInitialize the loader.N)loader extension)selfrdres rA__init__z ExtensionTolerantLoader.__init__xs "rCc |j||S#t$rP||jrt|d|j|||jzcYSwxYw)zGet the source for a template.N)rd get_sourcer endswithre)rf environmenttemplates rAriz"ExtensionTolerantLoader.get_source}s R;))+x@@ @ R R R  00 ;&x00d:;))+x$.7PQQ Q Q Q RsAA76A7c4|jS)zList available templates.)rdlist_templatesrfs rArnz&ExtensionTolerantLoader.list_templatess{))+++rCN)__name__ __module__ __qualname____doc__rgrirnrCrArbrbosN### RRR,,,,,rCrbc eZdZUdZerGeddeezndZdZ dTdZ e dZ dZ dTdZe d Ze fd Zed d d Zedd dd d Zedd d Zedd d ZdZdZeddZeddZeddZeddZ e!dgd d Z"e!ed d Z#e!ed d Z$ed d!Z%ed d Z&e!e'd"d#d$ d Z(ed%d&Z)edd' d (Z*edd) d (Z+edd* d (Z,edd+ d (Z-ed d, d (Z.edd- d (Z/edd. d (Z0edd/ d (Z1edd0 d (Z2e!d1 d Z3d2e4d3<e5d4 d d Z6e!ed5 d (Z7ed6d7Z8dTfd8 Z9d9Z: dTdUfdB Z; dTdVfdD Z< dTdWfdG Z=dHZ>dIZ?dJZdKZ@fdLZAdMZBedNdXdOZCeDdPZEdQZFdRZGfdSZHxZIS)YTemplateExportera Exports notebooks into other file formats. Uses Jinja 2 templating engine to output new formats. Inherit from this class if you are creating a new template type along with new filters/preprocessors. If the filters/ preprocessors provided by default suffice, there is no need to inherit from this class. Instead, override the template_file and file_extension traits via a config file. Filters available by default for templates: {filters} z- z - rNcd|_dSr:)_template_cachedrfchanges rA_invalidate_template_cachez+TemplateExporter._invalidate_template_caches $rCcP|j||_|jSr:)rx_load_templateros rArlzTemplateExporter.templates(  ($($7$7$9$9D !$$rCc<d|_|dSr:)_environment_cachedr{rys rA_invalidate_environment_cachez.TemplateExporter._invalidate_environment_caches"#'  '')))))rCcP|j||_|jSr:)r_create_environmentros rArkzTemplateExporter.environments(  # +'+'?'?'A'AD $''rCctddiddid}tjr template_namec|d}|r|drtjd|jdtdt j|j\}|_|r"t j|\}}|r't j |r|g|_ |S)Nvalue.tplz 5.x style template name passed ''. Use --template-name for the template directory with a index..j2 file and/or --template-file to denote a different template.rYrZ) rjr\r]rr^ospathsplit template_fileisabsextra_template_basedirs)rfrzr directorys rA_template_name_validatez(TemplateExporter._template_name_validatesw  ;]33F;; ; MK43EKKK"     -/GMM$:L,M,M )It) D+-7==+C+C( = ;RW]]955 ;09{,rCrc|d}|dkr|j|_dStj|}tj|rytj|\}|_|g|j|_|jr>|jdr&tj d|dtddSdSdSdS)NrUrrz 5.x style template file passed 'rrYrZ) default_templaterrrabspathisfilerextra_template_pathsrjr\r]r^)rfrzrU full_pathrs rA_template_file_changedz'TemplateExporter._template_file_changedsUm )  !%!6D  FGOOC(( 7>>) $ $ ,.GMM),D,D )It))2(OT5N(OD %! d&8&A&A&&I&I  @s@@@&       rCc(|jr d|jzSdS)Nindex)template_extensionros rA_template_file_defaultz'TemplateExporter._template_file_defaults  " 5T44 4trC raw_templatecV|ds |j|_|dS)NrU)_last_template_filerr{rys rA_raw_template_changedz&TemplateExporter._raw_template_changeds1e} :!%!9D  '')))))rC.)rrrc*tjgSr:)rgetcwdros rA _default_extra_template_basedirsz1TemplateExporter._default_extra_template_basedirs s }rC nbconvert templatesz*Path where templates can be installed too.rc2|jr |jdzS|jS)Nz.j2)file_extensionros rA_template_extension_defaultz,TemplateExporter._template_extension_defaults$   /&. .""rCzNThis allows you to exclude code cell inputs from all templates if set to True.)rzKThis allows you to exclude input prompts from all templates if set to True.zOThis allows you to exclude code cell outputs from all templates if set to True.zLThis allows you to exclude output prompts from all templates if set to True.zSThis allows you to exclude output of stdin stream from lab template if set to True.zHThis allows you to exclude code cells from all templates if set to True.zLThis allows you to exclude markdown cells from all templates if set to True.zGThis allows you to exclude raw cells from all templates if set to True.zKThis allows you to exclude unknown cells from all templates if set to True.z[Jinja loaders to find templates. Will be tried in order before the default FileSystem ones.z List[t.Any] extra_loaderszVDictionary of filters, by name and namespace, to add to the Jinja environment.z>formats of raw cells to be included in this Exporter's output. raw_mimetypesc|jdgS)Nr)output_mimetyperos rA_raw_mimetypes_defaultz'TemplateExporter._raw_mimetypes_defaultOs$b))rCc .tjdd|i|||jt |d||jt |ddS)a Public constructor Parameters ---------- config : config User configuration instance. extra_loaders : list[of Jinja Loaders] ordered list of Jinja loader to find templates. Will be tried in order before the default FileSystem ones. template_file : str (optional, kw arg) Template to use when exporting. rTr)rNrt)rrgrrlisttraitsr{)rfrkwrs rArgzTemplateExporter.__init__Ts ---"---  .T[[UY[5Z5Z0[0[    T4d4;;X\;;];]6^6^_____rCc|5|jr|j|jkr |j|_|jr |j|_dddn #1swxYwY|jsd}t ||j}|jd||jdtj |j |j |S)zLoad the Jinja template object from the template file This is triggered by various trait changes that would change the template. NzNo template_file specified!zAttempting to load template %sz template_paths: %s)hold_trait_notificationsr_raw_template_keyrr ValueErrorlogdebugrpathsepjointemplate_pathsrk get_template)rfr_rs rAr}zTemplateExporter._load_templateis% * * , , < <! >t'9T=S'S'S+/+=(  <%)%;"  < < < < < < < < < < < < < < < ! "/CS// ! *  7GGG /AT1U1UVVV,,];;;s7AAAfilenamer> resourcesdict[str, t.Any] | Nonert.Anyreturntuple[str, dict[str, t.Any]]c :tj||fi|S)z#Convert a notebook from a filename.)r from_filename)rfrrrrs rArzTemplateExporter.from_filenames&%uww$Xy??B???rC file_streamc :tj||fi|S)zConvert a notebook from a file.)r from_file)rfrrrrs rArzTemplateExporter.from_files&!uww i>>2>>>rCnbr c tj||fi|\}}|d|j|d|j|j |j |j |j |j |j |j |j |j |j o|j d |d<|j||}|d}||fS)a5 Convert a notebook from a notebook node instance. Parameters ---------- nb : :class:`~nbformat.NotebookNode` Notebook node resources : dict Additional resources that can be accessed read/write by preprocessors and filters. rr) include_codeinclude_markdown include_rawinclude_unknown include_inputinclude_outputinclude_output_stdininclude_input_promptinclude_output_prompt no_promptglobal_content_filter)rrz )rfrom_notebook_node setdefaultrrexclude_code_cellexclude_markdown exclude_rawexclude_unknown exclude_inputexclude_outputexclude_output_stdinexclude_input_promptexclude_output_promptrlrenderlstrip)rfrrrnb_copyoutputrs rArz#TemplateExporter.from_notebook_nodes8UWW7ILLLL_d.@AAA.0DEEE $ 66$($9 9#//#'#77!%!33"&"55(,(A$A(,(A$A)-)C%C2Qt7Q . . )*%%I%FFv&&y  rCc|d}t|t|t}| }|rr_register_filtercallabler issubclassr) rfenvironname jinja_filterr_isclass constructed filter_clsfilter_instances rArz!TemplateExporter._register_filters-  CC.. \400!k   D:lSF;; D%\22J(($ CC C  8L11 $0GOD !   z, :: +l$777O  ! !'4 A A A4  *lnnO  ! !'4 A A A4nnrCc:||j||S)r)rrk)rfrrs rAregister_filterz TemplateExporter.register_filters$$T%5t\JJJrCc4tS)a|Override in subclasses to provide extra filters. This should return an iterable of 2-tuples: (name, class-or-function). You should call the method on the parent class and include the filters it provides. If a name is repeated, the last filter provided wins. Filters from user-supplied config win over filters provided by classes. )default_filtersrOros rArz TemplateExporter.default_filterss$$&&&rCcR|j}|jdd|g|jt t ||jt|j |j i}tt|t|j}tj|jd<|D]\}}|||||jr6|jD]\}}|||||S)z: Create the Jinja templating environment. zTemplate paths: %s )rd extensions enable_asyncuuid4)rrrrrrbr rrrrrrJINJA_EXTENSIONSr uuidr globalsrrrrO)rfpathsloadersrkkeyr user_filters rArz$TemplateExporter._create_environmentsE# . E0B0BCCC   #$4U$;$;T=T U U  .0AB C C  "(('*   (,z G$..00 ; ;JC  ! !+sE : : : : < E$(L$6$6$8$8 E E [%%k3 DDDDrCct|}|di}t |dD]\}}||}|d}t|}|j |j vr%| |j |j |di|}| |dS)N preprocessorsc|dS)Nrrt)xs rArBz6TemplateExporter._init_preprocessors.."s 1Q4rC)rrrt) r_init_preprocessors _get_confgetsortedrOrrSrrprupdateregister_preprocessor)rfconfr_ preprocessorkwargspreprocessor_clsrs rArz$TemplateExporter._init_preprocessorss ##%%%~~"55 &m&9&9&;&;PPP 9 9OA|'%**,,#)::f#5#5 #./?#@#@ #, ;;MM$+.>.G"HIII//99&99 **<888 9 9rCc8i}tt|jD]|}|dz } |}|rN|5}t |t j|}dddn #1swxYwYm#t$rYywxYw|S)N conf.json) maprrexistsopenrRjsonloadPermissionError)rfrr conf_pathconf_path_existsfs rArzTemplateExporter._get_conf,s!#d122 D DD{*I D#,#3#3#5#5 $D"))DQ/dillCCDDDDDDDDDDDDDDD #     s#B #A>>B B BBrc g}|}|}|D]}|jD]i}tj||} |rtj|r||Z#t$rYfwxYw|D]}tj|dd}tj||} |rtj|r||{#t$rYwxYw|D]}||tj|dd}||tj|ddd} || g} |j D]8}|rtj|r| |9||j z| zS)Nrr compatibility) get_prefix_root_dirsget_template_namesrrrrr&appendr*template_data_pathsr) rfprune root_dirsrtemplate_namesrbase_dirrroot_dircompatibility_diradditional_pathss rA_template_pathsz TemplateExporter._template_paths;s(--// 0022+  M 8  w||Hm<< +BGNN4$8$8+ T***&D%  7<<+{KKw||Hm<< +BGNN4$8$8+ T***&D  " , ,H LL " " "w||Hk;GGH LL " " " " X{KQ` a a  LL* + + + +, . .D .BGNN400 . ''---t003CCCs$6B BB'6D D+*D+c4|dkrddiS|dkrdddidSd S) zGet the base template config.display_priority base_templatebasefullclassicz text/htmlT)r> mimetypesNrt)clsrs rA$get_compatibility_base_template_confz5TemplateExporter.get_compatibility_base_template_confds< % % %#V, , 6>>%.k4=PQQ QtrCcJg}|}|j}i}|||i}d}|jD]}tj||}tj|rd}tj|d} tj| rIt| 5} ttj | |}dddn #1swxYwY|D]} tj| dd|}tj|rd}tj|d} tj| rIt| 5} ttj | |}dddn #1swxYwY|s|D]} |dz} tj| ddd| } tj| rwd}tj d |jd td | |_||}t#jt&|d |_n|s,d|}d|d|}t+|tt-||}t#jt"j|d }||}d|diD}|jrD|j|vr;|r9d|}d|jd|jd|}t+||S)zWFinds a list of template names where each successive template name is the base templateNFTr$rrrr/z5.x template name passed 'z1'. Use 'lab' or 'classic' for new template usage.rYrZr>r z$No template sub-directory with name z found in the following paths: cg|] \}}|| Srtrt).0mimetypers rA z7TemplateExporter.get_template_names..s#ddd"3(G\cdXdddrCrBzUnsupported mimetype z for template z, mimetypes supported are: )r0rr2rrrrr&r'rRr(r)r\r]r^rrDtcastr>rrrQAnyrOr)rfr6r5r> merged_confrfound_at_least_oner7 template_dir conf_filer-r8compatibility_filecompatibility_pathrr_rBsupported_mimetypess rAr1z#TemplateExporter.get_template_namesnsC--// $($6 (* '  ! !- 0 0 0%'D!&  8 D D!w||HmDD 7>>,//.)-&GLL{CC 7>>),,DiDA/ ! dCCDDDDDDDDDDDDDDD% D D!w||Hk;P]^^ 7>>,//.)-&GLL{CC 7>>),,DiDA/ ! dCCDDDDDDDDDDDDDDD% * )H)6)?&)+ +{OM_**&w~~&899 -1* ~9K~~~.'( .@*#HHWW-.VC/9R9R-S-S* **"KK 22E{{{ty{{C$S//)*4::{CCKF15$((?*C*CDDMW'Xddtxx R7P7P7V7V7X7Xddd   "D$8 $I$Ii$I"(++i"8"8 [$*>[[PTPb[[FY[[CS// !s$#DD D $#GG G c  g}trX|tjtjt dddd|t|S)zGet the prefix root dirs.z..sharejupyter) DEV_MODEr2rrrrROOTextendr )rfr5s rAr0z%TemplateExporter.get_prefix_root_dirssi  b   RW__RW\\$dGU^-_-_`` a a a(((rCc^t|}t|d<|S)Nr`)r_init_resourcesr`)rfrrs rAr[z TemplateExporter._init_resourcess*GG++I66 ", ,rCr:)rr>rrrrrr)rrrrrrrr)rr rrrrrr)TN)Jrprqrrrsformatrrrkeysrxr{propertyrlrrrkrrtagrrrr r rrrrrrrrrrrrrrrr r3rrrrrrrrrrr__annotations__rrrrrgr}rrrrrrrrr; classmethodrDr1r0r[ __classcell__)rs@rArvrvs    tjooff_=Q=Q=S=S6T6T&U&UUVVV  %%%%%%X% ****((X(     X G!>???CCdDMGDT8Z[[[__d`M72$9:::>>SW>XXL4$KLLLPP QL" Xo    W_& W_  W^*** T3%[[__Dd_KKN"d7799oo11SW1XX4 ??..dPT.UU W &''('!dMM$ [+..5a cdc## W !""###"# D d cc 4 a ccT ^ cc !D b cc 4 b cc  ^ cct b cc$ ] ccd a cc"&.""" cdc##$$$$ d c4c00 D \ cc W_***``````*<<<4CG@@@@@@@HL???????FJ!!!!!!!!!!!!!!F...` K K K ' ' '>99999$    W &D&D&D&DP[888trCrv)Urs __future__rr<r(rtypingrJrr\pathlibrjinja2rrrrr r jupyter_core.pathsr nbformatr traitletsr rrrrrrrtraitlets.configrtraitlets.utils.importstringrrrexporterrr rdirname__file__rXr&rrWrrrrDataTypeFilterr Highlight2HTMLHighlight2Latexr#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6dumpsrKrLrMrrRr`rbrvrtrCrArssZ #"""""  ,+++++!!!!!!VVVVVVVVVVVVVVVVVVVV######444444.. wx   7>>"',,t\:: ; ;& gn&W*&2&" & . & " &g,&w.&g,&'$&g,&G(&W*&'$&W*& '4!&""#&&$'$%&&'$'&(")&*G(+&,g,-&. /&07&1&2'$3&4765&6G(7&8g,9&:$*;&>00?&@IIA&B99C&F'$G&Hg