o Ì^½^9-ã@s€dZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z ddl m Z ddl mZe e¡Zgd¢Zejfdd„Zd d „Zd d „Zd d„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zd@dd„Zdd„Zd d!„Z d"d#„Z!e "d$¡Z#d%d&„Z$d'd(„Z%dAd*d+„Z&dAd,d-„Z'd.d/„Z(d0d1„Z)d2d3„Z*d4d5„Z+d6d7„Z,d8d9„Z-d:d;„Z.dd?„d?ej0ƒZ1e1ƒZ2dS)Bz’ Standalone file utils. Nothing in this module should have an knowledge of config or the layout and structure of the site and pages in the site. éN)ÚdatetimeÚtimezone)Úurlparse)Ú exceptions)z .markdownz.mdownz.mkdnz.mkdz.mdc Cs^dd„}Gdd„d|ƒ}| d|¡zt ||¡Wt|dƒr#| ¡SSt|dƒr.| ¡ww)z— Wrap PyYaml's loader so we can extend it to suit our needs. Load all strings as unicode. https://stackoverflow.com/a/2967461/3609487 cSs | |¡S)zi Override the default string handling function to always return unicode objects. )Úconstruct_scalar)ÚselfÚnode©r ú7/usr/lib/python3/dist-packages/mkdocs/utils/__init__.pyÚconstruct_yaml_str)s z%yaml_load..construct_yaml_strc@seZdZdZdS)zyaml_load..Loaderzu Define a custom loader derived from the global loader to leave the global loader unaltered. N)Ú__name__Ú __module__Ú __qualname__Ú__doc__r r r r ÚLoader0srztag:yaml.org,2002:strÚclose)Úadd_constructorÚyamlÚloadÚhasattrr)ÚsourceÚloaderr rr r r Ú yaml_load!s    ÿ ÿrcCstj |¡r tj |¡SdS)zƒ Return the modified time of the supplied file. If the file does not exists zero is returned. see build_pages for use. g)ÚosÚpathÚexistsÚgetmtime)Ú file_pathr r r Ú modified_timeHs  rcCs0tj d¡}|durtt tj¡ ¡ƒSt|ƒS)zÆ Returns the number of seconds since the epoch. Support SOURCE_DATE_EPOCH environment variable for reproducible builds. See https://reproducible-builds.org/specs/source-date-epoch/ ÚSOURCE_DATE_EPOCHN) rÚenvironÚgetÚintrÚnowrÚutcÚ timestamp©Úsource_date_epochr r r Úget_build_timestampSs r(cCs2tj d¡}|durt tj¡St t|ƒtj¡S)z¹ Returns an aware datetime object. Support SOURCE_DATE_EPOCH environment variable for reproducible builds. See https://reproducible-builds.org/specs/source-date-epoch/ rN) rr r!rr#rr$Ú fromtimestampr"r&r r r Úget_build_datetimeas  r*cCs tƒ d¡S)z¼ Returns the displayable date string. Support SOURCE_DATE_EPOCH environment variable for reproducible builds. See https://reproducible-builds.org/specs/source-date-epoch/ z%Y-%m-%d)r*Ústrftimer r r r Úget_build_dateos r,cstƒ‰‡fdd„|DƒS)z5 Reduce duplicate items in a list and preserve order cs"g|] }|ˆvrˆ |¡s|‘qSr )Úadd)Ú.0Úitem©Úseenr r Ú |sÿzreduce_list..)Úset)Údata_setr r0r Ú reduce_listysr5cCsTtj |¡}tj |¡st |¡tj |¡r"tj |tj |¡¡}t  ||¡dS)z} Copy source_path to output_path, making sure any parent directories exist. The output_path may be a directory. N) rrÚdirnamerÚmakedirsÚisdirÚjoinÚbasenameÚshutilÚcopyfile)Ú source_pathÚ output_pathÚ output_dirr r r Ú copy_file€s    r@cCs\tj |¡}tj |¡st |¡t|dƒ}| |¡WdƒdS1s'wYdS)zQ Write content to output_path, making sure any parent directories exist. ÚwbN)rrr6rr7ÚopenÚwrite)Úcontentr>r?Úfr r r Ú write_fileŽs     "ÿrFcCsbtj |¡sdSt |¡D]!}| d¡rq tj ||¡}tj |¡r)t |d¡q t  |¡q dS)zU Remove the content of a directory recursively but not the directory itself. NÚ.T) rrrÚlistdirÚ startswithr9r8r;ÚrmtreeÚunlink)Ú directoryÚentryrr r r Úclean_directory™s    õrNcCs6tj |¡d}tj |¡dkr|dSd |df¡S)a  Map a source file path to an output html path. Paths like 'index.md' will be converted to 'index.html' Paths like 'about.md' will be converted to 'about/index.html' Paths like 'api-guide/core.md' will be converted to 'api-guide/core/index.html' rÚindexú.htmlú/ú index.html)rrÚsplitextr:r9©rr r r Ú get_html_path®srUTcCs6t|ƒ}d| tjjd¡}|r|dtdƒ …S|S)aƒ Map a source file path to an output html path. Paths like 'index.md' will be converted to '/' Paths like 'about.md' will be converted to '/about/' Paths like 'api-guide/core.md' will be converted to '/api-guide/core/' If `use_directory_urls` is `False`, returned URLs will include the a trailing `index.html` rather than just returning the directory path. rQNrR)rUÚreplacerrÚsepÚlen)rÚuse_directory_urlsÚurlr r r Ú get_url_path¼s  r[cst‡fdd„tDƒƒS)zŽ Return True if the given file path is a Markdown file. https://superuser.com/questions/249436/file-extension-for-markdown-files c3s&|]}t ˆ ¡d |¡¡VqdS)z*{}N)ÚfnmatchÚlowerÚformat)r.ÚxrTr r Ú Ôs€$z#is_markdown_file..)ÚanyÚmarkdown_extensionsrTr rTr Úis_markdown_fileÎsrccCótj |¡d ¡}|dvS)ú= Return True if the given file path is an HTML file. é)rPú.htm©rrrSr]©rÚextr r r Ú is_html_file×órkcCrd)rerf)rPrgz.xmlrhrir r r Úis_template_fileârlrmz^\d{3}\.html?$cCstt |¡ƒS)zG Return True if the given file path is an HTTP error template. )ÚboolÚ_ERROR_TEMPLATE_REÚmatchrTr r r Úis_error_templateñsrqcCsL|dkrt |¡}d|dvr|dn|}t ||¡}| d¡r$|dS|S)z- Return given url relative to other. rGrfrrQ)Ú posixpathÚsplitÚrelpathÚendswith)rZÚotherÚpartsÚrelurlr r r Úget_relative_urløs   ryÚcCsNt|pdƒ}t|ƒ}|js|js| d¡r|S|dur!t||jƒSt ||¡S)z< Return a URL relative to the given page or using the base. rG)rQú#N) Ú path_to_urlrÚschemeÚnetlocrIryrZrrr9)rÚpageÚbaseÚparsedr r r Ú normalize_urls   r‚cCs$g}|D] }| t|||ƒ¡q|S)zM Return a list of URLs relative to the given page or using the base. )Úappendr‚)Ú path_listrr€Úurlsrr r r Úcreate_media_urlssr†cCsd | d¡¡S)zConvert a system path to a URL.rQú\)r9rsrTr r r r|sr|cCs$tƒ|}tj tj | ¡j¡¡S)z5 Return the directory of an installed theme by name. )Ú get_themesrrr6ÚabspathrÚ__file__)ÚnameÚthemer r r Ú get_theme_dir%s rcCsœi}tjddd}tjddD]<}|j|vr(|jjdkr(t d |j|jj¡¡‚|j|vrF||jjj|jjg}t   d|jd  |¡|jj¡|||j<q|S)zE Return a dict of all installed themes as (name, entry point) pairs. Úmkdocsz mkdocs.themes)ÚdistÚgroup)rzJThe theme {} is a builtin theme but {} provides a theme with the same namezQThe theme %s is provided by the Python packages '%s'. The one in %s will be used.ú,) Ú pkg_resourcesÚ get_entry_mapÚiter_entry_pointsr‹rÚkeyrÚConfigurationErrorr^ÚlogÚwarningr9)ÚthemesÚbuiltinsrŒÚmultiple_packagesr r r rˆ,sþ þ rˆcCs tƒ ¡S)z.Return a list of all installed themes by name.)rˆÚkeysr r r r Úget_theme_namesDs rcCs0|}| dd¡ dd¡}| ¡|kr| ¡}|S)z4 Return a page tile obtained from a directory name. ú-ú Ú_)rVr]Ú capitalize)r6Útitler r r Údirname_to_titleJs  r£cCsR| dd¡ dd¡ d¡}|r'| d¡ ¡}| ¡sq | d¡s"dS| d¡SdS)a= Get the title of a Markdown document. The title in this case is considered to be a H1 that occurs before any other content in the document. The procedure is then to iterate through the lines, stopping at the first non-whitespace content. If it is a title, return that, otherwise return None. z Ú ú rz# N)rVrsÚpopÚstriprIÚlstrip)Ú markdown_srcÚlinesÚliner r r Úget_markdown_titleUs   úr¬cCsD|D]}t|tƒs q||vr||Sqg}||i}| |¡|S)z² Given a list, look for dictionary with a key matching key and return it's value. If it doesn't exist, create it with the value of an empty list and return that. )Ú isinstanceÚdictrƒ)Úbranchr•rÚ new_branchr r r Úfind_or_create_nodehs  ÿ r±cCsrg}|D]2}tjj|vr| |¡qtj |¡\}}| tjj¡}|}|D] }t|ƒ}t||ƒ}q%| |¡q|S)zk Given a list of paths, convert them into a nested structure that will match the pages config. )rrrWrƒrsr£r±)ÚpathsÚnestedrrLr rwr¯Úpartr r r Ú nest_paths|s    rµc@seZdZdZdZdd„ZdS)Ú WarningFilterz( Counts all WARNING level log messages. rcCs|jtjkr |jd7_dS)NrfT)ÚlevelnoÚloggingÚWARNINGÚcount)rÚrecordr r r Úfilteršs zWarningFilter.filterN)r r rrrºr¼r r r r r¶–s r¶)T)Nrz)3rr¸rr’r;Úrerr\rrrrÚ urllib.parserrŽrÚ getLoggerr r—rbrrrr(r*r,r5r@rFrNrUr[rcrkrmÚcompilerorqryr‚r†r|rrˆrr£r¬r±rµÚFilterr¶Úwarning_filterr r r r ÚsV    '