g\SSKJr SSKrSSKrSSKrSSKrSSKrSSKrSSKrSSK J r SSK J r J r SSKJrJrJrJrJrJrJr SSKJr SSKrSSKrSSKrSSKJr \(aSSKrSSK J!r! SS K"J#r# \RH"\%5r&"S S \RN5r("S S 5r)"SS5r*\RVRXR[SS/5r.SSjr/SSjr0SSjr1SSjr2SSjr3SSjr4g)) annotationsN)cached_property)PurePath PurePosixPath) TYPE_CHECKINGCallableIterableIteratorMappingSequenceoverload)quote)utils) MkDocsConfig)PagecV\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rg)InclusionLevelrcgNTselfs 8/usr/lib/python3/dist-packages/mkdocs/structure/files.pyallInclusionLevel.all+scHURURR:$NvalueDRAFTrs r is_includedInclusionLevel.is_included.szzDJJ,,,,r!cHURURR:*$r#r$rs r is_excludedInclusionLevel.is_excluded1zzTZZ----r!cHURURR:$r#r$rs r is_in_serveInclusionLevel.is_in_serve4r,r!cHURURR:$r#r% NOT_IN_NAVrs r is_in_navInclusionLevel.is_in_nav7szzDOO1111r!cHURURR:*$r#r1rs r is_not_in_navInclusionLevel.is_not_in_nav:szzT__2222r!rN)__name__ __module__ __qualname____firstlineno__EXCLUDEDr&r2 UNDEFINEDINCLUDEDrr'r*r.r3r6__static_attributes__rr!rrrsHH9 EfJIIuHp-..23r!rcV\rSrSrSrSSjrSSjrSSjrSSjr\ SSj5r \ SSj5r SS jr SS jr SS jrS \R S .S!S jjjr\R S .S"SjjrS#SjrS#SjrS#SjrS#SjrS$Sjr\ S%Sj5r\R2S&Sj5rSrg)'Files>z>""r!cN[U5R5UR;$)z?Soft-deprecated, prefer `get_file_from_path(path) is not None`.)ras_posixrErpaths r __contains__Files.__contains__Ls~&&(DNN::r!cFUVs0sHoRU_M sn$s snf)z#Soft-deprecated, prefer `src_uris`.)src_pathrfiles r src_pathsFiles.src_pathsPs#155 t#555scUR$)zn A mapping containing every file, with the keys being their [`src_uri`][mkdocs.structure.files.File.src_uri]. rErs rsrc_urisFiles.src_urisUs ~~r!cfURR[U5R55$)z7Return a File instance with File.src_uri equal to path.)rEgetrrTrUs rget_file_from_pathFiles.get_file_from_path]s$~~!!(4."9"9";<> ) MMMOa t||,'+t||$r!cURUR g![a [UR<S35ef=f)z"Remove file from Files collection.z not in collectionN)rErDKeyError ValueErrorr[s rremove Files.removejsA Dt||, D //ABC C Ds$> inclusioncUHDnUR5(aMU"UR5(dM3URU5 MF g)z-Copy static files from source to destination.N)is_documentation_pagers copy_file)rdirtyrsr\s rcopy_static_filesFiles.copy_static_filesqs7D--//Idnn4M4Mu%r!cUVs/sH4o"R5(dMU"UR5(dM2UPM6 sn$s snf)z2Return iterable of all Markdown page file objects.)rurs)rrsr\s rdocumentation_pagesFiles.documentation_pages|s5"&d)C)C)E)TXTbTbJcdddsAAAc^UVs/sHoR5(dMUPM sn$s snf)z0Return iterable of all static page file objects.)is_static_pager[s r static_pagesFiles.static_pagess#!%?)<)<)>???**c^UVs/sHoR5(dMUPM sn$s snf)zPReturn iterable of all file objects which are not documentation or static pages.) is_media_filer[s r media_filesFiles.media_files#!%>););)=>>>rc^UVs/sHoR5(dMUPM sn$s snf)z/Return iterable of all javascript file objects.) is_javascriptr[s rjavascript_filesFiles.javascript_filesrrc^UVs/sHoR5(dMUPM sn$s snf)z(Return iterable of all CSS file objects.)is_cssr[s r css_filesFiles.css_filess !%7777rc ^U4SjnURUS9HnURU5bMTRRHwn[R R [R RXT55(dMFUR[XETRTR55 M M g)zCRetrieve static files from Jinja environment and add to collection.c0>/SQnURS5 URS[R55 URTRR 5 UH/n[ R "UR5U5(dM/ g g)N).*z*/.*z*.pyz*.pycz*.htmlz*readme*zmkdocs_theme.ymlz locales/*c3,# UH nSU3v M g7f)*Nr).0xs r =Files.add_files_from_theme..filter..sG-FasG-FsFT)rkextendrmarkdown_extensionsthemestatic_templatesfnmatchlower)namepatternspatternconfigs rfilter*Files.add_files_from_theme..filtersk`H OOK ( OOGU-F-FG G OOFLL99 :#??4::<99 $r!) filter_funcN) list_templatesrerdirsosrVisfilejoinrkFilesite_diruse_directory_urls)renvrrrVdirs ` radd_files_from_themeFiles.add_files_from_themes &&6&:D&&t,4!<<,,Cww~~bggll3&=>> DFOOVE^E^$_` -;r!c<[R"S[5 U$NzDo not access Files._files.)rhrirjrs r_files Files._filess 35GH r!c[R"S[5 UVs0sHo"RU_M snUlgs snfr)rhrirjrDrE)rr%rGs rrrs1 35GH0561))Q,66s?r`N)rFIterable[File]returnNone)rzIterator[File])rint)rVstrrbool)rzdict[str, File])rzMapping[str, File])rVrrz File | None)r\rrrF)rwrrs Callable[[InclusionLevel], bool]rr)rsrrSequence[File])rr)rzjinja2.Environmentrrrr)rr)r%r)r8r9r:r;__doc__rHrMrQrWpropertyr]rarerkrprr'rxr{rrrrrrsetterr?rr!rrArA>sF7-#;66=,D &7E6P6P & &4 &  &@N?Y?Ye<e e @??80 ]]77r!rAc\rSrSr%SrS\S'S\S'S\S'S\S '\RrS \S 'S r S\S 'S r S\S'\ S1Sj5r \ RS2Sj5r \ S1Sj5r\RS2Sj5rS rS\S'\\\RS.S3Sjj55r\\\RS.S4Sjj55r\S S \RS.S5Sjj5rS \RS.S6SjjrSr\R,S7Sj5rS1Sjr\"\5rS8S9S jjr\"\5rS8S9S!jjr\"\5r\S7S"j5r\S1S#j5r S:S$jr!\ S;S%j5r"\"RSS)jjr$S?S*jr%S?S+jr&S?S,jr'S?S-jr(S?S.jr)S?S/jr*S0r+g )@ra 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`. rrDrr str | Nonesrc_dirdest_dirrrsN generated_bystr | bytes | None_contentcT[RRUR5$)z^Same as `src_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rrVnormpathrDrs rrZ File.src_pathsww --r!c@[U5R5Ulgr#)rrTrDrr%s rrZrs//1 r!cT[RRUR5$)z_Same as `dest_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rrVrdest_urirs r dest_pathFile.dest_pathsww ..r!c@[U5R5Ulgr#)rrTrrs rrrs 002 r!z Page | Nonepagerrcg)zp Create a virtual file backed by in-memory content. It will pretend to be a file in the docs dir at `src_uri`. Nr)clsrrDcontentrss r generatedFile.generated r!cg)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)rrrD abs_src_pathrss rrrrr!)rrrscUSLUSL:Xa [S5eU"USURURUS9nURR=(d SUlXFlX6lU$)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')rrrrsz ) TypeErrorrrplugins_current_pluginrrr)rrrDrrrsrGs rrr-sk tO!5 6WX X  __%88   77F;% r!)rrscRXlX lX0lX@lUbXPlX`lgr#)rZrrrrrs)rrVrrrrrss rrH File.__init__Js)   "4  $M"r!c[U5RSUR<SUR<SUR<SUR <SUR <SURS3$)N(z , src_dir=z , dest_dir=z, use_directory_urls=z , dest_uri=z , inclusion=))typer8rDrrrrrsrs r__repr__ File.__repr__\snDz""#1T\\$4Jt||>NO ((=d>U>U=XY ( T^^4DA G r!c8URc UR$S$)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)rrDrs redit_uri File.edit_urics $008t||BdBr!c[R"UR5n[R"U5up#US:XaS$U$)Soft-deprecated, do not use.READMEindex) posixpathbasenamerDsplitext)rfilenamestemexts r _get_stemFile._get_stemms:%%dll3&&x0 (*w44r!c\UR5(a[R"UR5up#Uc URnU(aUR S:Xa#[R "X R S-5$[R "X R S5$UR$)rr.html index.html)rursplitrDrrr)rrparentrs r_get_dest_pathFile._get_dest_pathvs  % % ' '(t||< F!)%)%<%<"%g)=!~~fii'.ABB!~~fiiFF||r!cURn[R"U5up4Uc URnU(aUS:XaU=(d SS-n[ U5$)rr./)rrrrurlquote)rrurldirnamers r_get_url File._get_urlsPmm%OOC0  %!%!8!8  (l":>cS(C}r!cURcg[RR[RR URUR 55$)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)rrrVrrrDrs rrFile.abs_src_paths= << ww T\\4<< HIIr!c[RR[RRURUR 55$)zTThe absolute concrete path of the destination file. Will use backslashes on Windows.)rrVrrrrrs r abs_dest_pathFile.abs_dest_paths0ww T]]DMM JKKr!c[R"UR[U[5(aUR5$U5$)z+Return url for file relative to other file.)rget_relative_urlr isinstancer)rothers rurl_relative_toFile.url_relative_tos2%%dhhZt=T=T ``Z_``r!cURnUc?URce[URS5nUR5sSSS5 $[ U[ 5(dUR 5nU$!,(df  N5=f)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)rropenreadrbytesencoderrrGs r content_bytesFile.content_bytessn-- ?$$0 00d''.!vvx/.'5))nn&G /.s A66 BcL[U[5(deXlSUlgr#)rrrrrs rrrs"%''''  r!c URnUc>URce[URSSS9nUR5sSSS5 $[ U[ 5(dUR SSS9nU$!,(df  N5=f)z 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_stringFile.content_stringsy-- ?$$0 00d''+hOSTvvxPO'3''nn[nBG POs A55 BcL[U[5(deXlSUlgr#)rrrrrs rr!r"s"%%%%%  r!cU(a9UR5(d$[RSURS35 g[RSURS35 URn[ R "[ RRU5SS9 URnUc2URce[R"URU5 g[U[ 5(a&[#USSS 9nUR%U5 SSS5 g[#US 5nUR%U5 SSS5 g![Ra gf=f!,(df  g=f!,(df  g=f) zCCopy source file to destination, ensuring parent directories exist.zSkip copying unmodified file: ''NzCopying media file: 'T)exist_okwzutf-8)rwb) is_modifiedlogdebugrDr rmakedirsrVrrrrrvshutil SameFileErrorrrrwrite)rrw output_pathr output_files rrvFile.copy_files, ))++ II7 ~QG H  )$,,q9:((  BGGOOK04@-- ?$$0 00  1 1;? % %k39[!!'*:9k4(K!!'*)( ''  :9)(s*!EE*E0EE E-0 E>c@URbgURce[RR UR 5(aS[RR UR 5[RR UR5:$gr)rrrrVrr getmtimers rr)File.is_modifiedsr == $  ,,, 77>>$,, - -77##D$6$67"'':J:J4K\K\:]] ]r!cB[R"UR5$)z'Return True if file is a Markdown page.)ris_markdown_filerDrs rruFile.is_documentation_pages%%dll33r!c8URRS5$)z7Return True if file is a static page (HTML, XML, JSON).)rz.htmz.xmlz.jsonrDendswithrs rr~File.is_static_pages||$$%GHHr!cZUR5=(d UR5(+$)z:Return True if file is not a documentation or static page.)rur~rs rrFile.is_media_files"..0ID4G4G4IJJr!c8URRS5$)z)Return True if file is a JavaScript file.)z.jsz .javascriptz.mjsr:rs rrFile.is_javascripts||$$%CDDr!c8URRS5$)z"Return True if file is a CSS file.z.cssr:rs rr File.is_csss||$$V,,r!) rrrrrsrrZrDr)rr)r%r) rrrDrrz str | bytesrsrrr) rrrDrrrrsrrr) rrrDrrrrrrsrrr)rVrrrrrrrrrrsrrr)rrr#)rz bool | Nonerr)rz File | strrr)rr)r%rr)rwrrr)rr),r8r9r:r;r__annotations__rr=rsrrrrZrrrr classmethodrrHrr weak_propertyrrrrrrrrrr rrr!rvr)rur~rrrr?rr!rrrsBBLcHMj . 8 8I~8@#L*#t$(H '! ..__22//33D+ %3$<$<        "       %3$<$<        "        '+#'$2$<$< $  ! " F $$2$<$<### # ! ##"# #$  CC5 9 %D< ~.Hm ( #C\JJLLa"!! "!! +,4IKE-r!rrz /templates/cxURS5nU(a [U-O[nURS5nURS5nUHnUR[R:XdM#UR UR 5(a[RUlMZU(a7UR UR 5(a[RUlMU(a7UR UR 5(a[RUlM[RUlM g)zKRe-calculate which files are excluded, based on the patterns in the config. exclude_docs draft_docs not_in_navN) rd_default_excludersrr= match_filerDr<r&r2r>)rFrexcludedrafts nav_excluder\s rset_exclusionsrOs7=zz.7QG,3(9IG6>^55 5!!$,,//!/!8!8F--dll;;!/!5!5!7!7 !E!E!/!:!:!/!8!8r!c /n/n[R"USSS9Hup4n[RRX0S5nUR 5 UR [ S9 0nUH|n[ [RRXh5USUSUS5n URU RU 5n XLaURX45 URU 5 U n M~ M [X5 UHupU RR5(acU RR5(a0[RSU R SU R S 35 UR#U 5 MUR#U 5 M ['U5$![$a Mf=f![$a Mf=f) z2Walk the `docs_dir` and return a Files collection.docs_dirT) followlinkskeyrrz Excluding 'z+' from the site because it conflicts with 'z'.)rwalkrVrelpathsort_file_sort_keyrr setdefaultrrkrOrsr'r*warningrDrprorA) rrFconflicting_files source_dirdirnames filenames relative_dir files_by_destrr\ prev_fileabs r get_filesrd"sE13+-776*3ESW+X' iwwz*3EF  >*)+ !H \4z"z"+, D&00EI$!(()):; LL I" ,Y(5!! ;; " " $ ${{&&(( !!)),WXYXaXaWbbde  Q  Q" <     s$1F%F6% F32F36 GGc[UR5RnU(dgUSSURS:gUS4$)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)rrDpartsr)rGrfs r file_sort_keyrgOs> !)) $ * *E  #2J')59 55r!cP[RRU5SS;U4$)zaAlways sort `index` or `README` as first filename in list. This works only on basenames of files.r)rr)rrVr)rGs rrXrX[s' GG  Q  "*= =q AAr!c[U[S9$)rrS)sortedrX)r^s r _sort_filesrk`s ) 00r!c[R"S[5 UHhnURS5(a U(dM"UR S5(aUOUn[ R "XTR S55(dMh g g)NzD_filter_paths is not used since MkDocs 1.5 and will be removed soon.rTF)rhrirjr; startswithrstrip)rrVis_dirrLitemmatchs r _filter_pathsrresj MMNPb ==  f ,,( ??5**S/ 2 2 r!)rFrrrrr)rrrrA)rGr)rGr)r^ Iterable[str]rz list[str]) rrrVrrorrLrsrr)5 __future__renumrloggingrrr-rh functoolsrpathlibrrtypingrrr r r r r urllib.parserrpathspecpathspec.gitignore pathspec.utilmkdocsrjinja2.environmentjinja2mkdocs.config.defaultsrmkdocs.structure.pagesr getLoggerr8r*EnumrrAr gitignore GitIgnoreSpec from_linesrJrOrdrgrXrkrrrr!rrs"   %+[[[*3+!3TYY3>t7t7nT-T-n %%33>>m?TU9&*Z 6B 1 r!