Fe"q .dZddlmZddlZddlZddlZddlZddlmZddlm Z m Z m Z ddl m Z ddlmZmZmZddlmZdd lmZdd lmZdd lmZmZdd lmZdd lmZddlm Z ddl!m"Z"ddl#m$Z$m%Z%m&Z&e rddl'm(Z(m)Z) ddl*m+Z+ejZe.Z/dZ0dZ1dZ2dZ3dZ4dZ5dddZ6ddddd d!d"d"d#d$d%d& Z7d'Z8ejrd(Z:Gd)d*e Z;Gd+d,e Z<Gd-d.e Z=Gd/d0e Z>d4d5d1Z?e?Z@Gd2d3eZAy#e,$rdZ+YwxYw)6z#Base class of epub2/epub3 builders.) annotationsN)path) TYPE_CHECKINGAny NamedTuple)quote) ZIP_DEFLATED ZIP_STOREDZipFile)nodes) smartquotes)addnodes) BuildInfoStandaloneHTMLBuilder)__)logging)status_iterator)copy_asset_file)copyfile ensuredirrelpath)ElementNode)Imagezepub-cover.xhtmlz toctree-l%dz [%(uri)s]z#%d Footnotesz link-targetzTable of ContentsCover)toccoverzapplication/xhtml+xmlztext/css image/pngz image/webp image/gif image/svg+xml image/jpegzfont/otfzfont/ttfz font/woff) .xhtmlz.cssz.pngz.webpz.gif.svgz.jpgz.jpegz.otfz.ttfz.woff)r$z ([^#:]*#)(.*)c,eZdZUded<ded<ded<y) ManifestItemstrhrefid media_typeN__name__ __module__ __qualname____annotations__r>dsMN I Kr1r>c|jdd}tj|}tj||}|jdd}|S)Nz"")replacer educateDashesOldSchool educateQuotes)tlanguages r2sphinx_smarty_pantsrMlsI (C A**1-A!!!X.A #x A Hr1cneZdZdZdZgdZdZdZdZdZ dZ dZ dZ e ZeZeZeZeZeZeZdZdZd!fd Zd"dZd#dZd$d Z d%d Z!d&d Z"d!d Z#d'd Z$d(dZ%d)dZ&d*d+dZ'd,fd Z(d-dZ)d.dZ*d!dZ+d!fd Z,d!dZ- d/ d0fd Z.d!dZ/d1d2dZ0d3dZ1d!dZ2d4d5dZ3d6dZ4d7dZ5d!dZ6d!d Z7xZ8S)8 EpubBuilderz Builder that outputs epub files. It creates the metainfo files container.opf, toc.ncx, mimetype, and META-INF/container.xml. Afterwards, all necessary files are zipped to an epub file. F)r!rr r"Tct|d|_d|_d|_d|_i|_|jdd|_g|_ y)Nr#r use_indexepub) superinit out_suffix link_suffixrAtocidid_cacheget_builder_configrRrefnodesself __class__s r2rUzEpubBuilder.initsK  "# (* 00fE.0 r1cHt|j|jddgS)NhtmlrS)rconfigtagsr]s r2create_build_infozEpubBuilder.create_build_infosdii&&1ABBr1cZ|jj|jjfSN)ra epub_themeepub_theme_optionsrcs r2get_theme_configzEpubBuilder.get_theme_configs!{{%%t{{'E'EEEr1c|jj|}|s-d|jjdz}||j|<|S)zReturn a unique id for name.zepub-%drS)rYgetenv new_serialno)r]namer)s r2make_idzEpubBuilder.make_idsG]]  t $TXX226::B"$DMM$  r1c t|tjr|jdr|d}|j dr|S|j j d}tdddD]h}|j|z|vs|j|tj|ttj|jd|S|St|tjr|D]}|j||}|S)z>Collect section titles, their depth in the toc and the refuri.rC)zhttp://zhttps://zirc:zmailto:classesrlevelrCrB) isinstancer referencerk startswithparent attributesrangetoctree_templateappendr`escapesspastextr get_refnodes)r]doctreeresultrCrqruelems r2rzEpubBuilder.get_refnodess gu /GKK4IX&F  !KL nn// :Gq!R ))E1g=MM!&"&++f"5 #DKK0@$A B#     / 9**48 9 r1ct}|D]C}|d|vr&tjtd|ddd0|j |dEy)NrCzduplicated ToC entry found: %srSduplicated_toc_entryr:subtype)setloggerwarningradd)r]r appearednodes r2check_refnodeszEpubBuilder.check_refnodess] U -DH~)78N2  T(^, -r1cf|jj|jj|dd}|j |g|_t j|jj}|r!|dz }|j D] }||dz|d<|j|j y)zwGet the total table of contents, containing the root_doc and pre and post files not managed by sphinx. FTprune_toctrees includehidden/rCN) rlget_and_resolve_doctreeraroot_docrr[rdirname toc_add_files)r]r master_diritems r2get_toczEpubBuilder.get_tocs((224;;3G3G37AE3G))'26 \\$++"6"67  # J  =!+d8n!<X = 4==)r1c |jddtj|jj|j zt tj|jj|jjjdt|jjD]J\}}|jddtj|t tj|dL|jjD]I\}}|jdtj|t tj|dKy)zDAdd the root_doc, pre and post files to a list of refnodes. rrtN)insertr`r~rarrVrrltitlesrreversedepub_pre_filesepub_post_filesr})r]r[filerBs r2rzEpubBuilder.toc_add_filess kk$++"6"6"HI  4 45<<>@A  #4;;#=#=> JD$ OOA++d+DKK-.    ++55 JD$ OO++d+DKK-.  r1c,||jddzS)z;Return a href/id attribute with colons replaced by hyphens.:-)rH)r]prefixfragments r2 fix_fragmentzEpubBuilder.fix_fragments((c222r1c\d fd }|jtjD]v}d|vrSjj |d}|r3j |j d|j d|d<d|vs_j d|d|d<x|jtjD]?}|||jd}t|tjs8||A|jtjD] }|| y ) zReplace colons with hyphens in href and id attributes. Some readers crash because they interpret the part as a transport protocol specification. cxg}|dD]*}jd|}||vs|j|,||d<y)zUpdate IDs of given *node*.idsrPN)rr})rnew_idsnode_idnew_idr]s r2update_node_idz+EpubBuilder.fix_ids..update_node_idsL!#G; +**2w7(NN6* +"DKr1rCrrefidrPT)ascendN)rrreturnNone) findallr rw refuri_rematchrgrouptarget next_nodervrrdesc_signature)r]treerrwmrrrs` r2fix_idszEpubBuilder.fix_idss  "eoo6 OI9$NN((8)<=*.*;*;AGGAJPQ *SIh')#%)%6%6r9W;M%N '"  Oll5<<0 *F 6 "$..d.;I)U]]3y)  *#ll8+B+BC +N > * +r1cjdd}dd}dd}|dk(ry|dk(r5t|jtj}||\}}d} t |jtj D];} | j d d } | jd s(| | jvs;| jj| dz} |d k(rb|jd| iz} tj| | } | d j|j| jj| | |dk(st  z}| dz } ||}| jj| ||||| }j||dd|d<|j#|dd|dz }>y)z+Add visible link targets for external linksctjd}|jtj||j ||S)z.Create a footnote_reference node with childrenz[#]_)r footnote_referencer}Textnote_autofootnote_ref)doclabel footnote_refs r2make_footnote_refz8EpubBuilder.add_visible_links..make_footnote_ref,s= 33F;L    5 1 2  % %l 3 r1r<c0tj|}tj}|jtj||j||j dtj d||j||S)z$Create a footnote node with childrenrrP)r footnote paragraphr}rrrnote_autofootnote)rrr<rparas r2 make_footnotez4EpubBuilder.add_visible_links..make_footnote3sh~~c*H??$D KK 3 ( OOD ! OOAu{{2u5 6  ! !( +Or1ct|jtj}|r/|d}|j|jj |dzfS|jtj D]T}t|dk(s|jtk(s*|j|jj |dzfcSt|jtj}tj }|jtjt|j|||j |dzfS)zfFind or create a spot to place footnotes. The function returns the tuple (parent, index).rsr)listrr rryindexrubriclenrFOOTNOTES_RUBRIC_NAMEnextdocumentr}r)rfnsfnrrrubs r2 footnote_spotz4EpubBuilder.add_visible_links..footnote_spot=st||ENN34CWyy"))//""5"999 U\\2 Dt9>dkkm7L&L;; (9(9$(?!(CCC Dt||ENN34C,,.C JJuzz"78 9 JJsO #** *r1noNrrrCrP)zhttp:zhttps:zftp:inlinerqrrr)rnodes.documentrr'rznodes.footnote_reference)rrrr'r<r'rznodes.footnote)rrrztuple[Element, int])rrr rrrwrkrxrryrlink_target_templaterr}css_link_target_classrFOOTNOTE_LABEL_TEMPLATE add_backref)r]r show_urlsrrrrfn_spotfn_idxnrrr<idxlinkrrrs r2add_visible_linkszEpubBuilder.add_visible_links)s   +*     "t||ENN34C+D1OGVBeoo67 D((8R(C~~9:s$++-?Wkk''-1(33uclBC <<S1DO**4+E+EFKK&&sD1*,3b8E!GB#4S%#@LKK&&sL9,S%=HNN684,4UOA,>L)((e) [3 3UHd+4U+;O'Q,,T2A$*$($5$5aggaj!''!*$M$OaO 5=[0M=/8/G[+NVT NN00606040A0A!''!*aggVWj0Y0[M!,[[ [ [r1cBtj|d}|tvS)z=Does the filename extension indicate a vector graphic format?rs)rsplitextVECTOR_GRAPHICS_EXTENSIONS)r]filenameexts r2is_vector_graphicszEpubBuilder.is_vector_graphicss!mmH%b)000r1c ttj|j|jt |j tddt|j |jjD]+}|j |} tjtj|j|}|j&j(r|j*dvr|j-}|j&j.dkDr]|j0\}}|j&j.}||kDr3t3||z|z }|j5||ftj6} |j9tj|j|j|.y#t$r|j|s=t j#tdtj|j| t%tj|j|tj|j|j|nT#t$rH}t j#tdtj|j||Yd}~nd}~wwxYwY3wxYw#t$rI}t j#tdtj|j||Yd}~d}~wwxYw) zCopy images using Pillow, the Python Imaging Library. The method tries to read and write the files with Pillow, converting the format and resizing the image if necessary/possible. zcopying images... brownz-cannot read image file %r: copying it insteadzcannot copy image file %r: %sN)Przcannot write image file %r: %s)rrjoinoutdirimagedirrimagesrrapp verbosityropensrcdirOSErrorrrrrraepub_fix_imagesmodeconvertepub_max_image_widthsizeroundresizeBICUBICsave) r]srcdestimgerrwidthheightnwnhs r2copy_image_files_pilz EpubBuilder.copy_image_files_pilsC $))DKK78"4;;3G0H'#&t{{#3TXX5G5GI AC;;s#D jj4;;!<={{**88v%++-C{{//!3"%(([[552: u45B**b"Xu}}=C A4;; tDE9 A  ..s3NN2&U#V#'99T[[##>@ETYYt{{C8!YYt{{DMM4HJENN2&E#F#'99T[[##>EEE 0 Ar"BC#yyc:CAA AsV3F-/:J4-AJ1AIJ1 J*">J% J1%J**J10J14 L=>LLc|jr|jjs|jjrDts-t j tdt|%y|jyt|%yy)zzCopy image files to destination directory. This overwritten method can use Pillow to convert image files. z&Pillow not found - copying image filesN) rrar rrrrrrTcopy_image_filesrr\s r2rzEpubBuilder.copy_image_filessa ;;{{**dkk.N.NNN2&N#OPG,.--/(* r1cyrfr0rcs r2copy_download_fileszEpubBuilder.copy_download_filess r1c|jdr%d|vr!|jsy|j|d|j|d<t||||||y)zCreate a rendered page. This method is overwritten for genindex pages in order to fix href link attributes. genindexgenindexentriesNdoctype)rxrRrr$rT handle_page)r]pagenameaddctx templatename outfilename event_argr^s r2r%zEpubBuilder.handle_pages\   z */@F/J>>   f%67 8 LLy HflKSr1ctjtdtt j |j d|jy)z!Write the metainfo file mimetype.zwriting mimetype file...mimetypeN)rinforrrr template_dirrrcs r2build_mimetypezEpubBuilder.build_mimetypes3 B123 $"3"3Z@$++Nr1ctjtdtj|j d}t |ttj|jd|y)z/Write the metainfo file META-INF/container.xml.z&writing META-INF/container.xml file...zMETA-INFz container.xmlN) rr-rrrrrrr.)r]outnamers r2build_containerzEpubBuilder.build_containersK B?@A4;; 3& $"3"3_EvNr1ctjdx}tjt |}ntj}i}t j |jj|d<t j |jj|d<t j |jj|d<t j |jj|d<t j |jj|d<t j |jj|d<t j |jj|d<t j |jj|d <t j tj d ||d <g|d <g|d <g|d<|S)zaCreate a dictionary with all metadata for the content.opf file properly escaped. SOURCE_DATE_EPOCHr;authoruidlang publisher copyrightschemer)z%Y-%m-%ddatemanifest_itemsspinesguides)osgetenvtimegmtimer@r`r~ra epub_title epub_authorepub_uid epub_languageepub_publisherepub_copyright epub_schemeepub_identifierstrftime)r]source_date_epoch time_tuplemetadatas r2content_metadatazEpubBuilder.content_metadatasf "$+>!? ?  LS):%;(>?![[)@)@A++dkk&:&:;;;t{{'@'@A $ DKK,F,F G $ DKK,F,F G![[)@)@AT[[%@%@A;;t}}Z'LM%'!"r1c 8tjtd|j}g|_dddddddd d |j j d zg |j jz|_|js(|jjd |jztj|jD]i\}}}|jt!|D]C}t#t%j&|||j}||jvr=t%j(|d }||j*vr'|dvr"tj-td|dd|j/tj0d}t3t5j6t9|t5j6|j;|t5j6|j*|}|dj||jj|Flt=} |j>D]u} d| dvr | d|jvrtAt5j6|j;| dd} |dj| | jC| dw|jDD]u} tAt5j6|j;| d|jzd} |dj| | jC| d|jzw|jrmtAt5j6|j;d |jzd} |dj| | jCd |jz|jD]e} | | vs| jG|js$tAt5j6|j;| d} |dj| gd}|j jHr|j jH\}}|j/tj0d}t5j6|j;||d<|rtAt5j6|j;|jJd} |djMd| |jJ|jvrt%j(|jJd }|jj|jJt3t5j6|jJt5j6|j;|jJt5j6|j*|}|dj|t5j6||j jNd}|jQt%j(|jJd||| jC|jJd}d}|j jRr|j jRD]\}}}|jUdd}||jvr|jj||dk(rd}|dk(rd}|djtWt5j6|t5j6|t5j6||rK|rI|djtWd|jXdt5j6|jJ|r[|j>rO|djtWd|jXdt5j6|j>ddt[t%j&|j\d |j|y)!zWrite the metainfo file content.opf It contains bibliographic data, a file list and the spine (the reading order). zwriting content.opf file...z .buildinfor, content.opftoc.ncxMETA-INF/container.xmlz Thumbs.dbz ehthumbs.dbz .DS_Storez nav.xhtml.epubr"rs)z.jsz.xmlz!unknown mimetype for %s, ignoringrSunknown_project_filesrrr<#rCTr=rFNr)imager;rr>z content.opf_t)/rr-rrOfilesra epub_basenameepub_exclude_files ignored_filesrRr}rVr?walkrsortsortedrrrr media_typesrrHsepr&r`r~rrorr[r4rdomain_indicesendswith epub_covercoverpage_namerprojectr% epub_guidesplitr9 guide_titlesrr.)r]rNrootdirsrXrrrr spinefilesrefnodespiner-rn html_tmplrWctxauto_add_cover auto_add_tocr:r<r;rs r2 build_contentzEpubBuilder.build_contents  B456((*!# *J ')A)=+)4;;+D+Dw+NP KK * * + ~~    % %j4??&B C!#!5 , D$ IIKUm ,"499T2#6 Dt111mmH-b1d.../1r*M'NPX,2>$++dll:3O&PQSWXE X  % %e , NN:7 8JJ 1D:%$--*Hdkk$,,t*<=uE"))%0 1  ;; ! !#{{55 E9MM"&&#.E $ DLL,? @HW dkk$,,t7J7J*KLdS"))!U3&&djj8--(;(;)r]rruincrs r2 new_navpointzEpubBuilder.new_navpointdsO  NNa N a  tzz14>>V d8nb: :r1c g}|jtddddgd}d}|D]}|ds |djdd}||jvr0|d|jj kDrM|d|k(rS|j ||}|j|d jj||j|n|d|d zk(r|d z }|rE|jjr/|d jj|j ||d |j ||}|d jj||j|n|d|krz|dt|kr"|j|dt|kr"|d}|j ||}|d jj||j|n|}|djS) zCreate the toc navigation structure. Subelements of a node are nested inside the navpoint. For nested nodes the parent node is reinserted in the subnav. dummyrrPNrBrCrVrursrF) r}r>rgr[ra epub_tocdepthrupoprE epub_tocdupr)r]r navstackrulastnoderrr?s r2build_navpointszEpubBuilder.build_navpointsms $&!RR89 D<>'',Q/Dt)))G}t{{888G}%,,T59  %%,,X6)g%!)+  7 7RL))001B1B8UTY1Z[,,T59 %%,,X6)g&7mc(m3LLN7mc(m3W ,,T59 %%,,X6)H= @{###r1ci}|jj|d<tj|jj|d<||d<||d<|S)z]Create a dictionary with all metadata for the toc.ncx file properly escaped. r6r;ru navpoints)rarEr`r~rC)r]rurrNs r2 toc_metadatazEpubBuilder.toc_metadatasR$&++.. KK (>(>?! )r1c~tjtd|jjdk(rW|j j |jj|dd}|j|g}|j|n |j}|j||j|}td|jD}t||jj}t!t#j$|j&d|j(|j+||y)z Write the metainfo file toc.ncx.zwriting toc.ncx file...defaultFrc3&K|] }|d yw)ruNr0).0rs r2 z(EpubBuilder.build_toc..s)r rrrD)rur@rrDrr)9r,r-r.__doc__ copysourcesupported_image_typessupported_remote_imagesadd_permalinksallow_sharp_as_current_pathembeddeddownload_supporthtml_scaled_image_linksearchCOVERPAGE_NAMErdTOCTREE_TEMPLATEr|LINK_TARGET_TEMPLATErCSS_LINK_TARGET_CLASSr GUIDE_TITLESrh MEDIA_TYPESr_ REFURI_RErr.r$rUrdrirorrrrrrrrrrrrr r%r/r2rOrrrur}rrr __classcell__)r^s@r2rOrOysDJ+#N"'H" F#N'/1LKILG 1CF%9 0 - *,3+BA F,[$1 %AN + LWEI T!+ T?B TNR TO O2j^X:*$X =(Ur1rO)en)rKr'rLr'rr')Br __future__rr`r?rerArtypingrrr urllib.parserzipfiler r r docutilsr docutils.utilsr sphinxrsphinx.builders.htmlrr sphinx.localer sphinx.utilrsphinx.util.displayrsphinx.util.fileutilrsphinx.util.osutilrrrdocutils.nodesrrPILr ImportError getLoggerr,rrrrrrrrrrcompilerr&r4r9r>rMrrOr0r1r2rsE)" 1155&A/0;;,   8 $$ ##%   &            ' BJJ ' : J  J z  M U'M Uw EsD DD