2yi\ddlmZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z m Z ddlmZmZmZmZmZmZmZddlmZddlZddlZddlZddlmZerddlZddl m!Z!dd l"m#Z#ejHe%Z&Gd d ejNZ(Gd d Z)GddZ*ejVjXj[ddgZ.ddZ/ddZ0ddZ1ddZ2ddZ3ddZ4y)) annotationsN)cached_property)PurePath PurePosixPath) TYPE_CHECKINGCallableIterableIteratorMappingSequenceoverload)quote)utils) MkDocsConfig)PagecNeZdZdZ dZ dZ dZ dZ dZdZ dZ d Z d Z d Z y ) InclusionLevelrcyNTselfs X/var/www/html/content_weaver/venv/lib/python3.12/site-packages/mkdocs/structure/files.pyallzInclusionLevel.all+scH|j|jjkDSNvalueDRAFTrs r is_includedzInclusionLevel.is_included.szzDJJ,,,,rcH|j|jjkSr!r"rs r is_excludedzInclusionLevel.is_excluded1zzTZZ----rcH|j|jjk\Sr!r"rs r is_in_servezInclusionLevel.is_in_serve4r(rcH|j|jjkDSr!r# NOT_IN_NAVrs r is_in_navzInclusionLevel.is_in_nav7szzDOO1111rcH|j|jjkSr!r,rs r is_not_in_navzInclusionLevel.is_not_in_nav:szzT__2222rN)__name__ __module__ __qualname__EXCLUDEDr$r- UNDEFINEDINCLUDEDrr%r'r*r.r0rrrrrsHH9 EfJIIuHp-..23rrc$eZdZdZddZddZddZddZeddZ eddZ ddZ dd Z dd Z dejd  dd Zejd  d d Zd!dZd!dZd!dZd!dZd"dZed#dZej0d$dZy)%Filesz>""rcLt|j|jvS)z?Soft-deprecated, prefer `get_file_from_path(path) is not None`.)ras_posixr;rpaths r __contains__zFiles.__contains__Ls~&&(DNN::rcB|Dcic]}|j|c}Scc}w)z#Soft-deprecated, prefer `src_uris`.)src_pathrfiles r src_pathszFiles.src_pathsPs!155 t#555sc|jS)z A mapping containing every file, with the keys being their [`src_uri`][mkdocs.structure.files.File.src_uri]. )r;rs rsrc_uriszFiles.src_urisUs ~~rcf|jjt|jS)z7Return a File instance with File.src_uri equal to path.)r;getrrGrHs rget_file_from_pathzFiles.get_file_from_path]s$~~!!(4."9"9";<> ) MMMOa t||,'+t||$rc~ |j|j=y#t$rt|jdwxYw)z"Remove file from Files collection.z not in collectionN)r;r:KeyError ValueErrorrMs rremovez Files.removejsA Dt||, D //ABC C Ds"< inclusionc||D]7}|jr||js'|j|9y)z-Copy static files from source to destination.N)is_documentation_pager_ copy_file)rdirtyr_rNs rcopy_static_fileszFiles.copy_static_filesqs6 &D--/Idnn4Mu% &rct|Dcgc](}|js||js'|*c}Scc}w)z2Return iterable of all Markdown page file objects.)rar_)rr_rNs rdocumentation_pageszFiles.documentation_pages|s1"&d)C)C)E)TXTbTbJcddds 555cN|Dcgc]}|js|c}Scc}w)z0Return iterable of all static page file objects.)is_static_pagerMs r static_pageszFiles.static_pagess!!%?)<)<)>???""cN|Dcgc]}|js|c}Scc}w)zPReturn iterable of all file objects which are not documentation or static pages.) is_media_filerMs r media_fileszFiles.media_files!!%>););)=>>>rjcN|Dcgc]}|js|c}Scc}w)z/Return iterable of all javascript file objects.) is_javascriptrMs rjavascript_fileszFiles.javascript_filesrnrjcN|Dcgc]}|js|c}Scc}w)z(Return iterable of all CSS file objects.)is_cssrMs r css_fileszFiles.css_filess!%7777rjc xfd}|j|D]}|j|jjD]r}tj j tj j||sA|jt||jjy)zCRetrieve static files from Jinja environment and add to collection.c gd}|jd|jdtjD|jjj |D](}t j |j|s(yy)N).*z*/.*z*.pyz*.pycz*.htmlz*readme*zmkdocs_theme.ymlz locales/*c3&K|] }d| yw)*Nr).0xs r z=Files.add_files_from_theme..filter..sGasGGsFT)rYextendrmarkdown_extensionsthemestatic_templatesfnmatchlower)namepatternspatternconfigs rfilterz*Files.add_files_from_theme..filtersm`H OOK ( OOGU-F-FG G OOFLL99 :# !??4::<9  !r) filter_funcN) list_templatesrTrdirsosrIisfilejoinrYFilesite_diruse_directory_urls)renvrrrIdirs ` radd_files_from_themezFiles.add_files_from_themes &&6&: D&&t,4!<<,,Cww~~bggll3&=> DsFOOVE^E^$_`  rc:tjdt|SNzDo not access Files._files.)rVrWrXrs r_filesz Files._filess 35GH rctjdt|Dcic]}|j|c}|_ycc}wr)rVrWrXr:r;)rr#r=s rrz Files._filess/ 35GH0561!))Q,66s<N)r<Iterable[File]returnNone)rzIterator[File])rint)rIstrrbool)rzdict[str, File])rzMapping[str, File])rIrrz File | None)rNrrrF)rcrr_ Callable[[InclusionLevel], bool]rr)r_rrSequence[File])rr)rzjinja2.Environmentrrrr)rr)r#r)r1r2r3__doc__r>rBrErJpropertyrOrQrTrYr]rr%rdrfrirmrqrtrrsetterrrrr8r8>sF7-#;66=,D &7E6P6P & &4 &  &@N?Y?Ye<e e @??80 ]]77rr8cleZdZUdZded< ded< ded< ded< ej Zd ed < d Zded < d Z d ed< e d/dZ e jd0dZ e d/dZ e jd0dZ d Zded<eeej d d1dZeeej d d2dZed d ej d d3dZd ej d d4dZdZej*d5dZd/dZeeZ d6d7dZeeZ d6d7d ZeeZ ed5d!Zed/d"Zd8d#Z e d9d$Z!e!jd:d%Z!e d/d&Z"e"jd0d'Z"d;draj A MkDocs File object. It represents how the contents of one file should be populated in the destination site. A file always has its `abs_dest_path` (obtained by joining `dest_dir` and `dest_path`), where the `dest_dir` is understood to be the *site* directory. `content_bytes`/`content_string` (new in MkDocs 1.6) can always be used to obtain the file's content. But it may be backed by one of the two sources: * A physical source file at `abs_src_path` (by default obtained by joining `src_dir` and `src_uri`). `src_dir` is understood to be the *docs* directory. Then `content_bytes`/`content_string` will read the file at `abs_src_path`. `src_dir` *should* be populated for real files and should be `None` for generated files. * Since MkDocs 1.6 a file may alternatively be stored in memory - `content_string`/`content_bytes`. Then `src_dir` and `abs_src_path` will remain `None`. `content_bytes`/`content_string` need to be written to, or populated through the `content` argument in the constructor. But `src_uri` is still populated for such files as well! The virtual file pretends as if it originated from that path in the `docs` directory, and other values are derived. For static files the file is just copied to the destination, and `dest_uri` equals `src_uri`. For Markdown files (determined by the file extension in `src_uri`) the destination content will be the rendered content, and `dest_uri` will have the `.html` extension and some additional transformations to the path, based on `use_directory_urls`. rr:rr str | Nonesrc_dirdest_dirrr_N generated_bystr | bytes | None_contentcTtjj|jS)z^Same as `src_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rrInormpathr:rs rrLz File.src_pathsww --rc@t|j|_yr!)rrGr:rr#s rrLz File.src_paths//1 rcTtjj|jS)z_Same as `dest_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rrIrdest_urirs r dest_pathzFile.dest_pathsww ..rc@t|j|_yr!)rrGrrs rrzFile.dest_paths 002 rz Page | Nonepager^cy)z Create a virtual file backed by in-memory content. It will pretend to be a file in the docs dir at `src_uri`. Nr)clsrr:contentr_s r generatedzFile.generated rcy)z Create a virtual file backed by a physical temporary file at `abs_src_path`. It will pretend to be a file in the docs dir at `src_uri`. Nr)rrr: abs_src_pathr_s rrzFile.generatedrr)rrr_c|du|duk(r td||d|j|j|}|jjxsd|_||_||_|S)z Create a virtual file, backed either by in-memory `content` or by a file at `abs_src_path`. It will pretend to be a file in the docs dir at `src_uri`. Nz9File must have exactly one of 'content' or 'abs_src_path')rrrr_z ) TypeErrorrrplugins_current_pluginrrr)rrr:rrr_r=s rrzFile.generated-so tO!5 6WX X  __%88   77F;% r)rr_c\||_||_||_||_|||_||_yr!)rLrrrrr_)rrIrrrrr_s rr>z File.__init__Js5    "4  $DM"rct|jd|jd|jd|jd|j d|j d|jdS)N(z , src_dir=z , dest_dir=z, use_directory_urls=z , dest_uri=z , inclusion=))typer1r:rrrrr_rs r__repr__z File.__repr__\snDz""#1T\\$4Jt||>NO ((=d>U>U=XY ( T^^4DA G rc6|j |jSdS)z A path relative to the source repository to use for the "edit" button. Defaults to `src_uri` and can be overwritten. For generated files this should be set to `None`. N)rr:rs redit_uriz File.edit_urics $008t||BdBrctj|j}tj|\}}|dk(rdS|S)Soft-deprecated, do not use.READMEindex) posixpathbasenamer:splitext)rfilenamestemexts r _get_stemzFile._get_stemms<%%dll3&&x0 c(*w44rcD|jrtj|j\}}| |j}|r|j dk(r#tj ||j dzStj ||j dS|jS)rr.html index.html)rarsplitr:rrr)rrparentrs r_get_dest_pathzFile._get_dest_pathvs  % % '(t||< FH!)%)%<%<"%g)=!~~fdii'.ABB!~~fdiiFF||rc|j}tj|\}}| |j}|r|dk(r |xsddz}t |S)rr./)rrrrurlquote)rrurldirnamers r_get_urlz File._get_urlsRmm%OOC0  %!%!8!8  (l":>cS(C}rc|jytjjtjj |j|j S)z The absolute concrete path of the source file. Will use backslashes on Windows. Note: do not use this path to read the file, prefer `content_bytes`/`content_string`. N)rrrIrrr:rs rrzFile.abs_src_paths= << ww T\\4<< HIIrctjjtjj|j|j S)zTThe absolute concrete path of the destination file. Will use backslashes on Windows.)rrIrrrrrs r abs_dest_pathzFile.abs_dest_paths0ww T]]DMM JKKrctj|jt|tr|jS|S)z+Return url for file relative to other file.)rget_relative_urlr isinstancer)rothers rurl_relative_tozFile.url_relative_tos/%%dhhZt=T ``Z_``rc|j}|>|jJt|jd5}|jcdddSt |t s|j }|S#1swY+xYw)z Get the content of this file as a bytestring. May raise if backed by a real file (`abs_src_path`) if it cannot be read. If used as a setter, it defines the content of the file, and `abs_src_path` becomes unset. Nrb)rropenreadrbytesencoderrr=s r content_byteszFile.content_bytesst-- ?$$0 00d''. !vvx  '5)nn&G   s A//A8cDt|tsJ||_d|_yr!)rrrrrs rrzFile.content_bytess!%'''  rc|j}|@|jJt|jdd5}|jcdddSt |t s|j dd}|S#1swY.xYw)a Get the content of this file as a string. Assumes UTF-8 encoding, may raise. May also raise if backed by a real file (`abs_src_path`) if it cannot be read. If used as a setter, it defines the content of the file, and `abs_src_path` becomes unset. Nz utf-8-sigstrict)encodingerrors)r)rrrrrrdecoders rcontent_stringzFile.content_strings}-- ?$$0 00d''+hO STvvx  '3'nn[nBG   s A44A=cDt|tsJ||_d|_yr!)rrrrrs rrzFile.content_strings!%%%%  rc|r4|js$tjd|jdytjd|jd|j}t j t jj|d|j}|0|jJ tj|j|yt|t r)t#|dd 5}|j%|dddyt#|d 5}|j%|dddy#tj$rYywxYw#1swYyxYw#1swYyxYw) zCCopy source file to destination, ensuring parent directories exist.zSkip copying unmodified file: ''NzCopying media file: 'T)exist_okwzutf-8)rwb) is_modifiedlogdebugr:rrmakedirsrIrrrrrbshutil SameFileErrorrrrwrite)rrc output_pathr output_files rrbzFile.copy_files8 ))+ II7 ~QG H  )$,,q9:((  BGGOOK04@-- ?$$0 00  1 1;? %k39 +[!!'* + +k4( +K!!'* + + ''   + + + +s*7 D86EE8E EEE&c2|jy|jJtjj |j rStjj |j tjj |jkSyr)rrrrIrrgetmtimers rrzFile.is_modifiedso == $  ,,, 77>>$,, -77##D$6$67"'':J:J4K\K\:]] ]rc@tj|jS)z'Return True if file is a Markdown page.)ris_markdown_filer:rs rrazFile.is_documentation_pages%%dll33rc8|jjdS)z7Return True if file is a static page (HTML, XML, JSON).)rz.htmz.xmlz.jsonr:endswithrs rrhzFile.is_static_pages||$$%GHHrcH|jxs|j S)z:Return True if file is not a documentation or static page.)rarhrs rrlzFile.is_media_files"..0ID4G4G4IJJrc8|jjdS)z)Return True if file is a JavaScript file.)z.jsz .javascriptz.mjsr rs rrpzFile.is_javascripts||$$%CDDrc8|jjdS)z"Return True if file is a CSS file.z.cssr rs rrsz File.is_csss||$$V,,r)rr)r#r) rrr:rrz str | bytesr_rrr) rrr:rrrr_rrr) rrr:rrrrrr_rrr)rIrrrrrrrrrr_rrr)rrr!)rz bool | Nonerr)rz File | strrr)rr)r#rr)rcrrr)rr)*r1r2r3r__annotations__rr5r_rrrrLrrrr classmethodrr>rr weak_propertyrrrrrrrrrrrrrrbrrarhrlrprsrrrrrsBBLcHMj . 8 8I~8@#L*#t$(H '! ..__22//33D+ %3$<$<        "       %3$<$<        "        '+#'$2$<$< $  ! " F $$2$<$<### # ! ##"# #$  CC5 9 %D< ~.Hm ( #C\JJLLa"!! "!! +,4IKE-rrrwz /templates/c.|jd}|r t|znt}|jd}|jd}|D]}|jtjk(s!|j |j rtj|_R|r1|j |j rtj|_|r1|j |j rtj|_tj|_y)zKRe-calculate which files are excluded, based on the patterns in the config. exclude_docs draft_docs not_in_navN) rS_default_excluder_rr5 match_filer:r4r$r-r6)r<rexcludedrafts nav_excluderNs rset_exclusionsrs7=zz.7QG,3(9IG6>^55 5!!$,,/!/!8!8F--dll;!/!5!5!7!7 !E!/!:!:!/!8!8 9rc zg}g}tj|ddD]\}}}tjj||d}|j |j t i}|D]}}t tjj|||d|d|d} |j| j| } | | ur|j| | f|j| | } t|||D]\} } | jjr]| jjr0tjd| j d| j d  |j#| } |j#| t'|S#t$$rYwxYw#t$$rYwxYw) z2Walk the `docs_dir` and return a Files collection.docs_dirT) followlinkskeyrrz Excluding 'z+' from the site because it conflicts with 'z'.)rwalkrIrelpathsort_file_sort_keyrr setdefaultrrYrr_r%rwarningr:r]r\r8) rr<conflicting_files source_dirdirnames filenames relative_dir files_by_destrrN prev_fileabs r get_filesr0"sE13+-776*3ESW+X' Hiwwz6*3EF  >*)+ ! H \84z"z"+, D&00EI$!(()T):; LL I  (5&!!1 ;; " " ${{&&( !!)),WXYXaXaWbbde  Q  Q <     s$.FF. F+*F+. F:9F:cvt|jj}|sy|dd|jdk7|dfS)z Replicates the sort order how `get_files` produces it - index first, directories last. To sort a list of `File`, pass as the `key` argument to `sort`. rNrr)rr:partsr)r=r2s r file_sort_keyr3Os> !)) $ * *E  #2J')59 55rcNtjj|ddv|fS)zaAlways sort `index` or `README` as first filename in list. This works only on basenames of files.r)rr)rrIr)r=s rr$r$[s' GG  Q  "*= =q AArc$t|tS)rr)sortedr$)r*s r _sort_filesr7`s ) 00rctjdt|D]R}|jdr|s|j dr|n|}t j ||j dsRyy)NzD_filter_paths is not used since MkDocs 1.5 and will be removed soon.rTF)rVrWrXr  startswithrstrip)rrIis_dirritemmatchs r _filter_pathsr>esh MMNPb == f ,( ??5$**S/ 2 r)r<rrrrr)rrrr8)r=r)r=r)r* Iterable[str]rz list[str]) rrrIrr;rrr?rr)5 __future__renumrloggingrrrrV functoolsrpathlibrrtypingrrr r r r r urllib.parserrpathspecpathspec.gitignore pathspec.utilmkdocsrjinja2.environmentjinja2mkdocs.config.defaultsrmkdocs.structure.pagesr getLoggerr1rEnumrr8r gitignore GitIgnoreSpec from_linesrrr0r3r$r7r>rrrrTs"   %+[[[*3+g!3TYY3>t7t7nT-T-n %%33>>m?TU9&*Z 6B 1 r