o h)@s"ddlmZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl mZddlmZmZddlmZdd lmZmZdd lmZdd lmZdd lmZmZmZmZm Z m!Z!m"Z"e#d Z$ddZ%Gddde&Z'Gddde'dZ(Gdddej)Z*ddZ+dS)) annotationsN)ESPIPE) has_magic)sha256)AnyClassVar)DEFAULT_CALLBACK) apply_configconf)DirCache) Transaction)_unstrip_protocolglob_translate isfilelike other_paths read_blockstringify_pathtokenizefsspeccCs||i|SNclsargskwargsrr_/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/fsspec/spec.py make_instance srcs,eZdZdZfddZfddZZS)_Cacheda Metaclass for caching file system instances. Notes ----- Instances are cached according to * The values of the class attributes listed in `_extra_tokenize_attributes` * The arguments passed to ``__init__``. This creates an additional reference to the filesystem, which prevents the filesystem from being garbage collected when all *user* references go away. A call to the :meth:`AbstractFileSystem.clear_instance_cache` must *also* be made for a filesystem instance to be garbage collected. cs<tj|i|tdrt|_ni|_t|_ dS)Nweakref_instance_cache) super__init__r getweakrefWeakValueDictionary_cacheosgetpid_pidr __class__rrr!5s   z_Cached.__init__cst|}tfddjD}tjtg||Ri|}|dd}t jkr:j t _|sLj rL|j vrL|_ j |Stj|i|}||_||_||_|jrn|jrnddlm}||j r{|s{|_ |j |<|S)Nc3s|] }t|dVqdSrgetattr).0attrrrr Cs  z#_Cached.__call__..skip_instance_cacheFr)mirror_sync_methods)r tuple_extra_tokenize_attributesrr( threading get_identpopr&r'r%clearcachable_latestr __call__ _fs_token_ storage_argsstorage_options async_implr2asyn)rrr extra_tokenstokenskipobjr2r)r/rr;As>           z_Cached.__call__)__name__ __module__ __qualname____doc__r!r; __classcell__rrr)rr$s  rc@seZdZUdZdZdZdZdZdZde d<d Z dZ dZ d Z eZd Zd e d <de d<ddZeddZeddZddZddZddZddZeddZdd#d$Zed%d&Zed'd(Zed)d*Zd+d,Z d-d.Z!dd/d0Z"dd1d2Z#dd3d4Z$d5d6Z%dd7d8Z&d9d:Z'ddd?Z)dd@dAZ*ddBdCZ+dDdEZ,dFdGZ-dHdIZ.dJdKZ/dLdMZ0dNdOZ1dPdQZ2dRdSZ3ddTdUZ4 ddVdWZ5ddXdYZ6dd[d\Z7dd]d^Z8 "dd_d`Z9ddbdcZ:e;d fdddeZde;d fdjdkZ?ddmdnZ@ddodpZAdqdrZB ddsdtZCddudvZDddwdxZEdydzZFd{d|ZGdd}d~ZHeddZI  dddZJ dddZKdddZLddZMdddZNdddddZOedddZPdddddZQedddZRddZSdddZTeddZUddZVddZW     ddddZXdddZYddZZdddZ[dddZ\dddZ]ddZ^ddZ_ddZ`ddd„ZaddĄZbdddƄZcdddȄZddddʄZeddd̈́ZfddτZgd S)AbstractFileSystemz An abstract super-class for pythonic file-systems Implementations are expected to be compatible with or, better, subclass from here. TFi@/abstractzClassVar[str | tuple[str, ...]]protocolNrztuple[Any, ...]r=dict[str, Any]r>cOsl|jrdSd|_d|_d|_g|_tdi||_|ddr%tdt |ddr1tdt d|_ dS) aCreate and configure file-system instance Instances may be cachable, so if similar enough arguments are seen a new instance is not required. The token attribute exists to allow implementations to cache instances if they wish. A reasonable default should be provided if there are no arguments. Subclasses should call this method. Parameters ---------- use_listings_cache, listings_expiry_time, max_paths: passed to ``DirCache``, if the implementation supports directory listing caching. Pass use_listings_cache=False to disable such caching. skip_instance_cache: bool If this is a cachable implementation, pass True here to force creating a new instance even if a matching instance exists, and prevent storing this instance. asynchronous: bool loop: asyncio-compatible IOLoop or None NTFadd_docsz add_docs is no longer supported. add_aliaseszadd_aliases has been removed.r) _cached_intrans _transaction"_invalidated_caches_in_transactionr dircacher7warningswarn FutureWarningr<)selfrr>rrrr!{s     zAbstractFileSystem.__init__cCt)zbPersistent filesystem id that can be used to compare filesystems across sessions. NotImplementedErrorrZrrrfsidzAbstractFileSystem.fsidcC|jSr)r<r^rrr _fs_tokenzAbstractFileSystem._fs_tokencCrar)rbr^rrr__dask_tokenize__sz$AbstractFileSystem.__dask_tokenize__cCs t|jdS)N)intrbr^rrr__hash__ zAbstractFileSystem.__hash__cCst|t|o |j|jkSr) isinstancetyperbrZotherrrr__eq__szAbstractFileSystem.__eq__cCstt||j|jffSr)rrjr=r>r^rrr __reduce__szAbstractFileSystem.__reduce__cst|trfdd|DSt|}tjtrjfnj}|D]%}||dr5|t|dd}q!||drF|t|dd}q!|d}|pPjS) zTurn path from fully-qualified to file-system-specific May require FS-specific handling, e.g., for relative paths or links. cg|]}|qSr_strip_protocolr-pr/rr z6AbstractFileSystem._strip_protocol..://Nz::rK) rilistrrMstr startswithlenrstrip root_marker)rpathprotosrMrr/rrqs   z"AbstractFileSystem._strip_protocolnamerzreturncCsNt|jtr |jfn|j}|D]}||dr|Sq|dd|S)z6Format FS-specific path to generic, including protocolrvr)rirMrzr{)rZrrrMrrrunstrip_protocols z#AbstractFileSystem.unstrip_protocolcCsiS)afIf kwargs can be encoded in the paths, extract them here This should happen before instantiation of the class; incoming paths then should be amended to strip the options in methods. Examples may look like an sftp path "sftp://user@host:/my/path", where the user and host should become kwargs and later get stripped. rrrrr_get_kwargs_from_urlss z(AbstractFileSystem._get_kwargs_from_urlscCs|j|jvr |j|jS|S)zReturn the most recently instantiated FileSystem If no instance has been created, then create one with defaults )r:r%r/rrrcurrents  zAbstractFileSystem.currentcCs|jdur |||_|jS)zA context within which files are committed together upon exit Requires the file class to implement `.commit()` and `.discard()` for the normal and exception cases. N)rTtransaction_typer^rrr transactions  zAbstractFileSystem.transactioncCsd|_|||_|jS)z@Begin write transaction for deferring files, non-context versionT)rSrrTrr^rrrstart_transactions z$AbstractFileSystem.start_transactioncCs4|jd|_|jD]}||q |jdS)z-Finish write transaction, non-context versionN)rcompleterTrUinvalidate_cacher8rZrrrrend_transactions   z"AbstractFileSystem.end_transactioncCs|jr |j|dSdS)z Discard any cached directory information Parameters ---------- path: string or None If None, clear all listings cached else listings at or under given path. N)rSrUappendrrrrrsz#AbstractFileSystem.invalidate_cachecKdS)a Create directory entry at path For systems that don't have true directories, may create an for this instance only and not touch the real filesystem Parameters ---------- path: str location create_parents: bool if True, this is equivalent to ``makedirs`` kwargs: may be permissions, etc. NrrZrcreate_parentsrrrrmkdirszAbstractFileSystem.mkdircCr)aRecursively make directories Creates directory at path and any intervening required directories. Raises exception if, for instance, the path already exists but is a file. Parameters ---------- path: str leaf directory name exist_ok: bool (False) If False, will error if the target already exists NrrZrexist_okrrrmakedirs*szAbstractFileSystem.makedirscCr)zRemove a directory, if emptyNrrrrrrmdir:zAbstractFileSystem.rmdircKr[)apList objects at path. This should include subdirectories and files at that location. The difference between a file and a directory must be clear when details are requested. The specific keys, or perhaps a FileInfo class, or similar, is TBD, but must be consistent across implementations. Must include: - full path to the entry (without protocol) - size of the entry, in bytes. If the value cannot be determined, will be ``None``. - type of entry, "file", "directory" or other Additional information may be present, appropriate to the file-system, e.g., generation, checksum, etc. May use refresh=True|False to allow use of self._ls_from_cache to check for a saved listing and avoid calling the backend. This would be common where listing may be expensive. Parameters ---------- path: str detail: bool if True, gives a list of dictionaries, where each is the same as the result of ``info(path)``. If False, gives a list of paths (str). kwargs: may have additional backend-specific options, such as version information Returns ------- List of strings if detail is False, or list of directory information dicts if detail is True. r\rZrdetailrrrrls>s'zAbstractFileSystem.lscsx|}z |jdWStyYnwzfdd|j|D}t|dkr/t|WSty;YdSw)zCheck cache for listing Returns listing, if found (may be empty list for a directly that exists but contains nothing), None if not in cache. rKcs:g|]}|dks|ddkr|ddkr|qS)rrKrj directoryr})r-frrrrtss  z5AbstractFileSystem._ls_from_cache..rN)_parentrVr}KeyErrorr|FileNotFoundError)rZrparentfilesrrr_ls_from_cachegs     z!AbstractFileSystem._ls_from_cacheomitc ks|dur |dkr td||}i}i}i}|dd} z |j|fddi|} Wn"ttfyM} z|dkr:t|rB|| WYd} ~ dSd} ~ ww| D]1} | dd } | d dd }| d d krt| |krt| ||<| ||<qP| |kr}| |d <qP| ||<qP| st |}t |}|r|||fV|dur|d8}|dkr|s|||fVdS|D]}|j ||f|| |d|EdHq|s|||fVdSdS)aReturn all files under the given path. List all files, recursing into subdirectories; output is iterator-style, like ``os.walk()``. For a simple list of files, ``find()`` is available. When topdown is True, the caller can modify the dirnames list in-place (perhaps using del or slice assignment), and walk() will only recurse into the subdirectories whose names remain in dirnames; this can be used to prune the search, impose a specific order of visiting, or even to inform walk() about directories the caller creates or renames before it resumes walk() again. Modifying dirnames when topdown is False has no effect. (see os.walk) Note that the "files" outputted will include anything that is not a directory, such as links. Parameters ---------- path: str Root to recurse into maxdepth: int Maximum recursion depth. None means limitless, but not recommended on link-based file-systems. topdown: bool (True) Whether to walk the directory tree from the top downwards or from the bottom upwards. on_error: "omit", "raise", a callable if omit (default), path with exception will simply be empty; If raise, an underlying exception will be raised; if callable, it will be called with a single OSError instance as argument kwargs: passed to ``ls`` Nrmaxdepth must be at least 1rFTraiserrKrjrrN)maxdepthrtopdown) ValueErrorrqr7rrOSErrorcallabler}rsplitrywalk)rZrrron_errorr full_dirsdirsrrlistingeinfopathnamerdrrrrsf!       zAbstractFileSystem.walkc  s||}i|r|dkr||r|||<|j||fddi|D]\}}}|r1||dd|Dq%sI||rIi|<t} |sQ| Sfdd| DS)aList all files below path. Like posix ``find`` command without conditions Parameters ---------- path : str maxdepth: int or None If not None, the maximum number of levels to descend withdirs: bool Whether to include directory paths in the output. This is True when used by glob, but users usually only want files. kwargs are passed to ``ls``. rNrTcSsi|] \}}|d|qS)rr)r-rrrrr z+AbstractFileSystem.find..csi|]}||qSrr)r-routrrrru)rqisdirrrupdateitemsisfilesorted) rZrrwithdirsrr_rrnamesrrrfinds " zAbstractFileSystem.findc Ksxi}|r||r||}|d||d<|j|f||d|D]}||}|d||d<q"|r:t|S|S)asSpace used by files and optionally directories within a path Directory size does not include the size of its contents. Parameters ---------- path: str total: bool Whether to sum all the file sizes maxdepth: int or None Maximum number of directory levels to descend, None for unlimited. withdirs: bool Whether to include directory paths in the output. kwargs: passed to ``find`` Returns ------- Dict of {path: size} if total=False, or int otherwise, where numbers refer to bytes used. sizer)rr)rrrsumvalues) rZrtotalrrrsizesrrrrrdus   zAbstractFileSystem.duc sF|dur |dkr tdddl}tjjrtjjtjjfntjjf}||}||}|p8|tdd|D| ddkrE| dnt |}| ddkrU| dnt |}| d dkre| d nt |} t ||| } | d d } t |s|j|fi|r| s|gS||j|fi|iS| sgSiSd |d| vr|d| d } |d| d} || ddd d} nd } || ddd d} d|vr|dur| d}||dd d}| ||} nd} |j | f| ddd|}t||rd nd |fddt|D}| r|St|S)aJ Find files by glob-matching. If the path ends with '/', only folders are returned. We support ``"**"``, ``"?"`` and ``"[..]"``. We do not support ^ for pattern negation. The `maxdepth` option is applied on the first `**` found in the path. kwargs are passed to ``ls``. Nrrrcss|]}|dVqdS)**Nr)r-seprrrr0<z*AbstractFileSystem.glob..*?[rFrKrNrTrrrcs8i|]\}}r|ddkr|dn|r||qS)rjrrK)match)r-rsrappend_slash_to_dirnamepatternrrrfs z+AbstractFileSystem.glob..)rrer&raltseprendswithrqr3rr|minr7rexistsrrindexcountrcompilerrry)rZrrrrseps ends_with_sepidx_star idx_qmark idx_bracemin_idxrrootdepthidx_double_starsdepth_double_starsallpathsrrrrglob&sV "            zAbstractFileSystem.globcKs&z |j|fi|WdSYdS)z!Is there a file at the given pathTFrrZrrrrrrus zAbstractFileSystem.existscK ||S)zEIf there is a file at the given path (including broken links))rrrrrlexists~s zAbstractFileSystem.lexistsc s||j|fddi|}fdd|D}|r"|dS|jfddi|}dfdd|D}t|dkrQd |dvrMd |dd <|dSt|dksY|r_dd d St) a`Give details of entry at path Returns a single dictionary, with exactly the same information as ``ls`` would with ``detail=True``. The default implementation calls ls and could be overridden by a shortcut. kwargs are passed on to ```ls()``. Some file systems might not be able to measure the file's size, in which case, the returned dict will include ``'size': None``. Returns ------- dict with keys: name (full path in the FS), size (in bytes), type (file, directory, or something else) and other FS-specific keys. rTc"g|] }|ddkr|qSrrKrr-orrrrt"z+AbstractFileSystem.info..rrKcrrrrrrrrtrrrNr)rrrj)rqrrr}r|r)rZrrrout1rrrrs      zAbstractFileSystem.infocCstt||dS)aUnique value for current version of file If the checksum is the same from one moment to another, the contents are guaranteed to be the same. If the checksum changes, the contents *might* have changed. This should normally be overridden; default will probably capture creation/modification timestamp (which would be good) or maybe access timestamp (which would be bad) re)rfrrrrrrchecksums zAbstractFileSystem.checksumcCs||ddS)zSize in bytes of filerN)rr"rrrrrzAbstractFileSystem.sizecsfdd|DS)z-Size in bytes of each file in a list of pathscror)rrrr^rrrtruz,AbstractFileSystem.sizes..r)rZpathsrr^rrrzAbstractFileSystem.sizescCs*z ||ddkWStyYdSw)zIs this entry directory-like?rjrF)rrrrrrrs  zAbstractFileSystem.isdircCs"z ||ddkWSYdS)zIs this entry file-like?rjfileFrrrrrrszAbstractFileSystem.isfilecKsH|j|fd|||d| }|WdS1swYdS)zGet the contents of the file as a string. Parameters ---------- path: str URL of file on this filesystems encoding, errors, newline: same as `open`. rmodeencodingerrorsnewlineNopenread)rZrrrrrrrrr read_texts $zAbstractFileSystem.read_textcKsJ|j|fd|||d| }||WdS1swYdS)aWrite the text to the given file. An existing file will be overwritten. Parameters ---------- path: str URL of file on this filesystems value: str Text to write. encoding, errors, newline: same as `open`. wrN)rwrite)rZrvaluerrrrrrrr write_texts$zAbstractFileSystem.write_textcKs|j|dfi|B}|dur$|dkr||n |td|j||durA|dkr1|j|}|||WdS|WdS1sOwYdS)ahGet the content of a file Parameters ---------- path: URL of file on this filesystems start, end: int Bytes limits of the read. If negative, backwards from end, like usual python slices. Either can be None for start or end of file, respectively kwargs: passed to ``open()``. rbNr)rseekmaxrrtell)rZrstartendrrrrrcat_files    $zAbstractFileSystem.cat_file overwritecKsZ|dkr ||r t|j|dfi|}||WddS1s&wYdS)zSet the bytes of given filecreatewbN)rFileExistsErrorrr)rZrrrrrrrr pipe_file s  "zAbstractFileSystem.pipe_filecKsjt|tr|j|||fi|dSt|tr1|D]\}}|j|||fi|qdStd)aPut value into path (counterpart to ``cat``) Parameters ---------- path: string or dict(str, bytes) If a string, a single remote location to put ``value`` bytes; if a dict, a mapping of {path: bytesvalue}. value: bytes, optional If using a single path, these are the bytes to put there. Ignored if ``path`` is a dict zpath must be str or dictN)rirzrrqdictrr)rZrrrkvrrrpipes  zAbstractFileSystem.pipec Ks|durtt|ts tt|ts|gt|}t|ts%|gt|}t|t|ks5t|t|kr7tg}t|||D].\}} } z |||| | Wq?t ym} z|dkrb|| nWYd} ~ q?d} ~ ww|S)aYGet the contents of byte ranges from one or more files Parameters ---------- paths: list A list of of filepaths on this filesystems starts, ends: int or list Bytes limits of the read. If using a single int, the same value will be used to read all the specified files. Nr) r]riry TypeErrorr|rziprr  Exception) rZrstartsendsmax_gaprrrrssrrrr cat_ranges,s,       zAbstractFileSystem.cat_rangesrc Ks|j||d}t|dkst|ts|d||krPi}|D].}z |j|fi|||<WqtyM}z|dkr;|dkrC|||<WYd}~qd}~ww|S|j|dfi|S)aFetch (potentially multiple) paths' contents Parameters ---------- recursive: bool If True, assume the path(s) are directories, and get all the contained files on_error : "raise", "omit", "return" If raise, an underlying exception will be raised (converted to KeyError if the type is in self.missing_exceptions); if omit, keys with exception will simply not be included in the output; if "return", all keys are included in the output, but the value will be bytes or an exception instance. kwargs: passed to cat_file Returns ------- dict of {path: contents} if there are multiple paths or the path has been otherwise expanded  recursiverrrrN) expand_pathr|riryrqr r)rZrrrrrrrrrrcatNs$ zAbstractFileSystem.catc Ksddlm}t|r |}n||rtj|dddS|dd}|j||dd|j|dfi|N}|dur>t|d}z1|t |d dd} | rf| |j } | | } | dur_t | } || | sLWt|so|n t|sy|wwWddS1swYdS) z Copy single remote file to localr)LocalFileSystemTrN) auto_mkdirrrr)implementations.localr!rrr&rrrset_sizer,r blocksizerr|relative_updateclose) rZrpathlpathcallbackoutfilerr!fsf1data segment_lenrrrget_filevs<        "zAbstractFileSystem.get_filec s^t|trt|tr|}|}nhddlm} m} mt|t} j|||d}| r<|r.|dur<fdd|D}|s.rflattenr+)riryr$r!r3r4rzrr|rrrr%wraprbranchedr1)rZr)r*rr+rrrpathslpathsr!r3 source_is_strsource_is_file dest_is_dirrchildrr8rr"sB     zAbstractFileSystem.getc Ks*|dkr ||r ttj|r|j|dddSt|dl}|dd}|||d|j | t |dd|j|dfi|,}| |krl| |j} || } | durat| } || | |ksNWdn1svwYWddSWddS1swYdS) zCopy single file to remoter Tr"Nrrrxr)rrr&rrrrrr%mkdirsrfspathrrr&rr|r') rZr*r)r+rrr.rf2r/r0rrrput_files.          "zAbstractFileSystem.put_filec st|trt|tr|}|}nzddlm} m} mt|t} | r$| |}| j|||d}| rE|r7|durEfdd|D}|sEdSt|dk} t|toX|pX |} t|trc |nfdd|D}| ot |rt| pt | o| o| }t |||| d}| t||t||D]&\}}|||}j||fd |i|Wdn1swYqdS) aCopy file(s) from local. Copies a specific file or tree of files (if recursive=True). If rpath ends with a "/", it will be assumed to be a directory, and target files will go within. Calls put_file for each source. rr2r5Ncr6rr7rr)r-r4rrrtrz*AbstractFileSystem.put..crorrprrr^rrrtrur9r+)riryr$r!r3r4rzrr|rrqrrr%r;rr<rF)rZr*r)rr+rrr=r>r!r3r?r@rArrBr)r-rZr4rputsL     zAbstractFileSystem.putcCs:||d }||WdS1swYdS)z&Get the first ``size`` bytes from filerNrrZrrrrrrhead,s$zAbstractFileSystem.headcCsP||d}|t| |j d|WdS1s!wYdS)z%Get the last ``size`` bytes from filerrxN)rrrrrrIrrrtail1s$zAbstractFileSystem.tailcKr[rr\rZpath1path2rrrrcp_file7zAbstractFileSystem.cp_filec s<|dur |r d}n|durd}t|trt|tr|}|}nZddlmt|t} j|||d}| rG|r9|durGfdd|D}|sGdSt|dk} t|toZ|pZ|} | ont|rc| pnt| on| on| } t ||| | d }t ||D]\} }z j | |fi|Wq}t y|dkrYq}wdS) a?Copy within two locations in the filesystem on_error : "raise", "ignore" If raise, any not-found exceptions will be raised; if ignore any not-found exceptions will cause the path to be skipped; defaults to raise unless recursive is true, where the default is ignore Nignorerr)r4r5cr6rr7rrr8rrrtUrz+AbstractFileSystem.copy..r9) riryr$r4rzrr|rrrrrOr)rZrMrNrrrrpaths1paths2r?r@rArp1p2rr8rcopy:sJ       zAbstractFileSystem.copyc  s4|dur |dkr tdt|ttjfr|g||}nst}fdd|D}|D]d}t|rhtj|fd|i|}||O}|rg|durM|dkrMq+|tjt |f||dur^|dndd|O}q+|r}tj |f|dd d |}||O}||vr|d us |r| |q+|st |t|S) zTurn one or more globs or directories into a list of all matching paths to files or directories. kwargs are passed to ``glob`` or ``find``, which may in turn call ``ls`` Nrrcrorrprrr^rrrt~ruz2AbstractFileSystem.expand_path..rr5TFr)rrirzr&PathLikersetrrryrraddrr) rZrrrrrrsbitrecrr^rrpsR zAbstractFileSystem.expand_pathcKs>||kr td|dS|j||||dd|j||ddS)z)Move file(s) from one location to anotherz6%s mv: The paths are the same, so no files were moved.r)rronerrorrN)loggerdebugrVrm)rZrMrNrrrrrrmvs  zAbstractFileSystem.mvcCs||dS)z Delete a fileN)_rmrrrrrm_filezAbstractFileSystem.rm_filecCr[)zDelete one filer\rrrrraszAbstractFileSystem._rmcCs,|j|||d}t|D]}||q dS)aDelete files. Parameters ---------- path: str or list of str File(s) to delete. recursive: bool If file(s) are directories, recursively delete contents and then also remove the directory maxdepth: int or None Depth to pass to walk for finding files to delete, if recursive. If None, there will be no limit and infinite recursion may be possible. r5N)rreversedrb)rZrrrrsrrrr_s  zAbstractFileSystem.rmcCs:||}d|vr|ddd|j}|j|S|jS)NrKrr)rqrlstripr~)rrrrrrrs  zAbstractFileSystem._parentrcKst|||||fd|i|S)z4Return raw bytes-mode file-like from the file-system cache_options)AbstractBufferedFile)rZrr block_size autocommitrfrrrr_opens zAbstractFileSystem._openc sddl}||}d|vr3|ddd}fdddD}|j|j||f|||d fi|Sd |j } |j|f||| |d } |durjdd lm } dd l m } | ||}| |} | | |dd} | swd|vrw|j j | | S)a  Return a file-like object from the filesystem The resultant instance must function correctly in a context ``with`` block. Parameters ---------- path: str Target file mode: str like 'rb', 'w' See builtin ``open()`` Mode "x" (exclusive write) may be implemented by the backend. Even if it is, whether it is checked up front or on commit, and whether it is atomic is implementation-dependent. block_size: int Some indication of buffering - this is a value in bytes cache_options : dict, optional Extra arguments to pass through to the cache. compression: string or None If given, open file using compression codec. Can either be a compression name (a key in ``fsspec.compression.compr``) or "infer" to guess the compression from the filename suffix. encoding, errors, newline: passed on to TextIOWrapper for text mode rNbtrNcs i|] }|vr||qSr)r7)r-rrrrr s  z+AbstractFileSystem.open..)rrr)rhrf compressionri)rrhrirf)compr)get_compression)rr)iorqreplace TextIOWrapperrr7rSrjfsspec.compressionro fsspec.corerprrr)rZrrrhrfrnrrq text_kwargsacrrorpcompressrrmrrsR"        zAbstractFileSystem.opencKsL|s||s$|j|dfi| WddS1swYdSt)a!Create empty file, or update timestamp Parameters ---------- path: str file location truncate: bool If True, always set file size to 0; if False, update timestamp and leave file unchanged, if backend allows this rN)rrr])rZrtruncaterrrrtouch2s  "zAbstractFileSystem.touchcCstt||S)z2Hash of file properties, to tell if it has changed)rrzrencode hexdigestrrrrukeyCszAbstractFileSystem.ukeycCsl||d&}|j}|dur|}|dur|||kr||}t||||WdS1s/wYdS)aRead a block of bytes from Starting at ``offset`` of the file, read ``length`` bytes. If ``delimiter`` is set then we ensure that the read starts and stops at delimiter boundaries that follow the locations ``offset`` and ``offset + length``. If ``offset`` is zero then we start at zero. The bytestring returned WILL include the end delimiter string. If offset+length is beyond the eof, reads to eof. Parameters ---------- fn: string Path to filename offset: int Byte offset to start read length: int Number of bytes to read. If None, read to end. delimiter: bytes (optional) Ensure reading starts and stops at delimiter bytestring Examples -------- >>> fs.read_block('data/file.csv', 0, 13) # doctest: +SKIP b'Alice, 100\nBo' >>> fs.read_block('data/file.csv', 0, 13, delimiter=b'\n') # doctest: +SKIP b'Alice, 100\nBob, 200\n' Use ``length=None`` to read to the end of the file. >>> fs.read_block('data/file.csv', 0, None, delimiter=b'\n') # doctest: +SKIP b'Alice, 100\nBob, 200\nCharlie, 300' See Also -------- :func:`fsspec.utils.read_block` rN)rrr)rZfnoffsetlength delimiterrrrrrrGs% $zAbstractFileSystem.read_block)include_passwordrboolcCs(ddlm}tj|td|fd|idS)a JSON representation of this filesystem instance. Parameters ---------- include_password: bool, default True Whether to include the password (if any) in the output. Returns ------- JSON string with keys ``cls`` (the python location of this class), protocol (text name of this class's protocol, first one in case of multiple), ``args`` (positional args, usually empty), and all other keyword arguments as their own keys. Warnings -------- Serialized filesystems may contain sensitive information which have been passed to the constructor, such as passwords and tokens. Make sure you store and send them in a secure environment! rFilesystemJSONEncoder_FilesystemJSONEncoderrr/)jsonrdumpsrj)rZrrrrrto_jsonts zAbstractFileSystem.to_jsonblobcCsddlm}tj||dS)a Recreate a filesystem instance from JSON representation. See ``.to_json()`` for the expected structure of the input. Parameters ---------- blob: str Returns ------- file system instance, not necessarily of this particular class. Warnings -------- This can import arbitrary modules (as determined by the ``cls`` key). Make sure you haven't installed any modules that may execute malicious code at import time. rFilesystemJSONDecoderr/)rrloads)rrrrr from_jsons zAbstractFileSystem.from_jsoncCsddlm}|}t|}|j}t|j}|s|ddtd|jd|jt |t t fr2|dn|| |j d| |S) a JSON-serializable dictionary representation of this filesystem instance. Parameters ---------- include_password: bool, default True Whether to include the password (if any) in the output. Returns ------- Dictionary with keys ``cls`` (the python location of this class), protocol (text name of this class's protocol, first one in case of multiple), ``args`` (positional args, usually empty), and all other keyword arguments as their own keys. Warnings -------- Serialized filesystems may contain sensitive information which have been passed to the constructor, such as passwords and tokens. Make sure you store and send them in a secure environment! rrpasswordN:r)rrMrr)rrrjrMrr>r7rFrErir3rymake_serializabler=)rZrr json_encoderrprotor>rrrto_dicts    zAbstractFileSystem.to_dictdctcCsnddlm}|}t|}||}|durtd|dd|dd|||ddi||S) a Recreate a filesystem instance from dictionary representation. See ``.to_dict()`` for the expected structure of the input. Parameters ---------- dct: Dict[str, Any] Returns ------- file system instance, not necessarily of this particular class. Warnings -------- This can import arbitrary modules (as determined by the ``cls`` key). Make sure you haven't installed any modules that may execute malicious code at import time. rrNz#Not a serialized AbstractFileSystemrrMrr)rrrtry_resolve_fs_clsrr7unmake_serializable)rr json_decoderrrrr from_dicts    zAbstractFileSystem.from_dictcC|S)zW Make a version of the FS instance which will be acceptable to pyarrow rr^rrr_get_pyarrow_filesystemr`z*AbstractFileSystem._get_pyarrow_filesystemcCsddlm}||||||dS)zCreate key/value store based on this file-system Makes a MutableMapping interface to the FS at the given root path. See ``fsspec.mapping.FSMap`` for further details. r)FSMap)checkr missing_exceptions)mappingr)rZrrr rrrrr get_mappers zAbstractFileSystem.get_mappercCs|jdS)a Clear the cache of filesystem instances. Notes ----- Unless overridden by setting the ``cachable`` class attribute to False, the filesystem class stores a reference to newly created instances. This prevents Python's normal rules around garbage collection from working, since the instances refcount will not drop to zero until ``clear_instance_cache`` is called. N)r%r8r/rrrclear_instance_caches z'AbstractFileSystem.clear_instance_cachecCr[)z=Return the created timestamp of a file as a datetime.datetimer\rrrrcreated#rzAbstractFileSystem.createdcCr[)z>Return the modified timestamp of a file as a datetime.datetimer\rrrrmodified'rzAbstractFileSystem.modifiedrxrrecursion_limitrf max_display display_sizeprefixis_lastfirst indent_sizec  Csd*dd} g} |r| ||r]d|} |j|dd } | jd d d |d ur;t| |kr;| d |} t| |}n| } d}t| D]\}}|t| dkoR|dk}|r]dd|dndd|d}|d7}||rn| ndd|d}tj|dd}|r|ddkr|j|dddd }t dd|D}t dd|D}|dkr|dkrd}n^|dkrd|d|dkrdndd }nJ|dkrd|d!|dkrdndd }n6d|d!|dkrdndd"|d|dkrdndd }n|r|dd#krd| |d$dd }nd}| |||||ddkr@|dkr@| |j |dd|d||||d%|d&qC|dkr]|d'}| |dd|dd|d( d)d| DS)+a Return a tree-like structure of the filesystem starting from the given path as a string. Parameters ---------- path: Root path to start traversal from recursion_limit: Maximum depth of directory traversal max_display: Maximum number of items to display per directory display_size: Whether to display file sizes prefix: Current line prefix for visual tree structure is_last: Whether current item is last in its level first: Whether this is the first call (displays root path) indent_size: Number of spaces by indent Returns ------- str: A string representing the tree structure. Example ------- >>> from fsspec import filesystem >>> fs = filesystem('ftp', host='test.rebex.net', user='demo', password='password') >>> tree = fs.tree(display_size=True, recursion_limit=3, indent_size=8, max_display=10) >>> print(tree) nrfrrzcSs>dD]\}}|d|kr||dd|dSq|dS)zFormat bytes as text.))Pl )Tl)Gi@)Mi)rrHg?z.2f rkBr)rrrrrr format_bytesQs   z-AbstractFileSystem.tree..format_bytesrT)rcSs|ddk|ddfS)NrjrrrNr")xrrrgrz)AbstractFileSystem.tree..)keyNrru└u─rxu├u│rrNrjrcs"|] }|ddkrdVqdS)rjrrNrr-sub_itemrrrr0sz*AbstractFileSystem.tree..csr)rjrrNrrrrrr0sz (empty folder)z (z subfolderr)z file, rrF)rrrrrrrrz more item(s) not displayed. css|]}|r|VqdSrr)r-rrrrr0r)rrfrrz) rrsortr| enumerater&rbasenamer"rtreejoin)rZrrrrrrrrrresultindentcontentsdisplayed_contentsremaining_countiitem is_last_itembranch new_prefixr sub_contents num_files num_foldersr more_messagerrrr+s &     8  zAbstractFileSystem.treecK|j|f||d|S)z'Alias of `AbstractFileSystem.cat_file`.r r )r )rZrr r rrrr read_byteszAbstractFileSystem.read_bytescKs|j||fi|dS)z(Alias of `AbstractFileSystem.pipe_file`.N)r)rZrrrrrr write_bytesrzAbstractFileSystem.write_bytescK|j|fd|i|S)z$Alias of `AbstractFileSystem.mkdir`.r)rrrrrmakedirzAbstractFileSystem.makedircCs|j||dS)z'Alias of `AbstractFileSystem.makedirs`.r")rrrrrrCrczAbstractFileSystem.mkdirscKr)z!Alias of `AbstractFileSystem.ls`.r)rrrrrlistdirrzAbstractFileSystem.listdircK|j||fi|S)z#Alias of `AbstractFileSystem.copy`.)rVrLrrrcpzAbstractFileSystem.cpcKrz!Alias of `AbstractFileSystem.mv`.r`rLrrrmoverzAbstractFileSystem.movecKs|j|fi|S)z#Alias of `AbstractFileSystem.info`.rrrrrstatrzAbstractFileSystem.statcKr)z!Alias of `AbstractFileSystem.du`.)rr)r)rZrrrrrrr disk_usagerzAbstractFileSystem.disk_usagecKrrrrLrrrrenamerzAbstractFileSystem.renamecCs|j|||dS)z!Alias of `AbstractFileSystem.rm`.r5)r_)rZrrrrrrdeleteszAbstractFileSystem.deletecK|j||fd|i|S)z"Alias of `AbstractFileSystem.put`.r)rG)rZr*r)rrrrruploadrzAbstractFileSystem.uploadcKr)z"Alias of `AbstractFileSystem.get`.rr)rZr)r*rrrrrdownloadrzAbstractFileSystem.downloaddcKstd)aCreate a signed URL representing the given path Some implementations allow temporary URLs to be generated, as a way of delegating credentials. Parameters ---------- path : str The path on the filesystem expiration : int Number of seconds to enable the URL for (if supported) Returns ------- URL : str The signed URL Raises ------ NotImplementedError : if method is not implemented for a filesystem z+Sign is not implemented for this filesystemr\)rZr expirationrrrrsignszAbstractFileSystem.signcCr)NFrr^rrr _isfilestorer`zAbstractFileSystem._isfilestore)rrzrrzr)TF)NTr)NFF)TNF)NNN)NN)r )Nr)Fr)rH)FNN)FN)rNTN)rNNN)rrrrz)rrzrrJ)rrrrO)rrOrrJ)rNFFN)rKrxrFrNTTr)rrzrrfrrfrrrrzrrrrrrfrrz)TN)r)hrErFrGrHr9rRr&rrM__annotations__r:r?r2r~r rr4r!propertyr_rbrdrgrmrn classmethodrqr staticmethodrrrrrrrrrrrrrrrrrrrrrrrrrr rrrr r r1r"rFrGrJrKrOrVrr`rbrar_rrjrrzr}rrrrrrrrrrrrrrrCrrrrrrrrrrrrrrrrJas  )           )  ^ & "O "      "(" ?  B  6 0      N -! ( &             rJ) metaclassc@sdeZdZdZdZdZ      dPdd Zed d Zej d d Zed dZ eddZ e j ddZ ddZ ddZ ddZddZddZddZdQdd Zd!d"ZdRd$d%ZdRd&d'Zd(d)Zd*d+ZdSd-d.Zd/d0ZdTd2d3Zd4d5Zd6d7Zd8d9Zd:d;Zdd?Z d@dAZ!dBdCZ"dDdEZ#dFdGZ$dHdIZ%dJdKZ&e&Z'dLdMZ(dNdOZ)dS)Urga?Convenient class to derive from to provide buffering In the case that the backend does not provide a pythonic file-like object already, this class contains much of the logic to build one. The only methods that need to be overridden are ``_upload_chunk``, ``_initiate_upload`` and ``_fetch_range``. iPNrdefaultT readaheadc Ksddlm} ||_||_||_|dvr|jn||_d|_||_d|_ d|_ d|_ |dur.i}d| vr?t dt| d|d<| |_|d vrJtd |d krn|durV||_n|jd |_| ||j|j|jfi||_dSt|_d|_d|_d|_dS) a Template for files with buffered reading and writing Parameters ---------- fs: instance of FileSystem path: str location in file-system mode: str Normal file modes. Currently only 'wb', 'ab' or 'rb'. Some file systems may be read-only, and some may not support append. block_size: int Buffer size for reading or writing, 'default' for class default autocommit: bool Whether to write to final destination; may only impact what happens when file is being closed. cache_type: {"readahead", "none", "mmap", "bytes"}, default "readahead" Caching policy in read mode. See the definitions in ``core``. cache_options : dict Additional options passed to the constructor for the cache specified by `cache_type`. size: int If given and in read mode, suppressed having to look up the file size kwargs: Gets stored as self.kwargs r)caches)rNrNFtrimzyPassing 'trim' to control the cache behavior has been deprecated. Specify it within the 'cache_options' argument instead.>abrrxbzFile mode not supportedrr)corerrr-rDEFAULT_BLOCK_SIZEr&locrir r closedrWrXrYr7rr]rdetails _fetch_rangecacherqBytesIObufferrforcedlocation) rZr-rrrhri cache_typerfrrrrrrr!sF &    zAbstractBufferedFile.__init__cCs |jdur |j|j|_|jSr)_detailsr-rrr^rrrrfs zAbstractBufferedFile.detailscCs||_|d|_dS)Nr)rr)rZrrrrrlscCst|j|jSr)rrr-r^rrr full_nameqrczAbstractBufferedFile.full_namecCs t|ddS)N_closedTr+r^rrrrus zAbstractBufferedFile.closedcCs ||_dSr)r)rZcrrrr{s cCs"d|jvr t|Stt|jdS)Nrre)ridrfrrr^rrrrgs zAbstractBufferedFile.__hash__cCs>||urdSt|t|o|jdko|jdkot|t|kS)zAFiles are equal if they have the same checksum, only in read modeTr)rirjrhashrkrrrrmszAbstractBufferedFile.__eq__cCr)z#Move from temp to final destinationNrr^rrrcommitzAbstractBufferedFile.commitcCr)zThrow away temporary fileNrr^rrrdiscardr zAbstractBufferedFile.discardcCs|r|jStd)z File information about this pathz Info not available while writing)readablerrr^rrrrszAbstractBufferedFile.infocCra)zCurrent file location)rr^rrrrrczAbstractBufferedFile.tellrcCs~t|}|jdksttd|dkr|}n|dkr|j|}n|dkr)|j|}ntd|d|dkr9td||_|jS) zSet current file location Parameters ---------- loc: int byte location whence: {0, 1, 2} from start of file, current location or end of file, resp. rz Seek only available in read moderrrxzinvalid whence (z, should be 0, 1 or 2)zSeek before start of file)rfrrrrrr)rZrwhencenlocrrrrs    zAbstractBufferedFile.seekcCsb|std|jrtd|jrtd|j|}|j|7_|j|jkr/| |S)z Write data to buffer. Buffer only sent on flush() or if buffer is greater than or equal to blocksize. Parameters ---------- data: bytes Set of bytes to be written. zFile not in write modeI/O operation on closed file.z0This file has been force-flushed, can only close) writablerrrrrrrr&flush)rZr/rrrrrs  zAbstractBufferedFile.writeFcCs|jrtd|r|jrtd|rd|_|rdS|s'|j|jkr'dS|jdur=d|_z|Wnd|_|j |ddurX|j|j dd7_t |_dSdS) a{ Write buffered data to backend store. Writes the current buffer, if it is larger than the block-size, or if the file is being closed. Parameters ---------- force: bool When closing, write the last block even if it is smaller than blocks are allowed to be. Disallows further writing to this file. zFlush on closed filez+Force flush cannot be called more than onceTNr)finalFrx) rrrr rrr&r_initiate_upload _upload_chunkrrqr)rZforcerrrrs*   zAbstractBufferedFile.flushcCr)zWrite one part of a multi-block file upload Parameters ========== final: bool This is the last block, so should complete file, if self.autocommit is True. Nr)rZrrrrrr z"AbstractBufferedFile._upload_chunkcCr)zCreate remote file/uploadNrr^rrrrrz%AbstractBufferedFile._initiate_uploadcCs|jj|j||dS)z*Get the specified set of bytes from remoter)r-r r)rZr r rrrr rz!AbstractBufferedFile._fetch_rangercCs|durdnt|}|jdkrtd|dkr|j|j}|jr$td|dkr*dS|j|j|j|}t d||j|j||j |jt |7_|S) z Return data from cache, or fetch pieces as necessary Parameters ---------- length: int (-1) Number of bytes to read; if <0, all remaining bytes. NrrzFile not in read moderrz%s read: %i - %i %s) rfrrrrrr_fetchr]r^ _log_statsr|)rZrrrrrrs&  zAbstractBufferedFile.readcCs2t|d}||j}||dt|<t|S)zxmirrors builtin file's readinto method https://docs.python.org/3/library/io.html#io.RawIOBase.readinto rN) memoryviewcastrnbytesr|)rZrkrr/rrrreadinto/s zAbstractBufferedFile.readinto cCsg} |}||p |j}t|dkrn(||}|dkr8||d|t||||t|n||qd|S)aReturn data between current position and first occurrence of char char is included in the output, except if the end of the tile is encountered first. Parameters ---------- char: bytes Thing to find blocks: None or int How much to read in each go. Defaults to file blocksize - which may mean a new read on every call. TrrNr)rrr&r|rrrr)rZcharblocksrr partfoundrrr readuntil9s    zAbstractBufferedFile.readuntilcCs |dS)zRead until and including the first occurrence of newline character Note that, because of character encoding, this is not necessarily a true line ending. r)r#r^rrrreadlineUs zAbstractBufferedFile.readlinecCs|}|r|Str)r$ StopIteration)rZrrrr__next__]szAbstractBufferedFile.__next__cCrrrr^rrr__iter__crPzAbstractBufferedFile.__iter__cCsD|}|d}dd|ddD}|dr|S||dgS)zPReturn all data, split by the newline character, including the newline characterrcSsg|]}|dqS)rr)r-lrrrrtjsz2AbstractBufferedFile.readlines..Nr)rsplitr)rZr/linesrrrr readlinesfs   zAbstractBufferedFile.readlinescCrr)r)rZrkrrr readinto1qs zAbstractBufferedFile.readinto1cCst|ddrdS|jr dSz;|jdkrd|_n&|js |jdd|jdurC|j|j|j|j |jWd|_dSWd|_dSWd|_dSd|_w)z=Close file Finalizes writes, discards cache _unclosableFNrT)r) r,rrrrrr-rrrr^rrrr(ts"      zAbstractBufferedFile.closecCsd|jvo|j S)zWhether opened for readingrrrr^rrrr rzAbstractBufferedFile.readablecCs|S)z'Whether is seekable (only in read mode))r r^rrrseekableszAbstractBufferedFile.seekablecCs|jdvo|j S)zWhether opened for writing>rrrr.r^rrrrrzAbstractBufferedFile.writablec CsJ|jdkr tdt|j|j|j|j|j|j|j|j r|j j nd|j f fS)Nrz*Pickling a writeable file is not supportednone) r RuntimeErrorreopenr-rr&rrrirrrr^rrrrns zAbstractBufferedFile.__reduce__cCs|js |dSdSr)rr(r^rrr__del__s zAbstractBufferedFile.__del__cCsdt|jjd|jdS)Nz)rjr-rErr^rrr__str__szAbstractBufferedFile.__str__cCrrrr^rrr __enter__rPzAbstractBufferedFile.__enter__cGs |dSr)r()rZrrrr__exit__rhzAbstractBufferedFile.__exit__)rrTrNN)rr)r)rN)*rErFrGrHrrr!rrsetterrrrgrmr r rrrrrrrrrrr#r$r&r'r+r,r(r r/rrnr3r5__repr__r6r7rrrrrg sf Q         *     rgc Cs4|j|f|||||d|} |dkr| || S)N)rrhrirrr)rr) r-rrr&rrrirrrrrrr2s r2), __future__rrqrloggingr&r5rWr#errnorrrhashlibrtypingrr callbacksr configr r rVr rr utilsrrrrrrr getLoggerr]rrjrrJIOBasergr2rrrrsN       $ =5 0