o yAfX @sdZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z ddl mZddlmZddlmZmZmZm Z mZmZm Z mZmZmZmZmZmZmZmZddlmZej d krhee!ee!fZ"nee!efZ"ed e"d Z# d d ej$ej%fDZ& iZ' dej(de!fddZ)de ee*efde!deee+ee*ffddZ, dIde ede e!dee+dee!dffddZ-de edeee*effddZ.dede+fddZ/  dJd e"d!eee0gdfd"ee+ded#fd$d%Z1d&e!d'e!d(ee!e!fd!ee0gdfd"e+ded#f d)d*Z2  dJd e"d!eee0gdfd"ee+dee!fd+d,Z3dJd-d.Z4d/e!deegeffd0d1Z5de ede!de+fd2d3Z6de ede e!dee!fd4d5Z7 dIde"d6ee e!de!fd7d8Z8 dIde e"d6ee e!dee!ee"ffd9d:Z9 dId/e!d;eegefdZ:Gd?d@d@e;ZGdGdde?Z@GdHd#d#e?ZAdS)KzC This module provides utility methods for dealing with path-specs. N) CollectionIterable) dataclass)PathLike)AnyAnyStrCallablerDictGenericrIteratorListOptionalSequenceSetTupleTypeVarUnion)Pattern) TStrPath)boundcCsg|] }|r |tjkr|qS) posixpathsep).0Z__seprr2/usr/lib/python3.10/site-packages/pathspec/util.py 1s rpathreturncCst|}|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)rstr_pathrrrappend_dir_sepDs  r%patternsfilecCs@d}d}|D]\}}|jdur||dur|j}|}q||fS)a Check the file against the patterns. *patterns* (:class:`~collections.abc.Iterable`) yields each indexed pattern (:class:`tuple`) which contains the pattern index (:class:`int`) and actual pattern (:class:`~pathspec.pattern.Pattern`). *file* (:class:`str`) is the normalized file path to be matched against *patterns*. Returns a :class:`tuple` containing whether to include *file* (:class:`bool` or :data:`None`), and the index of the last matched pattern (:class:`int` or :data:`None`). Ninclude match_file)r&r'Z out_includeZ out_indexindexpatternrrrcheck_match_fileVs r-files all_matches MatchDetailc Cst|tr|nt|}i}|D];}|jdurJ||}|jrB|D] }||vr9|r1||j|q |||jd<q t|g||<q q|D]}||=qDq|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:`bool` 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) isinstanceCollectionTypelistr)matchr&appendr0) r&r.r/ all_files return_filesr,Z result_filesZ result_filer'rrrdetailed_match_filesrs"   r8cCsddt|DS)a& Filters out null-patterns. *patterns* (:class:`Iterable` of :class:`.Pattern`) contains the patterns. Returns a :class:`list` containing each indexed pattern (:class:`tuple`) which contains the pattern index (:class:`int`) and the actual pattern (:class:`~pathspec.pattern.Pattern`). cSs"g|] \}}|jdur||fqSNr))rZ__index__patrrrrs  z*_filter_check_patterns..) enumerater&rrr_filter_check_patternss r>valuecCst|to t|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`). )r1 IterableTyper!bytes)r?rrr _is_iterablesrBrooton_error follow_links TreeEntryccsP|durt|std|d|durd}ttj|di||EdHdS)a Walks the specified directory for all files and directories. *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`. 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: is not callable.T)callable TypeError_iter_tree_entries_nextr#rabspathrCrDrErrriter_tree_entriess "rN root_fulldir_relmemoc csztj||}tj|}||vr|||<n t||||dt|}|D]}tj||j} z|jdd} WntyT} z|durJ|| WYd} ~ q(d} ~ ww| rzz|} Wntyy} z|duro|| WYd} ~ q(d} ~ ww| } |j |drt |j| | | Vt || |||EdHq(| s| rt |j| | | Vq(Wdn1swY||=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)r#rjoinrealpathRecursionErrorscandirnamestatOSError is_symlinkr"rFrKis_file) rOrPrQrDrEZdir_fullZdir_realZ scan_iterZnode_entZnode_relZ node_lstate node_statrrrrKsH        (rKccs,t|||dD] }||s|jVqdS)a Walks the specified directory for all files. *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`. Raises :exc:`RecursionError` if recursion is detected. Returns an :class:`~collections.abc.Iterator` yielding the path to each file (:class:`str`) relative to *root*. rDrEN)rNr"r)rCrDrEentryrrriter_tree_files3s  rccCstjdtddt|||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. stacklevelra)warningswarnDeprecationWarningrcrMrrr iter_treeRs rjrZcCst|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)rZrrrlookup_pattern]s rlcCs0d}|D]}|jdur||dur|j}q|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`. FNr()r&r'Zmatchedr,rrrr*is  r*cCsRtjtdtdtdddd|D}t}|D] }t||r&||q|S)a DEPRECATED: This is an old function no longer used. Use the :func:`~pathspec.util.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`). z".match_files() is deprecated. Use z-.match_file() with a loop for better results.rdrecSsg|] }|jdur|qSr9r:)rr;rrrrszmatch_files..)rgrh__name__risetr*add)r&r.Z use_patternsr7r'rrr match_files}s  rp separatorscCsb|durt}t|}|D] }||tj}q |dr$|dd}|S|dr/|dd}|S)ay Normalizes the file path to use the POSIX path separator (i.e., ``"/"``), and make the paths relative (remove leading ``"/"``). *file* (:class:`str` or :class:`os.PathLike`) is the file path. *separators* (:class:`~collections.abc.Collection` of :class:`str`; or ``None``) optionally contains the path separators to normalize. This does not need to include the POSIX path separator (``"/"``), but including it will not affect the results. Default is ``None`` for ``NORMALIZE_PATH_SEPS``. To prevent normalization, pass an empty container (e.g., an empty tuple ``()``). Returns the normalized file path (:class:`str`). N/rz./rd)NORMALIZE_PATH_SEPSr#fspathreplacerr startswith)r'rq norm_filerrrrnormalize_files    rxcCsPtjdtddi}|D]}t||d}||vr |||q |g||<q |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`) 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`). z_util.normalize_files() is deprecated. Use util.normalize_file() with a loop for better results.rdre)rq)rgrhrirxr5)r.rqZ norm_filesrrwrrrnormalize_filess  rypattern_factoryoverridecCsXt|ts td|dt|std|d|tvr&|s&t|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:rGN)r1r!rJrIrkAlreadyRegisteredError)rZrzr{rrrregister_patterns   r}csxeZdZdZdedeegefddffdd Ze defdd Z e defd d Z e deegeffd d Z Z S)r|z| The :exc:`AlreadyRegisteredError` exception is raised when a pattern factory is registered under a name already in use. rZrzr Ncstt|||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)superr|__init__)selfrZrz __class__rrrs zAlreadyRegisteredError.__init__cCsdj|j|jdS)4 *message* (:class:`str`) is the error message. zG{name!r} is already registered for pattern factory:{pattern_factory!r}.)rZrz)formatrZrzrrrrmessage szAlreadyRegisteredError.messagecC |jdS)zB *name* (:class:`str`) is the name of the registered pattern. rargsrrrrrZ*s zAlreadyRegisteredError.namecCr)za *pattern_factory* (:class:`~collections.abc.Callable`) is the registered pattern factory. rrrrrrrz1 z&AlreadyRegisteredError.pattern_factory)rm __module__ __qualname____doc__r!rrrrpropertyrrZrz __classcell__rrrrr| s  "r|cszeZdZdZdedededdffdd Zedefd d Zedefd d Zedefd dZ edefddZ Z S)rXzN The :exc:`RecursionError` exception is raised when recursion is detected. rRrSrTr Ncstt||||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)r~rXr)rrRrSrTrrrr@szRecursionError.__init__cCr)zx *first_path* (:class:`str`) is the first path encountered for :attr:`self.real_path `. rrrrrrrSTrzRecursionError.first_pathcCsdj|j|j|jdS)rzDReal path {real!r} was encountered at {first!r} and then {second!r}.)realfirstsecond)rrRrSrTrrrrr\s zRecursionError.messagecCr)zV *real_path* (:class:`str`) is the real path that recursion was encountered on. rrrrrrrRgrzRecursionError.real_pathcCr)zz *second_path* (:class:`str`) is the second path encountered for :attr:`self.real_path `. rdrrrrrrTorzRecursionError.second_path) rmrrrr!rrrSrrRrTrrrrrrX:s& rXT)frozenc@s:eZdZUdZdZeed< eeed< ee ed<dS) CheckResultze The :class:`CheckResult` class contains information about the file and which pattern matched it. )r'r)r+r'r)r+N) rmrrr __slots__r__annotations__r boolintrrrrrxs   rc@s*eZdZdZdZdeeddfddZdS)r0z> The :class:`.MatchDetail` class contains information about r=r&r NcCs ||_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. Nr=)rr&rrrrs zMatchDetail.__init__)rmrrrrrrrrrrrr0sc @seZdZdZdZdededejdejddf d d Zdd e e de fd d Z dd e e de fddZ de fddZ dd e e dejfddZdS)rFzR The :class:`.TreeEntry` class contains information about a file-system entry. _lstatrZr_statrZrlstatr[r NcCs"||_ ||_ ||_ ||_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. Nr)rrZrrr[rrrrszTreeEntry.__init__rEcC(|durd}|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)rrr[S_ISDIRst_moderrEr`rrrr"  zTreeEntry.is_dircCr)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)rrr[S_ISREGrrrrrr^rzTreeEntry.is_filecCst|jjS)zC Returns whether the entry is a symbolic link (:class:`bool`). )r[S_ISLNKrrrrrrr]szTreeEntry.is_symlinkcCs|durd}|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)rr)rrErrrr[ s zTreeEntry.statr9)rmrrrrr!r# stat_resultrr rr"r^r]r[rrrrrFs$ +r9)NN)Brr#Zos.pathpathlibrr[sysrgcollections.abcrr2rr@ dataclassesrrtypingrrrr r r r r rrrrrr,r version_infor!ZStrPathrraltseprsrkPathr%rrr-r8r>rBr\rNrKrcrjrlr*rprxryr} Exceptionr|rXrobjectr0rFrrrrs  D        .   #   S    #  *  (   />