+ ri/;Rt^RIHt^RIHtHtHtHt^RIH t ^RI H t H t H t HtHt] !RRR7t^RIHt^R IHtHt^R IHt^R IHt^R IHtHt^R IHtHtH t H!t!H"t"H#t#!RR]$4t%R#)zn This module provides :class:`.PathSpec` which is an object-oriented interface for pattern matching of files. ) annotations) CollectionIterableIteratorSequence) zip_longest)CallableOptionalTypeVarUnioncastSelfPathSpec)bound)util)_BackendBackendNamesHintmake_pathspec_backend)Pattern)AnyStr deprecated) CheckResultStrPathTStrPath TreeEntry _is_iterablenormalize_filec\]tRt^/tRtRRRR/RRlltRRltR R ltR R ltR Rlt R(RRllt R(RRllt R)RRllt ] RRRR/RRll4t]RRl4tR(RR/RRllltR(RRlltR(RR/RRllltR)RR/R R!lllt]!R"4R#R$l4tR)RR/R%R&llltR'tR#)*rza The :class:`PathSpec` class is a wrapper around a list of compiled :class:`.Pattern` instances. backendN_test_backend_factoryc(V^8dQhRRRRRRRR/#) patternsz+Union[Sequence[Pattern], Iterable[Pattern]]r"Union[BackendNamesHint, str, None]r 1Optional[Callable[[Sequence[Pattern]], _Backend]]returnNone)formats"3/usr/lib/python3/dist-packages/pathspec/pathspec.py __annotate__PathSpec.__annotate__5s3.. 7. . . K .  .c \V\4'g \V4pVfRp\\V4pVe V!V4pMVP W!4pW@nW nWnR#)a Initializes the :class:`.PathSpec` instance. *patterns* (:class:`~collections.abc.Sequence` or :class:`~collections.abc.Iterable`) contains each compiled pattern (:class:`.Pattern`). If not a sequence, it will be converted to a :class:`list`. *backend* (:class:`str` or :data:`None`) is the pattern (regular expression) matching backend to use. Default is :data:`None` for "best" to use the best available backend. Priority of backends is: "re2", "hyperscan", "simple". The "simple" backend is always available. Nbest) isinstancerlistr r _make_backend_backend _backend_namer#)selfr#rr use_backends&&$$ r*__init__PathSpec.__init__5st& Hh ' '8n8 _ 7 !7 +'&&x0;##G6;'- *1&.-r-c$V^8dQhRRRRRR/#r"r5r otherrr&r()r)s"r*r+r,es!4Tr-c \V\4'd9VPVPVP,VPR7#\ #)zh Combines the :attr:`self.patterns <.PathSpec.patterns>` patterns from two :class:`PathSpec` instances. )r)r0r __class__r#r4NotImplementedr5r;s&&r*__add__PathSpec.__add__es= x  ..7ASAS. TT r-c V^8dQhRRRR/#)r"r;objectr&boolr()r)s"r*r+r,os   D r-c \V\4'dU\VPVP4p\;QJdRV4F 'dK R# R#!RV44#\ #)z Tests the equality of this path-spec with *other* (:class:`PathSpec`) by comparing their :attr:`self.patterns <.PathSpec.patterns>` attributes. c3."TF wrW8HxK R#5iNr().0abs& r* "PathSpec.__eq__..vs 1afsFT)r0rrr#allr>)r5r;paired_patternss&& r*__eq__PathSpec.__eq__osT x   ?? # 1 1##1#1# 1 1 11 r-c$V^8dQhRRRRRR/#r:r()r)s"r*r+r,zs!  D  d r-c \V\4'dQV;PVP, unVPVPVP4VnV#\ #)zh Adds the :attr:`self.patterns <.PathSpec.patterns>` from *other* (:class:`PathSpec`) to this instance. )r0rr#r2r4r3r>r?s&&r*__iadd__PathSpec.__iadd__zsL x  ==ENN"=%%d&8&8$--H4= ; r-cV^8dQhRR/#)r"r&intr()r)s"r*r+r,scr-c ,\VP4#)zj Returns the number of :attr:`self.patterns <.PathSpec.patterns>` this path-spec contains (:class:`int`). )lenr#)r5s&r*__len__PathSpec.__len__s T]] r-c$V^8dQhRRRRRR/#)r"filer separatorsOptional[Collection[str]]r&zCheckResult[TStrPath]r()r)s"r*r+r,s(+++(+ +r-c j\W4pVPPV4wrE\WV4#)a Check the files against this path-spec. *file* (:class:`str` or :class:`os.PathLike`) is the file path to be matched against :attr:`self.patterns <.PathSpec.patterns>`. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or :data:`None`) optionally contains the path separators to normalize. See :func:`.normalize_file` for more information. Returns the file check result (:class:`.CheckResult`). )rr3 match_filer)r5r\r] norm_fileincludeindexs&&& r* check_filePathSpec.check_files1"T.)==++I6.' TE **r-c$V^8dQhRRRRRR/#)r"fileszIterable[TStrPath]r]r^r&zIterator[CheckResult[TStrPath]]r()r)s"r*r+r,s(00 0(0& 0r-c# "\V4'g\RV: R24hVF9p\W24pVPP V4wrV\ W5V4xK; R#5i)a Check the files against this path-spec. *files* (:class:`~collections.abc.Iterable` of :class:`str` or :class:`os.PathLike`) contains the file paths to be checked against :attr:`self.patterns <.PathSpec.patterns>`. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or :data:`None`) optionally contains the path separators to normalize. See :func:`.normalize_file` for more information. Returns an :class:`~collections.abc.Iterator` yielding each file check result (:class:`.CheckResult`). files: is not an iterable.N)r TypeErrorrr3r`r)r5rgr] orig_filerarbrcs&&& r* check_filesPathSpec.check_filess^& e   VE9$89 ::ii49MM,,Y7>7 Y //sA#A%c(V^8dQhRRRRRRRR/#) r"rootron_error#Optional[Callable[[OSError], None]] follow_linksOptional[bool]r&zIterator[CheckResult[str]]r()r)s"r*r+r,s2%%% 0% % ! %r-c# t"\P!WVR7pVPV4RjxL R#L5i)a Walks the specified root path for all files and checks them against this path-spec. *root* (:class:`str` or :class:`os.PathLike`) is the root directory to search for files. *on_error* (:class:`~collections.abc.Callable` or :data:`None`) optionally is the error handler for file-system exceptions. It will be called with the exception (:exc:`OSError`). Reraise the exception to abort the walk. Default is :data:`None` to ignore file-system exceptions. *follow_links* (:class:`bool` or :data:`None`) optionally is whether to walk symbolic links that resolve to directories. Default is :data:`None` for :data:`True`. *negate* (:class:`bool` or :data:`None`) is whether to negate the match results of the patterns. If :data:`True`, a pattern matching a file will exclude the file rather than include it. Default is :data:`None` for :data:`False`. Returns an :class:`~collections.abc.Iterator` yielding each file check result (:class:`.CheckResult`). rqrsN)riter_tree_filesrm)r5rprqrsrgs&&&& r*check_tree_filesPathSpec.check_tree_filess-<   t\ R%   e $$$s -868c 0V^8dQhRRRRRRRRR R R R /#) r"clsz type[Self]pattern_factoryz'Union[str, Callable[[AnyStr], Pattern]]lineszIterable[AnyStr]rr$r r%r&r r()r)s"r*r+r,sM&U&U&U:&U &U . &U K &U &Ur-c <\V\4'd\P!V4p\ V4'g\ RV: R24h\ V4'g\ RV: R24hVUu.uFqU'gK V!V4NK ppV!WcVR7#uupi)ad Compiles the pattern lines. *pattern_factory* can be either the name of a registered pattern factory (:class:`str`), or a :class:`~collections.abc.Callable` used to compile patterns. It must accept an uncompiled pattern (:class:`str`) and return the compiled pattern (:class:`.Pattern`). *lines* (:class:`~collections.abc.Iterable`) yields each uncompiled pattern (:class:`str`). This simply has to yield each line so that it can be a :class:`io.TextIOBase` (e.g., from :func:`open` or :class:`io.StringIO`) or the result from :meth:`str.splitlines`. *backend* (:class:`str` or :data:`None`) is the pattern (or regular expression) matching backend to use. Default is :data:`None` for "best" to use the best available backend. Priority of backends is: "re2", "hyperscan", "simple". The "simple" backend is always available. Returns the :class:`PathSpec` instance. zpattern_factory:z is not callable.zlines:rj)rr )r0strrlookup_patterncallablerkr)r{r|r}rr liner#s&&&$$ r* from_linesPathSpec.from_liness:%%((9? / " " %o%88IJ KK e   VE9$89 ::05 >#od#( > X>S TT?s 3 B Bc$V^8dQhRRRRRR/#)r"namerr#zSequence[Pattern]r&rr()r)s"r*r+r,s&/// //r-c \W4#)aD .. warning:: This method is not part of the public API. It is subject to change. Create the backend for the patterns. *name* (:class:`str`) is the name of the backend. *patterns* (:class:`~collections.abc.Sequence` of :class:`.Pattern`) contains the compiled patterns. Returns the matcher (:class:`._Backend`). r)rr#s&&r*r2PathSpec._make_backends$ t ..r-negatec(V^8dQhRRRRRRRR/#) r"entrieszIterable[TreeEntry]r]r^rrtr&Iterator[TreeEntry]r()r)s"r*r+r,s2$$ $($  $  $r-c# "\V4'g\RV: R24hVFSp\VPV4pVPP V4wrgV'dV'*pV'gKOVxKU R#5i)a Matches the entries to this path-spec. *entries* (:class:`~collections.abc.Iterable` of :class:`.TreeEntry`) contains the entries to be matched against :attr:`self.patterns <.PathSpec.patterns>`. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or :data:`None`) optionally contains the path separators to normalize. See :func:`.normalize_file` for more information. *negate* (:class:`bool` or :data:`None`) is whether to negate the match results of the patterns. If :data:`True`, a pattern matching a file will exclude the file rather than include it. Default is :data:`None` for :data:`False`. Returns the matched entries (:class:`~collections.abc.Iterator` of :class:`.TreeEntry`). zentries:rjN)rrkrpathr3r`)r5rr]rentryrarb_indexs&&&$ r* match_entriesPathSpec.match_entriessk2 g   Xg[(<= >>eejj*59]]--i8?7 kG g Ks A.A?5 A?c$V^8dQhRRRRRR/#)r"r\rr]r^r&rDr()r)s"r*r+r,As(( r-c h\W4pVPPV4wrE\V4#)a Matches the file to this path-spec. *file* (:class:`str` or :class:`os.PathLike`) is the file path to be matched against :attr:`self.patterns <.PathSpec.patterns>`. *separators* (:class:`~collections.abc.Collection` of :class:`str`) optionally contains the path separators to normalize. See :func:`.normalize_file` for more information. Returns :data:`True` if *file* matched; otherwise, :data:`False`. )rr3r`rD)r5r\r]rarbrs&&& r*r`PathSpec.match_fileAs."T.)MM,,Y7/' gr-c(V^8dQhRRRRRRRR/#) r"rgzIterable[StrPath]r]r^rrtr&zIterator[StrPath]r()r)s"r*r+r,Vs2%% %(%  %  %r-c# "\V4'g\RV: R24hVFHp\WB4pVPP V4wrgV'dV'*pV'gKDVxKJ R#5i)a Matches the files to this path-spec. *files* (:class:`~collections.abc.Iterable` of :class:`str` or :class:`os.PathLike`) contains the file paths to be matched against :attr:`self.patterns <.PathSpec.patterns>`. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or :data:`None`) optionally contains the path separators to normalize. See :func:`.normalize_file` for more information. *negate* (:class:`bool` or :data:`None`) is whether to negate the match results of the patterns. If :data:`True`, a pattern matching a file will exclude the file rather than include it. Default is :data:`None` for :data:`False`. Returns the matched files (:class:`~collections.abc.Iterator` of :class:`str` or :class:`os.PathLike`). rirjN)rrkrr3r`)r5rgr]rrlrarbrs&&&$ r* match_filesPathSpec.match_filesVse4 e   VE9$89 ::ii49]]--i8?7 kG g Os A#A4* A4c ,V^8dQhRRRRRRRRRR /#) r"rprrqrrrsrtrr&rr()r)s"r*r+r,}s<!8!8!8 0!8 !8  !8!8r-c# v"\P!WVR7pVPWTR7RjxL R#L5i)a Walks the specified root path for all files and matches them to this path-spec. *root* (:class:`str` or :class:`os.PathLike`) is the root directory to search. *on_error* (:class:`~collections.abc.Callable` or :data:`None`) optionally is the error handler for file-system exceptions. It will be called with the exception (:exc:`OSError`). Reraise the exception to abort the walk. Default is :data:`None` to ignore file-system exceptions. *follow_links* (:class:`bool` or :data:`None`) optionally is whether to walk symbolic links that resolve to directories. Default is :data:`None` for :data:`True`. *negate* (:class:`bool` or :data:`None`) is whether to negate the match results of the patterns. If :data:`True`, a pattern matching a file will exclude the file rather than include it. Default is :data:`None` for :data:`False`. Returns the matched files (:class:`~collections.abc.Iterator` of :class:`.TreeEntry`). rvrN)riter_tree_entriesr)r5rprqrsrrs&&&&$ r*match_tree_entriesPathSpec.match_tree_entries}s1@  " "4 V'     777 .979zEPathSpec.match_tree() is deprecated. Use .match_tree_files() instead.cV^8dQhRR/#)r"r& Iterator[str]r()r)s"r*r+r,s,,m,r-c &VP!V/VB#)z .. version-deprecated:: 0.3.2 This is an alias for the :meth:`self.match_tree_files <.PathSpec.match_tree_files>` method. )match_tree_files)r5argskws&*,r* match_treePathSpec.match_trees    + ++r-c ,V^8dQhRRRRRRRRRR /#) r"rprrqrrrsrtrr&rr()r)s"r*r+r,s< 4 4 4 0 4 4  4 4r-c# v"\P!WVR7pVPWTR7RjxL R#L5i)a Walks the specified root path for all files and matches them to this path-spec. *root* (:class:`str` or :class:`os.PathLike`) is the root directory to search for files. *on_error* (:class:`~collections.abc.Callable` or :data:`None`) optionally is the error handler for file-system exceptions. It will be called with the exception (:exc:`OSError`). Reraise the exception to abort the walk. Default is :data:`None` to ignore file-system exceptions. *follow_links* (:class:`bool` or :data:`None`) optionally is whether to walk symbolic links that resolve to directories. Default is :data:`None` for :data:`True`. *negate* (:class:`bool` or :data:`None`) is whether to negate the match results of the patterns. If :data:`True`, a pattern matching a file will exclude the file rather than include it. Default is :data:`None` for :data:`False`. Returns the matched files (:class:`~collections.abc.Iterable` of :class:`str`). rvrN)rrwr)r5rprqrsrrgs&&&&$ r*rPathSpec.match_tree_filess0>   t\ R%   e  333r)r3r4r#rG)NN)__name__ __module__ __qualname____firstlineno____doc__r7r@rOrSrYrdrmrx classmethodr staticmethodr2rr`rrrrr__static_attributes__r(r-r*rr/s .15 . NR .`  +*06%B&U 15 &U NR &U&UP//&$  $$L*%  %%N!8  !8!8H I,, 4  4 4r-N)&r __future__rcollections.abcrrrr itertoolsrtypingrr r r r r pathspecrpathspec.backendrrpathspec._backends.aggrpathspec.patternrpathspec._typingrr pathspec.utilrrrrrrrCrr(r-r*rsl#  vZ(   ]4v]4r-