o ^^s(@sddlZddlZddlZddlmZddlmZddlm Z e e Z e e jGdddZGdddZd d Zd d Zd dZdS)N) cmp_to_key)quote)utilsc@szeZdZdZddZddZddZdd Zd d Zd d Z dddZ ddZ ddZ ddZ ddZddZddZdS)Filesz A collection of File objects. cCs||_dd|D|_dS)NcSsi|]}|j|qS)src_path.0filerr8/usr/lib/python3/dist-packages/mkdocs/structure/files.py sz"Files.__init__..)_files src_paths)selffilesrrr __init__szFiles.__init__cC t|jSN)iterr rrrr __iter__ zFiles.__iter__cCrr)lenr rrrr __len__rz Files.__len__cCs ||jvSr)rrpathrrr __contains__rzFiles.__contains__cCs|jtj|S)z: Return a File instance with File.src_path equal to path. )rgetosrnormpathrrrr get_file_from_pathszFiles.get_file_from_pathcCs|j|||j|j<dS)z" Append file to Files collection. N)r appendrr)rr rrr r!!s z Files.appendFcCs |D] }|s ||qdS)z/ Copy static files from source to destination. N)is_documentation_page copy_file)rdirtyr rrr copy_static_files&s  zFiles.copy_static_filescCdd|DS)z4 Return iterable of all Markdown page file objects. cSg|]}|r|qSr)r"rrrr .z-Files.documentation_pages..rrrrr documentation_pages,zFiles.documentation_pagescCr&)z2 Return iterable of all static page file objects. cSr'r)is_static_pagerrrr r(2r)z&Files.static_pages..rrrrr static_pages0r+zFiles.static_pagescCr&)zR Return iterable of all file objects which are not documentation or static pages. cSr'r) is_media_filerrrr r(6r)z%Files.media_files..rrrrr media_files4r+zFiles.media_filescCr&)z1 Return iterable of all javascript file objects. cSr'r) is_javascriptrrrr r(:r)z*Files.javascript_files..rrrrr javascript_files8r+zFiles.javascript_filescCr&)z* Return iterable of all CSS file objects. cSr'r)is_cssrrrr r(>r)z#Files.css_files..rrrrr css_files<r+zFiles.css_filesc s|fdd}|j|dD]/}tj|}||vr;djD]}tjtj||r:|t||ddnqq dS)zE Retrieve static files from Jinja environment and add to collection. csRgd}|ddtjD|dj|D] }t||r&dSqdS)N).*z*/.*z*.pyz*.pycz*.htmlz*readme*zmkdocs_theme.ymlcss|]}d|VqdS)z*{}N)format)r xrrr Esz=Files.add_files_from_theme..filter..themeFT)extendrmarkdown_extensionsstatic_templatesfnmatchlower)namepatternspatternconfigrr filterBsz*Files.add_files_from_theme..filter) filter_funcr8site_diruse_directory_urlsN) list_templatesrrrdirsisfilejoinr!File)renvrBrCrdirrrAr add_files_from_theme@s  zFiles.add_files_from_themeNF)__name__ __module__ __qualname____doc__rrrrr r!r%r*r-r/r1r3rNrrrr rs  rc@seZdZdZddZddZddZdd Zd d Zd d Z ddZ d ddZ ddZ ddZ ddZddZddZddZdS)!rKa A MkDocs File object. Points to the source and destination locations of a file. The `path` argument must be a path that exists relative to `src_dir`. The `src_dir` and `dest_dir` must be absolute paths on the local file system. The `use_directory_urls` argument controls how destination paths are generated. If `False`, a Markdown file is mapped to an HTML file of the same name (the file extension is changed to `.html`). If True, a Markdown file is mapped to an HTML index file (`index.html`) nested in a directory using the "name" of the file in `path`. The `use_directory_urls` argument has no effect on non-Markdown files. File objects have the following properties, which are Unicode strings: File.src_path The pure path of the source file relative to the source directory. File.abs_src_path The absolute concrete path of the source file. File.dest_path The pure path of the destination file relative to the destination directory. File.abs_dest_path The absolute concrete path of the destination file. File.url The url of the destination file relative to the destination directory as a string. cCsnd|_tj||_tjtj||j|_||_| ||_ tjtj||j |_ | ||_ dSr)pagerrrrrJ abs_src_path _get_stemr>_get_dest_path dest_path abs_dest_path_get_urlurl)rrsrc_dirdest_dirrFrrr rvs  z File.__init__cCs(dd}t||jo||j||jkS)NcSsdd|DS)NcSsi|] \}}|dvr||qS))rrUr[r)r keyvaluerrr r sz1File.__eq__..sub_dict..)items)drrr sub_dictszFile.__eq__..sub_dict) isinstance __class____dict__)rotherrbrrr __eq__s z File.__eq__cCs || Sr)rgrrfrrr __ne__s z File.__ne__cCs.tj|j}tj|\}}|dvrdS|S)z5 Return the name of the file without it's extension. indexREADMErk)rrbasenamersplitext)rfilenamestemextrrr rVszFile._get_stemcCsT|r'tj|j\}}|r|jdkrtj||jdStj||jdS|jS)z/ Return destination path based on source path. rk.html index.html)r"rrsplitrr>rJ)rrFparentrorrr rWs zFile._get_dest_pathcCsR|jtjjd}tj|\}}|r%|dkr%|dkr!d}t|S|d}t|S)z' Return url based in destination path. /rs.)rXreplacerrseprturlquote)rrFr[dirnamerorrr rZs z File._get_urlcCs t|jt|tr |jS|S)z- Return url for file relative to other file. )rget_relative_urlr[rcrKrhrrr url_relative_tos zFile.url_relative_toFcCsH|r|std|jdStd|jt|j|jdS)zE Copy source file to destination, ensuring parent directories exist. z"Skip copying unmodified file: '{}'zCopying media file: '{}'N) is_modifiedlogdebugr5rrr#rUrY)rr$rrr r#s zFile.copy_filecCs.tj|jrtj|jtj|jkSdS)NT)rrrIrYgetmtimerUrrrr rszFile.is_modifiedcCstj|jdtjvS)z) Return True if file is a Markdown page. )rrrnrrr:rrrr r"szFile.is_documentation_pagecCtj|jddvS)z9 Return True if file is a static page (html, xml, json). r)rrz.htmz.xmlz.jsonrrrnrrrrr r,zFile.is_static_pagecCs|p| S)z< Return True if file is not a documentation or static page. )r"r,rrrr r.szFile.is_media_filecCr)z+ Return True if file is a JavaScript file. r)z.jsz .javascriptrrrrr r0rzFile.is_javascriptcCr)z$ Return True if file is a CSS file. r)z.cssrrrrr r2rz File.is_cssNrO)rPrQrRrSrrgrirVrWrZr~r#rr"r,r.r0r2rrrr rKVs      rKc Csg}ddg}tj|dddD]o\}}}tj||d}t|D]}tjtj||}t||d|dr;||q!| t |D]9} tjtj|| }t| |d|drZqD| dkrmd |vrmt d |qD|t||d|d |d qDqt|S) z4 Walk the `docs_dir` and return a Files collection. r4z /templatesdocs_dirT) followlinks)rmris_direxcludeFz readme.mdzindex.mdz=Both index.md and readme.md found. Skipping readme.md from {}rErF)rwalkrrelpathlistrrJ _filter_pathsremovesort _sort_filesr=rwarningr5r!rKr) rBrr source_dirdirnames filenames relative_dirr|rrorrr get_filess(   " rcCsdd}t|t|dS)z< Always sort `index` or `README` as first filename in list. cSsH||krdStj|ddvrdStj|ddvs ||kr"dSdS)Nrrjr)rrrn)r6yrrr comparesz_sort_files..compare)r^)sortedr)rrrrr rs rcCsH|D]}|dr |s q|dr|n|}t||dr!dSqdS)z" .gitignore style file filtering. rvTF)endswith startswithr<strip)rmrrritemmatchrrr rsr)r<rlogging functoolsr urllib.parserr{mkdocsr getLoggerrPr addFilterwarning_filterrrKrrrrrrr s     H