ob=|dZddlmZmZmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZddlmZmZddlmZmZmZmZmZmZmZddlmZdd lmZdd lmZdd l m!Z!m"Z"m#Z#dd l m$Z$dd lm%Z%ejLrddlm'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5ddl6m6Z6ddl m7Z7ddl8m9Z9ddl:m;Z;ddlZ>ddl?m@Z@ddlAmBZBddlmCZCejddZEejddZFe*eFe2geBeFfZGdgZHdZIe jejGddeLZMy)zPyFilesystem base class. The filesystem base class is common to all filesystems. If you familiarize yourself with this (rather straightforward) API, you can work with any of the supported filesystems. )absolute_importprint_functionunicode_literalsN)closing)partialwraps)copyerrorsfsencodeiotoolstoolswalkwildcard)copy_modified_time BoundGlobber)validate_open_mode)abspathjoinnormpath)datetime_to_epoch)Walker)IOAnyBinaryIOCallable CollectionDictIterableIteratorListMappingOptionalTextTupleTypeUnion)datetime)RLock) TracebackType) ResourceType)InfoRawInfo) PermissionsSubFS) BoundWalker_FFS)bound_Tctfd}djj}t|dd|xj|z c_|S)z+Return a method with a deprecation warning.c|tjdjjt|i|S)Nz6method '{}' has been deprecated, please rename to '{}')warningswarnformat__name__DeprecationWarning)argskwargsmethodold_names )/usr/lib/python3/dist-packages/fs/base.py_methodz_new_name.._methodIs= D K K&//    t&v&&zR Note: .. deprecated:: 2.2.0 Please use `~{}` __doc__N)rr;r<getattrrE)r@rArCdeprecated_msgs`` rB _new_namerHEs\ 6]'' F w 4(4>) NrDcjeZdZdZiZeZdZfdZdZ dZ dZ e dZ e dZej dFd Zej d Zej dGd Zej dHd Zej d Zej dZej dZdZ dIdZdZ dJdZ dJdZdKdZdZdZ dLdZ dZ!e"e!dZ#dFdZ$e"e$dZ% dMdZ&e"e&dZ'dZ(dNd Z)d!Z*d"Z+d#Z,d$Z-dOd%Z.d&Z/dOd'Z0d(Z1d)Z2d*Z3d+Z4d,Z5d-Z6dJd.Z7 dGd/Z8dJd0Z9 dPd1Z: dFd2Z;d3Z< dQd4Z=d5Z>e"e>d6Z?dFd7Z@e"e@d8ZA dMd9ZBe"eBd:ZCdQd;ZD dId<ZEe"eEd=ZFd>ZGd?ZHd@ZIdAZJdBZKdCZLdDZMdEZNxZOS)Rr4zBase class for FS objects.Ncjd|_tj|_tt |y)zACreate a filesystem. See help(type(self)) for accurate signature.FN)_closed threadingr*_locksuperr4__init__)self __class__s rBrOz FS.__init__ms' __&  b$ "rDc$|jy)z"Auto-close the filesystem on exit.NcloserPs rB__del__z FS.__del__ts  rDc|S)z-Allow use of filesystem as a context manager.rUs rB __enter__z FS.__enter__xs  rDc$|jy)zClose filesystem on exit.NrS)rPexc_type exc_value tracebacks rB__exit__z FS.__exit__}s  rDct|S)z+`~fs.glob.BoundGlobber`: a globber object..rrUs rBglobzFS.globsD!!rDc8|jj|S)z:`~fs.walk.BoundWalker`: a walker bound to this filesystem.) walker_classbindrUs rBrzFS.walks  %%d++rDcy)aKGet information about a resource on a filesystem. Arguments: path (str): A path to a resource on the filesystem. namespaces (list, optional): Info namespaces to query. The `"basic"` namespace is alway included in the returned info, whatever the value of `namespaces` may be. Returns: ~fs.info.Info: resource information object. Raises: fs.errors.ResourceNotFound: If ``path`` does not exist. For more information regarding resource information, see :ref:`info`. NrX)rPpath namespacess rBgetinfoz FS.getinforDcy)a0Get a list of the resource names in a directory. This method will return a list of the resources in a directory. A *resource* is a file, directory, or one of the other types defined in `~fs.enums.ResourceType`. Arguments: path (str): A path to a directory on the filesystem Returns: list: list of names, relative to ``path``. Raises: fs.errors.DirectoryExpected: If ``path`` is not a directory. fs.errors.ResourceNotFound: If ``path`` does not exist. NrXrPres rBlistdirz FS.listdirrhrDcy)ahMake a directory. Arguments: path (str): Path to directory from root. permissions (~fs.permissions.Permissions, optional): a `Permissions` instance, or `None` to use default. recreate (bool): Set to `True` to avoid raising an error if the directory already exists (defaults to `False`). Returns: ~fs.subfs.SubFS: a filesystem whose root is the new directory. Raises: fs.errors.DirectoryExists: If the path already exists. fs.errors.ResourceNotFound: If the path is not found. NrX)rPre permissionsrecreates rBmakedirz FS.makedirrhrDc y)aPOpen a binary file-like object. Arguments: path (str): A path on the filesystem. mode (str): Mode to open file (must be a valid non-text mode, defaults to *r*). Since this method only opens binary files, the ``b`` in the mode string is implied. buffering (int): Buffering policy (-1 to use default buffering, 0 to disable buffering, or any positive integer to indicate a buffer size). **options: keyword arguments for any additional information required by the filesystem (if any). Returns: io.IOBase: a *file-like* object. Raises: fs.errors.FileExpected: If ``path`` exists and is not a file. fs.errors.FileExists: If the ``path`` exists, and *exclusive mode* is specified (``x`` in the mode). fs.errors.ResourceNotFound: If ``path`` does not exist and ``mode`` does not imply creating the file, or if any ancestor of ``path`` does not exist. NrX)rPremode bufferingoptionss rBopenbinz FS.openbinrhrDcy)a Remove a file from the filesystem. Arguments: path (str): Path of the file to remove. Raises: fs.errors.FileExpected: If the path is a directory. fs.errors.ResourceNotFound: If the path does not exist. NrXrjs rBremovez FS.removerhrDcy)aRemove a directory from the filesystem. Arguments: path (str): Path of the directory to remove. Raises: fs.errors.DirectoryNotEmpty: If the directory is not empty ( see `~fs.base.FS.removetree` for a way to remove the directory contents). fs.errors.DirectoryExpected: If the path does not refer to a directory. fs.errors.ResourceNotFound: If no resource exists at the given path. fs.errors.RemoveRootError: If an attempt is made to remove the root directory (i.e. ``'/'``) NrXrjs rB removedirz FS.removedir rhrDcy)aSet info on a resource. This method is the complement to `~fs.base.FS.getinfo` and is used to set info values on a resource. Arguments: path (str): Path to a resource on the filesystem. info (dict): Dictionary of resource info. Raises: fs.errors.ResourceNotFound: If ``path`` does not exist on the filesystem The ``info`` dict should be in the same format as the raw info returned by ``getinfo(file).raw``. Example: >>> details_info = {"details": { ... "modified": time.time() ... }} >>> my_fs.setinfo('file.txt', details_info) NrX)rPreinfos rBsetinfoz FS.setinfo!rhrDct|ts td|j5|j |d5}|j |ddddddy#1swYxYw#1swYyxYw)acAppend bytes to the end of a file, creating it if needed. Arguments: path (str): Path to a file. data (bytes): Bytes to append. Raises: TypeError: If ``data`` is not a `bytes` instance. fs.errors.ResourceNotFound: If a parent directory of ``path`` does not exist. z must be bytesabN) isinstancebytes TypeErrorrMopenwrite)rPredata append_files rB appendbyteszFS.appendbytesAsm$&O, , ZZ (4& (+!!$' ( ( ( ( ( ( (s"A*A A*A' #A**A3ct|tjs td|j5|j |d|||5}|j |ddddddy#1swYxYw#1swYyxYw)a_Append text to the end of a file, creating it if needed. Arguments: path (str): Path to a file. text (str): Text to append. encoding (str): Encoding for text files (defaults to ``utf-8``). errors (str, optional): What to do with unicode decode errors (see `codecs` module for more information). newline (str): Newline parameter. Raises: TypeError: if ``text`` is not an unicode string. fs.errors.ResourceNotFound: if a parent directory of ``path`` does not exist. zmust be unicode stringat)encodingr newlineN)r~six text_typerrMrr)rPretextrr rrs rB appendtextz FS.appendtextVs2$ .45 5 ZZ (dXfg (!!$' ( ( ( ( ( ( (s#A8 A,A8,A5 1A88Bcd|_y)aClose the filesystem and release any resources. It is important to call this method when you have finished working with the filesystem. Some filesystems may not finalize changes until they are closed (archives for example). You may call this method explicitly (it is safe to call close multiple times), or you can use the filesystem as a context manager to automatically close. Example: >>> with OSFS('~/Desktop') as desktop_fs: ... desktop_fs.writetext( ... 'note.txt', ... "Don't forget to tape Game of Thrones" ... ) If you attempt to use a filesystem that has been closed, a `~fs.errors.FilesystemClosed` exception will be thrown. TN)rKrUs rBrTzFS.closews , rDc:|j5|s&|j|rtj|t |j |d5}|j ||ddd|rt||||dddy#1swY"xYw#1swYyxYw)aCopy file contents from ``src_path`` to ``dst_path``. Arguments: src_path (str): Path of source file. dst_path (str): Path to destination file. overwrite (bool): If `True`, overwrite the destination file if it exists (defaults to `False`). preserve_time (bool): If `True`, try to preserve mtime of the resource (defaults to `False`). Raises: fs.errors.DestinationExists: If ``dst_path`` exists, and ``overwrite`` is `False`. fs.errors.ResourceNotFound: If a parent directory of ``dst_path`` does not exist. fs.errors.FileExpected: If ``src_path`` is not a file. rbN)rMexistsr DestinationExistsrruploadr)rPsrc_pathdst_path overwrite preserve_time read_files rBr zFS.copys4ZZ CX!6..x888T23 1y Hi0 1"44B C C 1 1 C Cs$ABB$BB BBc*|j5|s&|j|stj||j |j stj |tj|||||dddy#1swYyxYw)aCopy the contents of ``src_path`` to ``dst_path``. Arguments: src_path (str): Path of source directory. dst_path (str): Path to destination directory. create (bool): If `True`, then ``dst_path`` will be created if it doesn't exist already (defaults to `False`). preserve_time (bool): If `True`, try to preserve mtime of the resource (defaults to `False`). Raises: fs.errors.ResourceNotFound: If the ``dst_path`` does not exist, and ``create`` is not `True`. fs.errors.DirectoryExpected: If ``src_path`` is not a directory. rN) rMrr ResourceNotFoundrgis_dirDirectoryExpectedr copy_dir)rPrrcreaters rBcopydirz FS.copydirsz2ZZ W$++h"7--h77<<)00..x88 MM$$ V  W W Ws A3B  Bc|j5|s|j|r dddyt|j|d5 ddd dddy#1swYxYw#1swYyxYw)aCreate an empty file. The default behavior is to create a new file if one doesn't already exist. If ``wipe`` is `True`, any existing file will be truncated. Arguments: path (str): Path to a new file in the filesystem. wipe (bool): If `True`, truncate any existing file to 0 bytes (defaults to `False`). Returns: bool: `True` if a new file had to be created. NFwbT)rMrrr)rPrewipes rBrz FS.createsp"ZZ DKK-  4./         s(A&A&A A&A# A&&A/c|j|stj| |j|}|S#tjtjf$rdj ||cYSwxYw)a(Return a short descriptive text regarding a path. Arguments: path (str): A path to a resource on the filesystem. Returns: str: a short description of the path. Raises: fs.errors.ResourceNotFound: If ``path`` does not exist. z{} on {})rr r getsyspath NoSysPathr;)rPresyspaths rBdesczFS.descsp{{4 ))$/ / ood+GN'')9)9: 1$$T40 0 1s;5A32A3cZ |j|y#tj$rYywxYw)zCheck if a path maps to a resource. Arguments: path (str): Path to a resource. Returns: bool: `True` if a resource exists at the given path. TF)rgr rrjs rBrz FS.existss2  LL &&  s **cj||}gfd} fd} fd} fd} |rjt| ||rjt| ||rjt| ||rjt| |r fd|D}t|} ||\}}t j | ||} | S)aGet an iterator of resource info, filtered by patterns. This method enhances `~fs.base.FS.scandir` with additional filtering functionality. Arguments: path (str): A path to a directory on the filesystem. files (list, optional): A list of UNIX shell-style patterns to filter file names, e.g. ``['*.py']``. dirs (list, optional): A list of UNIX shell-style patterns to filter directory names. exclude_dirs (list, optional): A list of patterns used to exclude directories. exclude_files (list, optional): A list of patterns used to exclude files. namespaces (list, optional): A list of namespaces to include in the resource information, e.g. ``['basic', 'access']``. page (tuple, optional): May be a tuple of ``(, )`` indexes to return an iterator of a subset of the resource info, or `None` to iterate over the entire directory. Paging a directory scan may be necessary for very large directories. Returns: ~collections.abc.Iterator: an iterator of `Info` objects. rfcX|jxsj||jSzPattern match info.name.is_filematchnamepatternsrzrPs rB match_dirzFS.filterdir..match_dir<s#<<B4::h #B BrDcX|jxsj||jSrrrrrs rB match_filez FS.filterdir..match_fileAs#;;A$**Xtyy"A ArDcZ|jxsj||j Srrrs rB exclude_dirz!FS.filterdir..exclude_dirFs&<<Ftzz(DII'F#F FrDcZ|jxsj||j Srrrs rB exclude_filez"FS.filterdir..exclude_fileKs&;;Edjj499&E"E ErDc3NK|]tfdDsyw)c3.K|] }|ywNrX).0_filterrzs rB z)FS.filterdir...[s1WG'$-1WsN)all)rrzfilterss @rBrzFS.filterdir..Zs#c1Ww1W.Ws%%)scandirappendriter itertoolsislice)rPrefilesdirs exclude_dirs exclude_filesrfpage resourcesrrrr iter_infostartendrs` @rB filterdirz FS.filterdirsLLL*L=  C  B  G  F  NN7:u5 6  NN79d3 4  NN7; = >  NN7<? @ !*IO  JE3!((E3?IrDct|j|d5}|j}ddd|S#1swYSxYw)a^Get the contents of a file as bytes. Arguments: path (str): A path to a readable file on the filesystem. Returns: bytes: the file contents. Raises: fs.errors.FileExpected: if ``path`` exists but is not a file. fs.errors.ResourceNotFound: if ``path`` does not exist. rrqNrrread)rPrercontentss rB readbytesz FS.readbytesdsATYYt$Y/ 0 (I ~~'H ( (s 8Agetbytesc |j5|j|fi|5}tj|||ddddddy#1swYxYw#1swYyxYw)aCopy a file from the filesystem to a file-like object. This may be more efficient that opening and copying files manually if the filesystem supplies an optimized method. Note that the file object ``file`` will *not* be closed by this method. Take care to close it after this method completes (ideally with a context manager). Arguments: path (str): Path to a resource. file (file-like): A file-like object open for writing in binary mode. chunk_size (int, optional): Number of bytes to read at a time, if a simple copy is used, or `None` to use sensible default. **options: Implementation specific options required to open the source file. Example: >>> with open('starwars.mov', 'wb') as write_file: ... my_fs.download('/Videos/starwars.mov', write_file) Raises: fs.errors.ResourceNotFound: if ``path`` does not exist.  chunk_sizeNrMrtrcopy_file_data)rPrefilerrsrs rBdownloadz FS.downloadysj:ZZ Md.g. M)$$YL M M M M M M Ms!AA A A AA getfilec t|j|d|||5}|j}ddd|S#1swYSxYw)aGet the contents of a file as a string. Arguments: path (str): A path to a readable file on the filesystem. encoding (str, optional): Encoding to use when reading contents in text mode (defaults to `None`, reading in binary mode). errors (str, optional): Unicode errors parameter. newline (str): Newlines parameter. Returns: str: file contents. Raises: fs.errors.ResourceNotFound: If ``path`` does not exist. rtrqrr rNr)rPrerr rrrs rBreadtextz FS.readtextsW0 II4(67    ( ~~'H  (   ( s ;Agettextc>|j|dgjS)aGet the timestamp of the last modifying access of a resource. Arguments: path (str): A path to a resource. Returns: datetime: The timestamp of the last modification. The *modified timestamp* of a file is the point in time that the file was last changed. Depending on the file system, it might only have limited accuracy. detailsr)rgmodifiedrjs rB getmodifiedzFS.getmodifieds||Di[|9BBBrDcL|dk(r|jj}|Si}|S)ajGet meta information regarding a filesystem. Arguments: namespace (str): The meta namespace (defaults to ``"standard"``). Returns: dict: the meta information. Meta information is associated with a *namespace* which may be specified with the ``namespace`` parameter. The default namespace, ``"standard"``, contains common information regarding the filesystem's capabilities. Some filesystems may provide other namespaces which expose less common or implementation specific information. If a requested namespace is not supported by a filesystem, then an empty dictionary will be returned. The ``"standard"`` namespace supports the following keys: =================== ============================================ key Description ------------------- -------------------------------------------- case_insensitive `True` if this filesystem is case insensitive. invalid_path_chars A string containing the characters that may not be used on this filesystem. max_path_length Maximum number of characters permitted in a path, or `None` for no limit. max_sys_path_length Maximum number of characters permitted in a sys path, or `None` for no limit. network `True` if this filesystem requires a network. read_only `True` if this filesystem is read only. supports_rename `True` if this filesystem supports an `os.rename` operation. =================== ============================================ Most builtin filesystems will provide all these keys, and third- party filesystems should do so whenever possible, but a key may not be present if there is no way to know the value. Note: Meta information is constant for the lifetime of the filesystem, and may be cached. standard)_metar )rP namespacemetas rBgetmetaz FS.getmetas0`  "::??$D D rDc<|j|j}|S)a+Get the size (in bytes) of a resource. Arguments: path (str): A path to a resource. Returns: int: the *size* of the resource. Raises: fs.errors.ResourceNotFound: if ``path`` does not exist. The *size* of a file is the total number of readable bytes, which may not reflect the exact number of bytes of reserved disk space (or other storage medium). The size of a directory is the number of bytes of overhead use to store the directory entry. ) getdetailssize)rPrers rBgetsizez FS.getsizes*t$)) rDc.tj|)aGet the *system path* of a resource. Arguments: path (str): A path on the filesystem. Returns: str: the *system path* of the resource, if any. Raises: fs.errors.NoSysPath: If there is no corresponding system path. A system path is one recognized by the OS, that may be used outside of PyFilesystem (in an application or a shell for example). This method will get the corresponding system path that would be referenced by ``path``. Not all filesystems have associated system paths. Network and memory based filesystems, for example, may not physically store data anywhere the OS knows about. It is also possible for some paths to have a system path, whereas others don't. This method will always return a str on Py3.* and unicode on Py2.7. See `~getospath` if you need to encode the path as bytes. If ``path`` doesn't have a system path, a `~fs.errors.NoSysPath` exception will be thrown. Note: A filesystem may return a system path even if no resource is referenced by that path -- as long as it can be certain what that system path would be. re)r rrjs rBrz FS.getsyspathsHD))rDc>|j|}t|}|S)aUGet the *system path* to a resource, in the OS' prefered encoding. Arguments: path (str): A path on the filesystem. Returns: str: the *system path* of the resource, if any. Raises: fs.errors.NoSysPath: If there is no corresponding system path. This method takes the output of `~getsyspath` and encodes it to the filesystem's prefered encoding. In Python3 this step is not required, as the `os` module will do it automatically. In Python2.7, the encoding step is required to support filenames on the filesystem that don't encode correctly. Note: If you want your code to work in Python2.7 and Python3 then use this method if you want to work with the OS filesystem outside of the OSFS interface. )rr )rPrerospaths rB getospathz FS.getospathCs!2//$''" rDc<|j|j}|S)aGet the type of a resource. Arguments: path (str): A path on the filesystem. Returns: ~fs.enums.ResourceType: the type of the resource. Raises: fs.errors.ResourceNotFound: if ``path`` does not exist. A type of a resource is an integer that identifies the what the resource references. The standard type integers may be one of the values in the `~fs.enums.ResourceType` enumerations. The most common resource types, supported by virtually all filesystems are ``directory`` (1) and ``file`` (2), but the following types are also possible: =================== ====== ResourceType value ------------------- ------ unknown 0 directory 1 file 2 character 3 block_special_file 4 fifo 5 socket 6 symlink 7 =================== ====== Standard resource types are positive integers, negative values are reserved for implementation specific resource types. )rtype)rPre resource_types rBgettypez FS.gettype`sL-22 rDc.tj||)aGet the URL to a given resource. Arguments: path (str): A path on the filesystem purpose (str): A short string that indicates which URL to retrieve for the given path (if there is more than one). The default is ``'download'``, which should return a URL that serves the file. Other filesystems may support other values for ``purpose``: for instance, `OSFS` supports ``'fs'``, which returns a FS URL (see :ref:`fs-urls`). Returns: str: a URL. Raises: fs.errors.NoURL: If the path does not map to a URL. )r NoURL)rPrepurposes rBgeturlz FS.geturls(ll4))rDcfd} |j||S#tj$rd}Y|SwxYw)zCheck if a path maps to a system path. Arguments: path (str): A path on the filesystem. Returns: bool: `True` if the resource at ``path`` has a *syspath*. TF)rr r)rPre has_sys_paths rB hassyspathz FS.hassyspathsD  ! OOD ! ! L !s 00cjd} |j|||S#tj$rd}Y|SwxYw)a-Check if a path has a corresponding URL. Arguments: path (str): A path on the filesystem. purpose (str): A purpose parameter, as given in `~fs.base.FS.geturl`. Returns: bool: `True` if an URL for the given purpose exists. T)rF)rr r)rPrerhas_urls rBhasurlz FS.hasurlsD  KKgK .|| G s 22ct|ddS)z"Check if the filesystem is closed.rKF)rFrUs rBisclosedz FS.isclosedstY..rDcl |j|jS#tj$rYywxYw)zCheck if a path maps to an existing directory. Arguments: path (str): A path on the filesystem. Returns: bool: `True` if ``path`` maps to a directory. Frgrr rrjs rBisdirzFS.isdirs4 <<%,, ,&&  s 33cNtt|j|dduS)aCheck if a directory is empty. A directory is considered empty when it does not contain any file or any directory. Arguments: path (str): A path to a directory on the filesystem. Returns: bool: `True` if the directory is empty. Raises: errors.DirectoryExpected: If ``path`` is not a directory. errors.ResourceNotFound: If ``path`` does not exist. N)nextrrrjs rBisemptyz FS.isemptys$$Dd+,d3t;;rDcn |j|j S#tj$rYywxYw)zCheck if a path maps to an existing file. Arguments: path (str): A path on the filesystem. Returns: bool: `True` if ``path`` maps to a file. Fr rjs rBisfilez FS.isfiles7 ||D)000 0&&  s 44c&|j|y)zCheck if a path maps to a symlink. Arguments: path (str): A path on the filesystem. Returns: bool: `True` if ``path`` maps to a symlink. Frgrjs rBislinkz FS.islinks TrDc|jS)afGet a context manager that *locks* the filesystem. Locking a filesystem gives a thread exclusive access to it. Other threads will block until the threads with the lock has left the context manager. Returns: threading.RLock: a lock specific to the filesystem instance. Example: >>> with my_fs.lock(): # May block ... # code here has exclusive access to the filesystem ... pass It is a good idea to put a lock around any operations that you would like to be *atomic*. For instance if you are copying files, and you don't want another thread to delete or modify anything while the copy is in progress. Locking with this method is only required for code that calls multiple filesystem methods. Individual methods are thread safe already, and don't need to be locked. Note: This only locks at the Python level. There is nothing to prevent other processes from modifying the filesystem outside of the filesystem instance. )rMrUs rBlockzFS.lock s>zzrDcddlm}|j5|s&|j|st j |||||||dddy#1swYyxYw)aMove directory ``src_path`` to ``dst_path``. Arguments: src_path (str): Path of source directory on the filesystem. dst_path (str): Path to destination directory. create (bool): If `True`, then ``dst_path`` will be created if it doesn't exist already (defaults to `False`). preserve_time (bool): If `True`, try to preserve mtime of the resources (defaults to `False`). Raises: fs.errors.ResourceNotFound: if ``dst_path`` does not exist, and ``create`` is `False`. fs.errors.DirectoryExpected: if ``src_path`` or one of its ancestors is not a directory. r )move_dirrN)moverrMrr r)rPrrrrrs rBmovedirz FS.movedir-sV& # ZZ R$++h"7--h77 T8T8= Q R R Rs 6AAc|j|j5tj||}|D]} |j || |j |||j|cdddS#t j $r|sY_wxYw#t j $r|sYNwxYw#1swYyxYw)aMake a directory, and any missing intermediate directories. Arguments: path (str): Path to directory from root. permissions (~fs.permissions.Permissions, optional): Initial permissions, or `None` to use defaults. recreate (bool): If `False` (the default), attempting to create an existing directory will raise an error. Set to `True` to ignore existing directories. Returns: ~fs.subfs.SubFS: A sub-directory filesystem. Raises: fs.errors.DirectoryExists: if the path is already a directory, and ``recreate`` is `False`. fs.errors.DirectoryExpected: if one of the ancestors in the path is not a directory. )rmN)checkrMrget_intermediate_dirsror DirectoryExistsopendir)rPrermrn dir_pathsdir_paths rBmakedirsz FS.makedirsGs6 ZZ &33D$?I% LL{LC    T{ ;<<% & & --#$ ))    & &sRB5A= B5B#B5=BB5BB5B2/B51B22B55B>c|s&|j|rtj||j|jrtj ||j jddrK |j|}|j|} tj|||rt||||y|j5|j|d5}|j!||ddd|rt|||||j#|dddy#t$rYowxYw#tj$rYwxYw#1swY[xYw#1swYyxYw)a9Move a file from ``src_path`` to ``dst_path``. Arguments: src_path (str): A path on the filesystem to move. dst_path (str): A path on the filesystem where the source file will be written to. overwrite (bool): If `True`, destination path will be overwritten if it exists. preserve_time (bool): If `True`, try to preserve mtime of the resources (defaults to `False`). Raises: fs.errors.FileExpected: If ``src_path`` maps to a directory instead of a file. fs.errors.DestinationExists: If ``dst_path`` exists, and ``overwrite`` is `False`. fs.errors.ResourceNotFound: If a parent directory of ``dst_path`` does not exist. supports_renameFNr)rr rrgr FileExpectedrgetrosrenamerOSErrorrrMrrrv)rPrrrr src_sys_path dst_sys_pathrs rBrzFS.moversG,T[[2**84 4 << ! ( (%%h/ / <<>  / 7 #x8 #x8 IIlL9%*44J ZZ "8T* 1i Hi0 1"44B KK !  " "  ##   1 1 " "sH:"D7D(E#E6)E( D43D47E  E E EE%c t||jdd}|j|||} tj|| f|||xsd||d|} | S)aOpen a file. Arguments: path (str): A path to a file on the filesystem. mode (str): Mode to open the file object with (defaults to *r*). buffering (int): Buffering policy (-1 to use default buffering, 0 to disable buffering, 1 to select line buffering, of any positive integer to indicate a buffer size). encoding (str): Encoding for text files (defaults to ``utf-8``) errors (str, optional): What to do with unicode decode errors (see `codecs` module for more information). newline (str): Newline parameter. **options: keyword arguments for any additional information required by the filesystem (if any). Returns: io.IOBase: a *file-like* object. Raises: fs.errors.FileExpected: If the path is not a file. fs.errors.FileExists: If the file exists, and *exclusive mode* is specified (``x`` in the mode). fs.errors.ResourceNotFound: If the path does not exist. t)rqrrutf-8)rqrrrr r)rreplacertr make_stream) rPrerqrrrr rrsbin_modebin_file io_streams rBrzFS.openstN 4 <<R(<<8y<I''    (    rDcddlm}|xs|jxs|}|j|jst j ||||S)aGet a filesystem object for a sub-directory. Arguments: path (str): Path to a directory on the filesystem. factory (callable, optional): A callable that when invoked with an FS instance and ``path`` will return a new FS object representing the sub-directory contents. If no ``factory`` is supplied then `~fs.subfs_class` will be used. Returns: ~fs.subfs.SubFS: A filesystem representing a sub-directory. Raises: fs.errors.ResourceNotFound: If ``path`` does not exist. fs.errors.DirectoryExpected: If ``path`` is not a directory. r r0r)subfsr1 subfs_classrgrr r)rPrefactoryr1_factorys rBrz FS.opendirsL0 !7d..7%||D!((**5 5d##rDc\tt|}|j5tjd}|j ||}|D]4\}}|j r|j|$|j|6|dk7r|j|dddy#1swYyxYw)aRecursively remove a directory and all its contents. This method is similar to `~fs.base.FS.removedir`, but will remove the contents of the directory if it is not empty. Arguments: dir_path (str): Path to a directory on the filesystem. Raises: fs.errors.ResourceNotFound: If ``dir_path`` does not exist. fs.errors.DirectoryExpected: If ``dir_path`` is not a directory. Caution: A filesystem should never delete its root folder, so ``FS.removetree("/")`` has different semantics: the contents of the root folder will be deleted, but the root will be untouched:: >>> home_fs = fs.open_fs("~") >>> home_fs.removetree("/") >>> home_fs.exists("/") True >>> home_fs.isempty("/") True Combined with `~fs.base.FS.opendir`, this can be used to clear a directory without removing the directory itself:: >>> home_fs = fs.open_fs("~") >>> home_fs.opendir("/Videos").removetree("/") >>> home_fs.exists("/Videos") True >>> home_fs.isempty("/Videos") True depth)search/N) rrrMrrrzrrxrv)rPr! _dir_pathwalkergen_info_pathrzs rB removetreez FS.removetreesNHX./ ZZ )[[0F{{43H' ' t;;NN5)KK&  ' Cx( ) ) )s A8B""B+cxsdtt|fdj|D}t|}||\}}t j |||}|S)aJGet an iterator of resource info. Arguments: path (str): A path to a directory on the filesystem. namespaces (list, optional): A list of namespaces to include in the resource information, e.g. ``['basic', 'access']``. page (tuple, optional): May be a tuple of ``(, )`` indexes to return an iterator of a subset of the resource info, or `None` to iterate over the entire directory. Paging a directory scan may be necessary for very large directories. Returns: ~collections.abc.Iterator: an iterator of `Info` objects. Raises: fs.errors.DirectoryExpected: If ``path`` is not a directory. fs.errors.ResourceNotFound: If ``path`` does not exist. rXc3XK|]!}jt|#yw)rN)rgr)rrrArfrPs rBrzFS.scandir..Js-  LLeT*zL B s'*)rrrkrrr) rPrerfrrzrrrrAs ` ` @rBrz FS.scandir,si6 %2 '  T* J  JE3!((E3?IrDct|ts tdt|j |d5}|j |dddy#1swYyxYw)zCopy binary data to a file. Arguments: path (str): Destination path on the filesystem. contents (bytes): Data to be written. Raises: TypeError: if contents is not bytes. zcontents must be bytesrrN)r~rrrrr)rPrer write_files rB writebytesz FS.writebytesTsT(E*45 5 TYYt$Y/ 0 'J   X & ' ' 's AAsetbytesc |j5|j|fddi|5}tj|||ddddddy#1swYxYw#1swYyxYw)aUSet a file to the contents of a binary file object. This method copies bytes from an open binary file to a file on the filesystem. If the destination exists, it will first be truncated. Arguments: path (str): A path on the filesystem. file (io.IOBase): a file object open for reading in binary mode. chunk_size (int, optional): Number of bytes to read at a time, if a simple copy is used, or `None` to use sensible default. **options: Implementation specific options required to open the source file. Raises: fs.errors.ResourceNotFound: If a parent directory of ``path`` does not exist. Note that the file object ``file`` will *not* be closed by this method. Take care to close it after this method completes (ideally with a context manager). Example: >>> with open('~/movies/starwars.mov', 'rb') as read_file: ... my_fs.upload('starwars.mov', read_file) rqrrNr)rPrerrrsdst_files rBrz FS.uploadhso>ZZ Ld999 LX$$T8 K L L L L L L Ls!AA A A AA" setbinfilec|dnd}|j5|j|||||5}tj||ddddddy#1swYxYw#1swYyxYw)a*Set a file to the contents of a file object. Arguments: path (str): A path on the filesystem. file (io.IOBase): A file object open for reading. encoding (str, optional): Encoding of destination file, defaults to `None` for binary. errors (str, optional): How encoding errors should be treated (same as `io.open`). newline (str): Newline parameter (same as `io.open`). This method is similar to `~FS.upload`, in that it copies data from a file-like object to a resource on the filesystem, but unlike ``upload``, this method also supports creating files in text-mode (if the ``encoding`` argument is supplied). Note that the file object ``file`` will *not* be closed by this method. Take care to close it after this method completes (ideally with a context manager). Example: >>> with open('myfile.txt') as read_file: ... my_fs.writefile('myfile.txt', read_file) Nrwtr)rMrrr)rPrerrr rrqrJs rB writefilez FS.writefilesvD 'tT ZZ 54(67 5$$T84 5 5 5 5 5 5 5s"AAAA AA'setfileci}d|i}|tjn t||d<||dn t||d<|j||y)aSet the accessed and modified time on a resource. Arguments: path: A path to a resource on the filesystem. accessed (datetime, optional): The accessed time, or `None` (the default) to use the current time. modified (datetime, optional): The modified time, or `None` (the default) to use the same time as the ``accessed`` parameter. rNaccessedr)timerr{)rPrerQrrraw_infos rBsettimesz FS.settimessfw'$+DIIK1B81L   $,#3GJ 9J89T   T8$rDc t|tjs tdt |j |d|||5}|j |dddy#1swYyxYw)aCreate or replace a file with text. Arguments: path (str): Destination path on the filesystem. contents (str): Text to be written. encoding (str, optional): Encoding of destination file (defaults to ``'utf-8'``). errors (str, optional): How encoding errors should be treated (same as `io.open`). newline (str): Newline parameter (same as `io.open`). Raises: TypeError: if ``contents`` is not a unicode string. zcontents must be unicoderMrN)r~rrrrrr)rPrerrr rrFs rB writetextz FS.writetextsj0(CMM267 7  II4(67    '   X &  ' ' 's A  A)settextc|j5tj}|j|sd||di}|j||dddy#1swYyxYw)a[Touch a file on the filesystem. Touching a file means creating a new file if ``path`` doesn't exist, or update accessed and modified times if the path does exist. This method is similar to the linux command of the same name. Arguments: path (str): A path to a file on the filesystem. r)rQrN)rMrRrr{)rPrenowrSs rBtouchzFS.touchsTZZ -))+C;;t$%CS'IJ T8,  - - -s ?AAc|jt|tr!ttj rdd|j }tjtj|jd}|r/t|j|rtj|tjt|jdd}|dk7rK |j!|}t#||kDr+d}|j%|}tj&||t+t-|}|S#tj($rY+wxYw) aValidate a path, returning a normalized absolute path on sucess. Many filesystems have restrictions on the format of paths they support. This method will check that ``path`` is valid on the underlaying storage mechanism and throw a `~fs.errors.InvalidPath` exception if it is not. Arguments: path (str): A path. Returns: str: A normalized, absolute path. Raises: fs.errors.InvalidPath: If the path is invalid. fs.errors.FilesystemClosed: if the filesystem is closed. fs.errors.InvalidCharsInPath: If the path contains invalid characters. zpaths must be unicode (not str)zpaths must be str (not bytes)invalid_path_charsmax_sys_path_lengthz6path too long (max {max_chars} characters in sys path)) max_chars)msg)rr~rrrPY2rtypingcastrr&set intersectionr InvalidCharsInPathintrlenr; InvalidPathrrr)rPrer invalid_charsr]sys_path_msgr`s rB validatepathzFS.validatepath s-, dE "772 5  ||~ CMM488>> my_fs.match(['*.py'], '__init__.py') True >>> my_fs.match(['*.jpg', '*.png'], 'foo.gif') False Note: If ``patterns`` is `None` (or ``['*']``), then this method will always return `True`. Tz#patterns must be a list or sequencecase_insensitiveF) r~rrrrbrcboolrr&r get_matcher)rPrrcase_sensitivematchers rBrzFS.matchxsrB   h .AB B#[[ $,,.$$%7?  &&x@t}rDc "ddlm}||fi|y)aRender a tree view of the filesystem to stdout or a file. The parameters are passed to :func:`~fs.tree.render`. Keyword Arguments: path (str): The path of the directory to start rendering from (defaults to root folder, i.e. ``'/'``). file (io.IOBase): An open file-like object to render the tree, or `None` for stdout. encoding (str): Unicode encoding, or `None` to auto-detect. max_levels (int): Maximum number of levels to display, or `None` for no maximum. with_color (bool): Enable terminal color output, or `None` to auto-detect terminal. dirs_first (bool): Show directories first. exclude (list): Option list of directory patterns to exclude from the tree render. filter (list): Optional list of files patterns to match in the tree render. r )renderN)treer{)rPr?r{s rBr|zFS.trees0 !tvrDc|j| tj|}|j|5} |jd}|sn|j|& ddd|jS#t$r%t j dj |wxYw#1swY|jSxYw)a*Get the hash of a file's contents. Arguments: path(str): A path on the filesystem. name(str): One of the algorithms supported by the `hashlib` module, e.g. `"md5"` or `"sha256"`. Returns: str: The hex digest of the hash. Raises: fs.errors.UnsupportedHash: If the requested hash is not supported. fs.errors.ResourceNotFound: If ``path`` does not exist. fs.errors.FileExpected: If ``path`` exists but is not a file. zhash '{}' is not supportediN) rmhashlibnew ValueErrorr UnsupportedHashr;rtrupdate hexdigest)rPrer hash_object binary_filechunks rBhashzFS.hashs& $ T!++d+K\\$  *;#((5""5)   * $$&& T(()E)L)LT)RS S T * $$&&sA:(B+:.B(+Cr)NF)rr^)r/Nr.)FF)F)NNNNNN)NNr.)r)r)rr^NNr.)NN)Pr< __module__ __qualname__rErrrbr7rOrVrYr^propertyr`rabcabstractmethodrgrkrortrvrxr{rrrTr rrrrrrrHrrrrrrrrrrrrrrr r rrrrrr"rrrrBrrGrHrrKrNrOrTrVrWrZrmrprrrr|r __classcell__)rQs@rBr4r4`s$ ELK# "",,   (   (    2     D        (   >(2 (B8 !CN W@0.*  Ob&J/HMB),G  @),GC"4l0$*L:'R*,$(/  <( BR: )&V/"h4r$@1)l  &P'$Z0H!LF6<0J  (5T 9-G%< 'B 9-G-&2r84:" ,)V8'rD)NrE __future__rrrrbrr~rr'rrLrRr9 contextlibr functoolsrrr.r r r r rrrrr`rrqrrerrrrr TYPE_CHECKINGrrrrrrr r!r"r#r$r%r&r'r(r)r*typesr+enumsr,rzr-r.rmr/r6r1r2TypeVarr3r6_OpendirFactory__all__rH add_metaclassABCMetaobjectr4rXrDrBrsIH   $DDD$$))# $"###(! D )B D )BDz5945O &63;;|'|' |'rD