B Khh1O@sdZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z ddlm Z ddlmZmZmZm Z mZm Z mZmZmZmZmZmZddlmZejdkreee efZn eee fZd d ejejgDZ iZ!ej"ed d d Z#d;e ee eee$eedfdddZ%e eeedddZ&ee$dddZ'dd!d"Z+eeegefd#d$d%Z,e eee$d&d'd(Z-e ee eeed)d*d+Z.d?eee eed,d-d.Z/d@e eee eeeeefd/d0d1Z0dAeeegefee$dd2d3d4Z1Gd5d6d6e2Z3Gd7d8d8e2Z4Gd9dde5Z6Gd:dde5Z7dS)BzC This module provides utility methods for dealing with path-specs. N) CollectionIterable)PathLike) AnyAnyStrCallablerDictrIteratorListOptionalSequenceSetUnion)Pattern) cCsg|]}|r|tjkr|qS) posixpathsep).0Z__seprr3/tmp/pip-install-vv81h98y/pathspec/pathspec/util.py (sr)pathreturncCst|}|r|tj7}|S)a5 Appends the path separator to the path if the path is a directory. This can be used to aid in distinguishing between directories and files on the file-system by relying on the presence of a trailing path separator. *path* (:class:`pathlib.path`) is the path to use. Returns the path (:class:`str`). )stris_dirosr)rZstr_pathrrrappend_dir_sep:s  r MatchDetail)patternsfiles all_matchesrc Cst|tr|nt|}i}x|D]~}|jdk r ||}|jrx^|D]@}||krv|rf||j|q|||jd<qDt|g||<qDWq x|D] }||=qWq W|S)a Matches the files to the patterns, and returns which patterns matched the files. *patterns* (:class:`~collections.abc.Iterable` of :class:`~pathspec.pattern.Pattern`) contains the patterns to use. *files* (:class:`~collections.abc.Iterable` of :class:`str`) contains the normalized file paths to be matched against *patterns*. *all_matches* (:class:`boot` or :data:`None`) is whether to return all matches patterns (:data:`True`), or only the last matched pattern (:data:`False`). Default is :data:`None` for :data:`False`. Returns the matched files (:class:`dict`) which maps each matched file (:class:`str`) to the patterns that matched in order (:class:`.MatchDetail`). Nr) isinstanceCollectionTypelistincludematchr appendr) r r!r"Z all_files return_filespatternZ result_filesZ result_filefilerrrdetailed_match_filesLs     r,)r rcCsdd|DS)z Filters out null-patterns. *patterns* (:class:`Iterable` of :class:`.Pattern`) contains the patterns. Returns the patterns (:class:`list` of :class:`.Pattern`). cSsg|]}|jdk r|qS)N)r&)rZ__patrrrrsz$_filter_patterns..r)r rrr_filter_patternszs r-)valuercCst|tot|ttf S)z Check whether the value is an iterable (excludes strings). *value* is the value to check, Returns whether *value* is a iterable (:class:`bool`). )r# IterableTyperbytes)r.rrr _is_iterablesr1 TreeEntry)rooton_error follow_linksrccsN|dk r t|s td|d|dkr,d}ttj|di||EdHdS)a Walks the specified directory for all files and directories. *root* (:class:`str` or :class:`os.PathLike[str]`) 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`. Raises :exc:`RecursionError` if recursion is detected. Returns an :class:`~collections.abc.Iterator` yielding each file or directory entry (:class:`.TreeEntry`) relative to *root*. Nz on_error:z is not callable.T)callable TypeError_iter_tree_entries_nextrrabspath)r3r4r5rrriter_tree_entriess r;) root_fulldir_relmemor4r5rc csttj||}tj|}||kr,|||<nt||||dt|}x|D]}tj||j} y|jdd} Wn4tk r} z|dk r|| wTWdd} ~ XYnX| ry |} Wn4tk r} z|dk r|| wTWdd} ~ XYnXn| } |j |dr8t |j| | | Vt || |||EdHqT| sJ| rTt |j| | | VqTWWdQRX||=dS)aq Scan the directory for all descendant files. *root_full* (:class:`str`) the absolute path to the root directory. *dir_rel* (:class:`str`) the path to the directory to scan relative to *root_full*. *memo* (:class:`dict`) keeps track of ancestor directories encountered. Maps each ancestor real path (:class:`str`) to relative path (:class:`str`). *on_error* (:class:`~collections.abc.Callable` or :data:`None`) optionally is the error handler for file-system exceptions. *follow_links* (:class:`bool`) is whether to walk symbolic links that resolve to directories. Yields each entry (:class:`.TreeEntry`). ) real_path first_path second_pathF)follow_symlinksN)rrjoinrealpathRecursionErrorscandirnamestatOSError is_symlinkrr2r9is_file) r<r=r>r4r5Zdir_fullZdir_realZ scan_iterZnode_entZnode_relZ node_lstate node_statrrrr9s8    r9ccs.x(t|||dD]}||s|jVqWdS)a Walks the specified directory for all files. *root* (:class:`str` or :class:`os.PathLike[str]`) 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`. Raises :exc:`RecursionError` if recursion is detected. Returns an :class:`~collections.abc.Iterator` yielding the path to each file (:class:`str`) relative to *root*. )r4r5N)r;rr)r3r4r5entryrrriter_tree_files s rOcCstjdtddt|||dS)zg DEPRECATED: The :func:`.iter_tree` function is an alias for the :func:`.iter_tree_files` function. zCutil.iter_tree() is deprecated. Use util.iter_tree_files() instead.) stacklevel)r4r5)warningswarnDeprecationWarningrO)r3r4r5rrr iter_tree(s rU)rGrcCst|S)z Lookups a registered pattern factory by name. *name* (:class:`str`) is the name of the pattern factory. Returns the registered pattern factory (:class:`~collections.abc.Callable`). If no pattern factory is registered, raises :exc:`KeyError`. )_registered_patterns)rGrrrlookup_pattern3s rW)r r+rcCs4d}x*|D]"}|jdk r ||dk r |j}q W|S)a7 Matches the file to the patterns. *patterns* (:class:`~collections.abc.Iterable` of :class:`~pathspec.pattern.Pattern`) contains the patterns to use. *file* (:class:`str`) is the normalized file path to be matched against *patterns*. Returns :data:`True` if *file* matched; otherwise, :data:`False`. FN)r& match_file)r r+matchedr*rrrrX?s    rX)r r!rcCsDtjdtddt|}t}x |D]}t||r$||q$W|S)a DEPRECATED: This is an old function no longer used. Use the :func:`.match_file` function with a loop for better results. Matches the files to the patterns. *patterns* (:class:`~collections.abc.Iterable` of :class:`~pathspec.pattern.Pattern`) contains the patterns to use. *files* (:class:`~collections.abc.Iterable` of :class:`str`) contains the normalized file paths to be matched against *patterns*. Returns the matched files (:class:`set` of :class:`str`). zWutil.match_files() is deprecated. Use util.match_file() with a loop for better results.rP)rQ)rRrSrTr-setrXadd)r r!Z use_patternsr)r+rrr match_filesTs   r\)r+ separatorsrcCsd|dkr t}t|}x|D]}||tj}qW|drJ|dd}n|dr`|dd}|S)a Normalizes the file path to use the POSIX path separator (i.e., :data:`'/'`), and make the paths relative (remove leading :data:`'/'`). *file* (:class:`str` or :class:`os.PathLike[str]`) is the file path. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or :data:`None`) optionally contains the path separators to normalize. This does not need to include the POSIX path separator (:data:`'/'`), but including it will not affect the results. Default is :data:`None` for :data:`NORMALIZE_PATH_SEPS`. To prevent normalization, pass an empty container (e.g., an empty tuple :data:`()`). Returns the normalized file path (:class:`str`). N/rz./rP)NORMALIZE_PATH_SEPSrfspathreplacerr startswith)r+r] norm_filerrrrnormalize_fileus     rd)r!r]rcCsTtjdtddi}x:|D]2}t||d}||krB|||q|g||<qW|S)a DEPRECATED: This function is no longer used. Use the :func:`.normalize_file` function with a loop for better results. Normalizes the file paths to use the POSIX path separator. *files* (:class:`~collections.abc.Iterable` of :class:`str` or :class:`os.PathLike[str]`) contains the file paths to be normalized. *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 a :class:`dict` mapping each normalized file path (:class:`str`) to the original file paths (:class:`list` of :class:`str` or :class:`os.PathLike[str]`). z_util.normalize_files() is deprecated. Use util.normalize_file() with a loop for better results.rP)rQ)r])rRrSrTrdr()r!r]Z norm_filesrrcrrrnormalize_filess   re)rGpattern_factoryoverridercCsXt|tstd|dt|s2td|d|tkrL|sLt|t||t|<dS)aE Registers the specified pattern factory. *name* (:class:`str`) is the name to register the pattern factory under. *pattern_factory* (:class:`~collections.abc.Callable`) is used to compile patterns. It must accept an uncompiled pattern (:class:`str`) and return the compiled pattern (:class:`.Pattern`). *override* (:class:`bool` or :data:`None`) optionally is whether to allow overriding an already registered pattern under the same name (:data:`True`), instead of raising an :exc:`AlreadyRegisteredError` (:data:`False`). Default is :data:`None` for :data:`False`. zname:z is not a string.zpattern_factory:z is not callable.N)r#rr8r7rVAlreadyRegisteredError)rGrfrgrrrregister_patterns  ricsteZdZdZeeegefddfdd Ze edddZ e edd d Z e eegefdd d Z Z S) rhz| The :exc:`AlreadyRegisteredError` exception is raised when a pattern factory is registered under a name already in use. N)rGrfrcstt|||dS)z Initializes the :exc:`AlreadyRegisteredError` instance. *name* (:class:`str`) is the name of the registered pattern. *pattern_factory* (:class:`~collections.abc.Callable`) is the registered pattern factory. N)superrh__init__)selfrGrf) __class__rrrks zAlreadyRegisteredError.__init__)rcCsdj|j|jdS)z4 *message* (:class:`str`) is the error message. zG{name!r} is already registered for pattern factory:{pattern_factory!r}.)rGrf)formatrGrf)rlrrrmessageszAlreadyRegisteredError.messagecCs |jdS)zB *name* (:class:`str`) is the name of the registered pattern. r)args)rlrrrrGszAlreadyRegisteredError.namecCs |jdS)za *pattern_factory* (:class:`~collections.abc.Callable`) is the registered pattern factory. r)rp)rlrrrrfsz&AlreadyRegisteredError.pattern_factory)__name__ __module__ __qualname____doc__rrrrrkpropertyrorGrf __classcell__rr)rmrrhs   rhcsteZdZdZeeeddfdd ZeedddZeedd d Zeedd d Z eedd dZ Z S)rEzN The :exc:`RecursionError` exception is raised when recursion is detected. N)r?r@rArcstt||||dS)a+ Initializes the :exc:`RecursionError` instance. *real_path* (:class:`str`) is the real path that recursion was encountered on. *first_path* (:class:`str`) is the first path encountered for *real_path*. *second_path* (:class:`str`) is the second path encountered for *real_path*. N)rjrErk)rlr?r@rA)rmrrrkszRecursionError.__init__)rcCs |jdS)zx *first_path* (:class:`str`) is the first path encountered for :attr:`self.real_path `. r)rp)rlrrrr@+szRecursionError.first_pathcCsdj|j|j|jdS)z4 *message* (:class:`str`) is the error message. zDReal path {real!r} was encountered at {first!r} and then {second!r}.)realfirstsecond)rnr?r@rA)rlrrrro3szRecursionError.messagecCs |jdS)zV *real_path* (:class:`str`) is the real path that recursion was encountered on. r)rp)rlrrrr?>szRecursionError.real_pathcCs |jdS)zz *second_path* (:class:`str`) is the second path encountered for :attr:`self.real_path `. rP)rp)rlrrrrAFszRecursionError.second_path) rqrrrsrtrrkrur@ror?rArvrr)rmrrEs rEc@s(eZdZdZdZeeddddZdS)rz> The :class:`.MatchDetail` class contains information about )r N)r rcCs ||_dS)z Initialize the :class:`.MatchDetail` instance. *patterns* (:class:`~collections.abc.Sequence` of :class:`~pathspec.pattern.Pattern`) contains the patterns that matched the file in the order they were encountered. N)r )rlr rrrrkWs zMatchDetail.__init__)rqrrrsrt __slots__r rrkrrrrrOsc@seZdZdZdZeeejejddddZde e e ddd Z de e e dd d Z e d d dZ de e ejdddZdS)r2zR The :class:`.TreeEntry` class contains information about a file-system entry. )_lstatrGr_statN)rGrlstatrHrcCs||_||_||_||_dS)aP Initialize the :class:`.TreeEntry` instance. *name* (:class:`str`) is the base name of the entry. *path* (:class:`str`) is the relative path of the entry. *lstat* (:class:`os.stat_result`) is the stat result of the direct entry. *stat* (:class:`os.stat_result`) is the stat result of the entry, potentially linked. N)r{rGrr|)rlrGrr}rHrrrrkqs zTreeEntry.__init__)r5rcCs(|dkr d}|r|jn|j}t|jS)a< Get whether the entry is a directory. *follow_links* (:class:`bool` or :data:`None`) is whether to follow symbolic links. If this is :data:`True`, a symlink to a directory will result in :data:`True`. Default is :data:`None` for :data:`True`. Returns whether the entry is a directory (:class:`bool`). NT)r|r{rHS_ISDIRst_mode)rlr5rMrrrrs zTreeEntry.is_dircCs(|dkr d}|r|jn|j}t|jS)aE Get whether the entry is a regular file. *follow_links* (:class:`bool` or :data:`None`) is whether to follow symbolic links. If this is :data:`True`, a symlink to a regular file will result in :data:`True`. Default is :data:`None` for :data:`True`. Returns whether the entry is a regular file (:class:`bool`). NT)r|r{rHS_ISREGr)rlr5rMrrrrKs zTreeEntry.is_file)rcCst|jjS)zC Returns whether the entry is a symbolic link (:class:`bool`). )rHS_ISLNKr{r)rlrrrrJszTreeEntry.is_symlinkcCs|dkr d}|r|jS|jS)a9 Get the cached stat result for the entry. *follow_links* (:class:`bool` or :data:`None`) is whether to follow symbolic links. If this is :data:`True`, the stat result of the linked file will be returned. Default is :data:`None` for :data:`True`. Returns that stat result (:class:`os.stat_result`). NT)r|r{)rlr5rrrrHs zTreeEntry.stat)N)N)N)rqrrrsrtrzrr stat_resultrkr boolrrKrJrHrrrrr2hs%)N)NN)NN)NN)N)N)N)8rtros.pathZpathlibrrHsysrRcollections.abcrr$rr/rtypingrrrrr r r r r rr*r version_inforZStrPathraltsepr_rVPathrrr,r-r1r;r9rOrUrWrXr\rdreri ExceptionrhrEobjectrr2rrrrsd 8    *   M   '%/>