U \ªShqã @sâdZddlmZddlZddlZddlZddlmZddlmZm Z ddl m Z ddl m Z mZmZddlmZdd lmZmZdd lmZdd lmZdd lmZmZdd lmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'm(Z(zddl)m*Z*Wne+k rdZ*YnXe ,e-¡Z.dZ/dZ0dZ1dZ2dZ3dZ4dddœZ5dddd d!d"d#d#d$d%d&d'œ Z6d(Z7e 8d)¡Z9Gd*d+„d+e ƒZ:Gd,d-„d-e ƒZ;Gd.d/„d/e ƒZe>Z?Gd7d8„d8eƒZ@dS):z#Base class of epub2/epub3 builders.é)Ú annotationsN)Úpath)ÚAnyÚ NamedTuple)Úquote)Ú ZIP_DEFLATEDÚ ZIP_STOREDÚZipFile)Únodes)ÚElementÚNode)Ú smartquotes)Úaddnodes)Ú BuildInfoÚStandaloneHTMLBuilder)Ú__)Úlogging)Ústatus_iterator)Úcopy_asset_file)Ú format_date)ÚcopyfileÚ ensuredir)ÚImagezepub-cover.xhtmlz toctree-l%dz [%(uri)s]z#%dZ Footnotesz link-targetzTable of ContentsZCover)ÚtocÚcoverzapplication/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@s&eZdZUded<ded<ded<dS)Ú ManifestItemÚstrÚhrefÚidÚ media_typeN©Ú__name__Ú __module__Ú __qualname__Ú__annotations__©r+r+úM/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/builders/_epub_base.pyr!Qs r!c@seZdZUded<ded<dS)ÚSpiner"ZidrefÚboolZlinearNr&r+r+r+r,r-Ws r-c@s&eZdZUded<ded<ded<dS)ÚGuider"ÚtypeÚtitleÚuriNr&r+r+r+r,r/\s r/c@s6eZdZUded<ded<ded<ded<ded<d S) ÚNavPointr"ÚnavpointÚintÚ playorderÚtextÚrefuriz list[Any]ÚchildrenNr&r+r+r+r,r3bs r3Úenr")ÚtÚlanguageÚreturncCs2| dd¡}t |¡}t ||¡}| dd¡}|S)Nz"ú")Úreplacer ZeducateDashesOldSchoolZ educateQuotes)r;r<r+r+r,Úsphinx_smarty_pantsks     r@cs*eZdZdZdZddddgZdZdZdZdZ dZ dZ dZ e ZeZeZeZeZeZeZdZdZd d œ‡fd d „ Zd d œdd„Zdd œdd„Zdddœdd„Z ddddœdd„Z!dd dœdd„Z"d d œdd „Z#dd d!œd"d#„Z$dddd$œd%d&„Z%d'd d(œd)d*„Z&dad'dd d,œd-d.„Z'dd'd d/œ‡fd0d1„ Z(d2d d(œd3d4„Z)dd5d6œd7d8„Z*d d œd9d:„Z+d d œ‡fd;d<„ Z,d d œd=d>„Z-dbddAddBdCd dDœ‡fdEdF„ Z.d d œdGdH„Z/dcdd dJœdKdL„Z0dMd œdNdO„Z1d d œdPdQ„Z2dddMdRd5dSdTœdUdV„Z3ddWdœdXdY„Z4dRdWdMdZœd[d\„Z5d d œd]d^„Z6d d œd_d`„Z7‡Z8S)eÚ 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. FrrrrTÚÚNone)r=cs@tƒ ¡d|_d|_d|_d|_i|_| dd¡|_g|_ dS)NrrÚ use_indexÚepub) ÚsuperÚinitÚ out_suffixZ link_suffixr6ÚtocidÚid_cacheZget_builder_configrDÚrefnodes©Úself©Ú __class__r+r,rGžs zEpubBuilder.initrcCst|j|jddgƒS)NÚhtmlrE)rÚconfigÚtagsrLr+r+r,Úcreate_build_info©szEpubBuilder.create_build_infoztuple[str, dict]cCs|jj|jjfS©N)rQZ epub_themeZepub_theme_optionsrLr+r+r,Úget_theme_config¬szEpubBuilder.get_theme_configr")Únamer=cCs.|j |¡}|s*d|j d¡}||j|<|S)zReturn a unique id for name.zepub-%drE)rJÚgetÚenvZ new_serialno)rMrVr$r+r+r,Úmake_id°s   zEpubBuilder.make_idr zlist[dict[str, Any]])ÚdoctreeÚresultr=c Csªt|tjƒr„| d¡r„|d}| d¡r,|S|jjd}tdddƒD]<}|j||krD|  |t   |¡t t   |  ¡¡ƒdœ¡q¦qDn"t|tjƒr¦|D]}| ||¡}q”|S)z>Collect section titles, their depth in the toc and the refuri.r8)zhttp://zhttps://zirc:zmailto:Úclasseséréÿÿÿÿ©Úlevelr8r7)Ú isinstancer Ú referencerWÚ startswithÚparentÚ attributesÚrangeÚtoctree_templateÚappendrPÚescapeÚsspÚastextr Ú get_refnodes)rMrZr[r8r\r`Úelemr+r+r,rl¹s"  ý zEpubBuilder.get_refnodes)r r=cCsJtƒ}|D]:}|d|kr6tjtdƒ|ddddq | |d¡q dS)Nr8zduplicated ToC entry found: %srEZduplicated_toc_entry©r0Úsubtype)ÚsetÚloggerÚwarningrÚadd)rMr ZappearedÚnoder+r+r,Úcheck_refnodesÑs üzEpubBuilder.check_refnodescCsl|jj|jj|ddd}| |g¡|_t |jj¡}|r\|d7}|jD]}||d|d<qF| |j¡dS)zwGet the total table of contents, containing the root_doc and pre and post files not managed by sphinx. FT©Zprune_toctreesZ includehiddenú/r8N) rXÚget_and_resolve_doctreerQÚroot_docrlrKrÚdirnameÚ toc_add_files)rMrZZ master_dirÚitemr+r+r,Úget_tocÞs þ zEpubBuilder.get_toc)rKr=c Cs°| ddt |jj|j¡tt |jj|jj  ¡¡ƒdœ¡t |jj ƒD],\}}| ddt |¡tt |¡ƒdœ¡qJ|jj D]*\}}|  dt |¡tt |¡ƒdœ¡q€dS)zDAdd the root_doc, pre and post files to a list of refnodes. rér_N)ÚinsertrPrirQryrHrjrXÚtitlesrkÚreversedZepub_pre_filesZepub_post_filesrh)rMrKÚfiler7r+r+r,r{ís&ÿý ý  ýzEpubBuilder.toc_add_files)ÚprefixÚfragmentr=cCs|| dd¡S)z;Return a href/id attribute with colons replaced by hyphens.ú:ú-)r?)rMrƒr„r+r+r,Ú fix_fragmentszEpubBuilder.fix_fragmentúnodes.document©Útreer=csÒdddœ‡fdd„ }| tj¡D]X}d|kr\ˆj |d¡}|r\ˆ | d¡| d¡¡|d<d |kr ˆ d |d ¡|d <q | tj¡D],}||ƒ|jd d }t |tj ƒr†||ƒq†| t j ¡D] }||ƒqÀd S)zªReplace colons with hyphens in href and id attributes. Some readers crash because they interpret the part as a transport protocol specification. r rC)rtr=cs<g}|dD]"}ˆ d|¡}||kr | |¡q ||d<dS)zUpdate IDs of given *node*.ÚidsrBN)r‡rh)rtZnew_idsZnode_idZnew_idrLr+r,Úupdate_node_id s    z+EpubBuilder.fix_ids..update_node_idr8r~éÚrefidrBT)ZascendN) Úfindallr rbÚ refuri_reÚmatchr‡ÚgroupÚtargetÚ next_noderar rÚdesc_signature)rMrŠrŒrbÚmr“r”r•r+rLr,Úfix_idss    zEpubBuilder.fix_idsÚinline)rŠÚ show_urlsr=cCsjddddœdd„}dddddœd d „}dd d œd d„}|dkrBdS|dkrjt| tj¡ƒ}||ƒ\}}d} t| tj¡ƒD]ê} |  dd¡} |  d¡rz| |  ¡krz| j   | ¡d} |dkrò|j d| i} t  | | ¡} | d  |j¡| j  | | ¡qz|dkrzt| }| d7} |||ƒ}| j  | |¡|||| ƒ}| ||¡|dd|d<| |dd¡|d7}qzdS)z+Add visible link targets for external linksrˆr"znodes.footnote_reference)ÚdocÚlabelr=cSs(t d¡}| t |¡¡| |¡|S)z.Create a footnote_reference node with childrenz[#]_)r Zfootnote_referencerhÚTextZnote_autofootnote_ref)ršr›Ú footnote_refr+r+r,Úmake_footnote_ref+s  z8EpubBuilder.add_visible_links..make_footnote_refznodes.footnote)ršr›r2r=cSsNt |¡}t ¡}| t |¡¡| |¡| dt d|¡¡| |¡|S)z$Create a footnote node with childrenrrB)r ÚfootnoteZ paragraphrhrœrr›Znote_autofootnote)ršr›r2rŸÚparar+r+r,Ú make_footnote2s   z4EpubBuilder.add_visible_links..make_footnoteztuple[Element, int]r‰cSsºt| tj¡ƒ}|r2|d}|j|j |¡dfS| tj¡D]6}t|ƒdkr>| ¡t kr>|j|j |¡dfSq>t | tj ¡ƒ}t ¡}|  t  t ¡¡|  |¡|| |¡dfS)zfFind or create a spot to place footnotes. The function returns the tuple (parent, index).r^r~)Úlistrr rŸrdÚindexZrubricÚlenrkÚFOOTNOTES_RUBRIC_NAMEÚnextÚdocumentrhrœ)rŠZfnsÚfnrtršZrubr+r+r,Ú footnote_spot<s z4EpubBuilder.add_visible_links..footnote_spotÚnoNrŸr~r8rB)zhttp:zhttps:zftp:r˜r2r\r‹rrŽ)r¦rr r§r¢rbrWrcrkrdr£Úlink_target_templater˜rhÚcss_link_target_classrÚFOOTNOTE_LABEL_TEMPLATEZ add_backref)rMrŠr™ržr¡r©ršZfn_spotZfn_idxÚnrrtr2ÚidxÚlinkr›rrŸr+r+r,Úadd_visible_links(s8       zEpubBuilder.add_visible_links)ÚdocnamerZr=cs,| |¡| ||jj¡tƒ ||¡dS)z•Write one document file. This method is overwritten in order to fix fragment identifiers and to add visible external links. N)r—r±rQZepub_show_urlsrFÚ write_doc)rMr²rZrNr+r,r³ks zEpubBuilder.write_docz'list[tuple[str, list[tuple[str, Any]]]]c CsÀ|D]¶\}}|D]¨\}\}}}t|ƒD]<\}\}} |j | ¡} | r&|| |  d¡|  d¡¡f||<q&|D]N\} } t| ƒD]<\}\}} |j | ¡} | rx|| |  d¡|  d¡¡f| |<qxqhqqdS)z'Fix href attributes for genindex pages.r~rN)Ú enumeraterr‘r‡r’) rMrŠÚ_keyÚcolumnsZ _entrynameÚlinksZsubitemsÚiZismainr°r–Z _subentrynameZ subentrylinksr+r+r,Ú fix_genindexus  ÿ   ÿzEpubBuilder.fix_genindexr.)Úfilenamer=cCst |¡d}|tkS)z=Does the filename extension indicate a vector graphic format?r^)rÚsplitextÚVECTOR_GRAPHICS_EXTENSIONS)rMrºÚextr+r+r,Úis_vector_graphics‡szEpubBuilder.is_vector_graphicsc CsÎtt |j|j¡ƒt|jtdƒdt|jƒ|j j ƒD]’}|j|}zt   t |j |¡¡}Wn¢tk rþ| |¡st tdƒt |j |¡¡z&tt |j |¡t |j|j|¡ƒWn>tk rô}z t tdƒt |j |¡|¡W5d}~XYnXYq4YnX|jjr|jdkr| ¡}|jjdkrj|j\}}|jj}||krjt|||ƒ}| ||ft j¡}z| t |j|j|¡¡Wq4tk rÆ}z t tdƒt |j |¡|¡W5d}~XYq4Xq4dS) zÌCopy 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... Zbrownz-cannot read image file %r: copying it insteadzcannot copy image file %r: %sN)ÚPrzcannot write image file %r: %s)rrÚjoinÚoutdirZimagedirrÚimagesrr¤ZappÚ verbosityrÚopenÚsrcdirÚOSErrorr¾rqrrrrQÚepub_fix_imagesÚmodeÚconvertÚepub_max_image_widthÚsizeÚroundÚresizeZBICUBICÚsave) rMÚsrcÚdestZimgÚerrÚwidthÚheightÚnwZnhr+r+r,Úcopy_image_files_pilŒsNÿ     ÿÿ  ÿ       ÿz EpubBuilder.copy_image_files_pilcsL|jrH|jjs|jjr>ts4t tdƒ¡tƒ  ¡qH|  ¡n tƒ  ¡dS)zzCopy image files to destination directory. This overwritten method can use Pillow to convert image files. z&Pillow not found - copying image filesN) rÂrQrÇrÊrrqrrrrFÚcopy_image_filesrÕrLrNr+r,rÖ³s  zEpubBuilder.copy_image_filescCsdSrTr+rLr+r+r,Úcopy_download_filesÁszEpubBuilder.copy_download_filesú page.htmlNÚdictz str | Noner)ÚpagenameÚaddctxÚ templatenameÚ outfilenameÚ event_argr=csL| d¡r*d|kr*|jsdS| |d¡|j|d<tƒ |||||¡dS)z…Create a rendered page. This method is overwritten for genindex pages in order to fix href link attributes. ÚgenindexZgenindexentriesNÚdoctype)rcrDr¹ràrFÚ handle_page)rMrÚrÛrÜrÝrÞrNr+r,ráÄs  zEpubBuilder.handle_pagecCs(t tdƒ¡tt |jd¡|jƒdS)z!Write the metainfo file mimetype.zwriting mimetype file...ÚmimetypeN)rqÚinforrrrÀÚ template_dirrÁrLr+r+r,Úbuild_mimetypeÒszEpubBuilder.build_mimetypeúMETA-INF/container.xml)Úoutnamer=cCs<t tdƒ¡t |jd¡}t|ƒtt |jd¡|ƒdS)z/Write the metainfo file META-INF/container.xml.z&writing META-INF/container.xml file...zMETA-INFz container.xmlN) rqrãrrrÀrÁrrrä)rMrçrÁr+r+r,Úbuild_container×szEpubBuilder.build_containerzdict[str, Any]cCsÆi}t |jj¡|d<t |jj¡|d<t |jj¡|d<t |jj¡|d<t |jj¡|d<t |jj¡|d<t |jj ¡|d<t |jj ¡|d<t t d d d ¡|d <g|d <g|d<g|d<|S)zaCreate a dictionary with all metadata for the content.opf file properly escaped. r1ÚauthorÚuidÚlangZ publisherÚ copyrightÚschemer$z%Y-%m-%dr:)r<ÚdateÚmanifest_itemsÚspinesÚguides) rPrirQÚ epub_titleZ epub_authorÚepub_uidZ epub_languageZepub_publisherZepub_copyrightZ epub_schemeZepub_identifierr)rMÚmetadatar+r+r,Úcontent_metadataÞszEpubBuilder.content_metadatac CsÔt tdƒ¡| ¡}|j tj¡s4|jtj7_t|jƒ}g|_ dddddddd d |j j d g |j j |_ |js†|j  d |j¡t |j¡D]Ð\}}}| ¡t|ƒD]´}t ||¡|d …}||j krÐq¬t |¡d}||jkr |dkr¬tjtdƒ|dddq¬| tjd¡}tt t|ƒ¡t | |¡¡t |j|¡ƒ} |d | ¡|j  |¡q¬q’tƒ} |j D]b} d| dkr†qp| d|j kršqpt!t | | d¡¡dƒ} |d | ¡|  "| d¡qp|j#D]H} t!t | | d|j¡¡dƒ} |d | ¡|  "| d|j¡qÚ|jrft!t | d |j¡¡dƒ} |d | ¡|  "d |j¡|j D]B}|| krl| |j¡rlt!t | |¡¡dƒ} |d | ¡qld }|j j$r¼|j j$\}}| tjd¡}t | |¡¡|d<|r¼t!t | |j%¡¡dƒ} |d &d| ¡|j%|j kr‚t |j%¡d}|j  |j%¡tt |j%¡t | |j%¡¡t |j|¡ƒ} |d | ¡t |¡|j j'dœ}| (t |j%¡d||¡|  "|j%¡d}d}|j j)rN|j j)D]v\}}}| *d¡d}||j kr|j  |¡|dkrd}|dkr"d}|d t+t |¡t |¡t |¡ƒ¡qÖ|r~|r~|d t+d|j,dt |j%¡ƒ¡|r¸|j r¸|d t+d|j,dt |j dd¡ƒ¡t-t |j.d ¡|j|ƒd S)!zƒWrite 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.opfútoc.ncxræz Thumbs.dbz ehthumbs.dbz .DS_Storez nav.xhtmlú.epubrßNr^)z.jsz.xmlz!unknown mimetype for %s, ignoringrEZunknown_project_filesrnrwrïú#r8TrðrFr)Úimager1rrñz content.opf_t)/rqrãrrõrÁÚendswithÚosÚsepr¤ÚfilesrQÚ epub_basenameZepub_exclude_filesÚ ignored_filesrDrhrHÚwalkÚsortÚsortedrrÀr»Ú media_typesrrr?r!rPrirrYrprKr-rsZdomain_indicesZ epub_coverÚcoverpage_namerÚprojectráZ epub_guideÚsplitr/Ú guide_titlesrrä)rMrôZolenÚrootÚdirsrþr¨rºr½r|Z spinefilesZrefnodeZspinerãrVZ html_tmplrúÚctxZauto_add_coverZ auto_add_tocr0r2r1r‚r+r+r,Ú build_contentñsÜ  ýü    ÿþ       þÿ      þ    þ þzEpubBuilder.build_contentr5r3)rtr`Úincrr=cCs@|r|jd7_|jd7_td|j|j|d|dgƒS)z;Create a new entry in the toc from the node at given level.r~z navPoint%dr7r8)r6rIr3)rMrtr`r r+r+r,Ú new_navpoint`sÿzEpubBuilder.new_navpointzlist[NavPoint]cCsxg}| tddddgƒ¡d}d}|D]D}|ds6q&|d d¡d}||jkrTq&|d|jjkrfq&|d|kr¢| ||¡}| ¡|d j |¡| |¡nÆ|d|d kr |d 7}|râ|jj râ|d j | ||d ¡¡| ||¡}|d j |¡| |¡n^|d|krf|dt |ƒkr6| ¡q|d}| ||¡}|d j |¡| |¡n‚|}q&|djS) z³Create the toc navigation structure. Subelements of a node are nested inside the navpoint. For nested nodes the parent node is reinserted in the subnav. ÚdummyrrBNr7r8rùr`r^r~F) rhr3rrrQÚ epub_tocdepthrÚpopr9Z epub_tocdupr¤)rMr Znavstackr`Zlastnodertr‚r4r+r+r,Úbuild_navpointsisD           zEpubBuilder.build_navpoints)r`Ú navpointsr=cCs6i}|jj|d<t |jj¡|d<||d<||d<|S)z]Create a dictionary with all metadata for the toc.ncx file properly escaped. rêr1r`r)rQrórPrirò)rMr`rrôr+r+r,Ú toc_metadata•s  zEpubBuilder.toc_metadatacCsªt tdƒ¡|jjdkrJ|jj|jj|ddd}| |g¡}|  |¡n|j }|  |¡|  |¡}t dd„|j Dƒƒ}t||jjƒ}tt |jd¡|j| ||¡ƒdS) z Write the metainfo file toc.ncx.zwriting toc.ncx file...ÚdefaultFrvcss|]}|dVqdS)r`Nr+)Ú.0r|r+r+r,Ú ¯sz(EpubBuilder.build_toc..z toc.ncx_tN)rqrãrrQZ epub_tocscoperXrxryrlr{rKrurÚmaxÚminrrrrÀrärÁr)rMrZrKrr`r+r+r,Ú build_toc s"  þ     ÿzEpubBuilder.build_tocc Cs¤|jjd}t tdƒ|¡t |j|¡}t|dt ƒd}|  t |jd¡dt ¡dD]}|  t |j|¡|t ¡qT|j D]}|  t |j|¡|t ¡qxW5QRXdS)z~Write the epub file. It is a zip file with the mimetype file stored uncompressed as the first entry. røzwriting %s file...Úwrâ)rærör÷N) rQrÿrqrãrrrÀrÁr rÚwriterrþ)rMrçZ epub_filenamerErºr+r+r,Ú build_epub´s  zEpubBuilder.build_epub)r˜)rØNN)ræ)T)9r'r(r)Ú__doc__Z copysourceZsupported_image_typesZsupported_remote_imagesZadd_permalinksZallow_sharp_as_current_pathZembeddedZdownload_supportZhtml_scaled_image_linkÚsearchÚCOVERPAGE_NAMErÚTOCTREE_TEMPLATErgÚLINK_TARGET_TEMPLATEr«ÚCSS_LINK_TARGET_CLASSr¬Ú GUIDE_TITLESrÚ MEDIA_TYPESrÚ REFURI_RErräràrGrSrUrYrlrur}r{r‡r—r±r³r¹r¾rÕrÖr×rárårèrõr rrrrrÚ __classcell__r+r+rNr,rAxsf ÿ   !C 'ÿo , rA)r:)ArÚ __future__rrPrüÚrerÚtypingrrÚ urllib.parserÚzipfilerrr Zdocutilsr Zdocutils.nodesr r Zdocutils.utilsr ZsphinxrZsphinx.builders.htmlrrZ sphinx.localerZ sphinx.utilrZsphinx.util.displayrZsphinx.util.fileutilrZsphinx.util.i18nrZsphinx.util.osutilrrZPILrÚ ImportErrorÚ getLoggerr'rqr r!r"r­r¥r#r$r%r¼Úcompiler&r!r-r/r3r@rjrAr+r+r+r,Úsl             þõ