xKg=dZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z GddejZGd d eZGd d eZGd dZy)z Post-processing hooks N)ZipFile)TarFile) get_loggerceZdZdZddZeejdZejdZ ejdZ dZ y) ExtractorProcessora Abstract base class for extractions from compressed archives. Subclasses can be used with :meth:`pooch.Pooch.fetch` and :func:`pooch.retrieve` to unzip a downloaded data file into a folder in the local data store. :meth:`~pooch.Pooch.fetch` will return a list with the names of the extracted files instead of the archive. Parameters ---------- members : list or None If None, will unpack all files in the archive. Otherwise, *members* must be a list of file names to unpack from the archive. Only these files will be unpacked. extract_dir : str or None If None, files will be unpacked to the default location (a folder in the same location as the downloaded zip file, with a suffix added). Otherwise, files will be unpacked to ``extract_dir``, which is interpreted as a *relative path* (relative to the cache location provided by :func:`pooch.retrieve` or :meth:`pooch.Pooch.fetch`). Nc ||_||_yN)members extract_dir)selfr r s T/home/alanp/www/video.onchill/myenv/lib/python3.12/site-packages/pooch/processors.py__init__zExtractorProcessor.__init__/s &cy)z String appended to unpacked archive folder name. Only used if extract_dir is None. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr s rsuffixzExtractorProcessor.suffix3rcy)zf Return all the members in the archive. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr)r fnames r _all_memberszExtractorProcessor._all_members<rrcy)z This method receives an argument for the archive to extract and the destination path. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr)r rr s r _extract_filez ExtractorProcessor._extract_fileCrrc N j|jz_n]|jtjj dd}tjj |j_j jsj|}n j}|dvs=tjjjrtfd|Ds=tjjdj|jg}tjjD]\}}} | D]} tjjtjj tjj|j|  jt! fdjDs|j#tjj || |S) a Extract all files from the given archive. Parameters ---------- fname : str Full path of the zipped file in local storage. action : str Indicates what action was taken by :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve`: * ``"download"``: File didn't exist locally and was downloaded * ``"update"``: Local file was outdated and was re-download * ``"fetch"``: File exists and is updated so it wasn't downloaded pooch : :class:`pooch.Pooch` The instance of :class:`pooch.Pooch` that is calling this. Returns ------- fnames : list of str A list of the full path to all files in the extracted archive. r)maxsplitrupdatedownloadc3K|]K}tjjtjjj|Mywr )ospathexistsjoinr ).0mr s r z.ExtractorProcessor.__call__..ss7KRarww||D,<,.s//EQG&&rww'7'7':;\s8;)r rrsplitr!r"sepr$r rr#allmakedirsrwalkr+r,anyappend) r ractionpooch archive_dirr fnamesr"_filesfilenamer,s ` @r__call__zExtractorProcessor.__call__Ks2    #$t{{2D ,,rww{{Q,?BK!ww||K9I9IJD  << t||''.GllG - -GGNN4#3#34KR KK((4 8   ud&6&6 7 ggd&6&67ND!U!''**GGLLt7G7G!H(S<<'3/EI\\/,MM"'',,tX">?"8 r)NN) __name__ __module__ __qualname____doc__rpropertyabcabstractmethodrrrr;rrrrrsg.'        =rrc,eZdZdZedZdZdZy)Unzipa Processor that unpacks a zip archive and returns a list of all files. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to unzip a downloaded data file into a folder in the local data store. The method/function will return a list with the names of the unzipped files instead of the zip archive. The output folder is ``{fname}.unzip``. Parameters ---------- members : list or None If None, will unpack all files in the zip archive. Otherwise, *members* must be a list of file names to unpack from the archive. Only these files will be unpacked. extract_dir : str or None If None, files will be unpacked to the default location (a folder in the same location as the downloaded zip file, with the suffix ``.unzip`` added). Otherwise, files will be unpacked to ``extract_dir``, which is interpreted as a *relative path* (relative to the cache location provided by :func:`pooch.retrieve` or :meth:`pooch.Pooch.fetch`). cy)l String appended to unpacked archive folder name. Only used if extract_dir is None. z.unziprrs rrz Unzip.suffix rcft|d5}|jcdddS#1swYyxYwz(Return all members from a given archive.rN)rnamelist)r rzip_files rrzUnzip._all_memberss& UC H$$&! s'0c t|d5}|j.tjd|||j |n|jD]}tjd||||j Dcgc]O}t jj|jt jj|r|Q}}|j ||dddycc}w#1swYyxYw)o This method receives an argument for the archive to extract and the destination path. rJNz"Unzipping contents of '%s' to '%s'r"!Extracting '%s' from '%s' to '%s'r r") rr rinfo extractallrKr!r"r+r*)r rr rLmembernamesubdir_memberss rrzUnzip._extract_files UC H||# !!8%###5"llFL%%;VUK%-$5$5$7&$7D77++D1<AC9C>9C>>DNr<r=r>r?r@rrrrrrrDrDs&4' RrrDc,eZdZdZedZdZdZy)Untara Processor that unpacks a tar archive and returns a list of all files. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to untar a downloaded data file into a folder in the local data store. The method/function will return a list with the names of the extracted files instead of the archive. The output folder is ``{fname}.untar``. Parameters ---------- members : list or None If None, will unpack all files in the archive. Otherwise, *members* must be a list of file names to unpack from the archive. Only these files will be unpacked. extract_dir : str or None If None, files will be unpacked to the default location (a folder in the same location as the downloaded tar file, with the suffix ``.untar`` added). Otherwise, files will be unpacked to ``extract_dir``, which is interpreted as a *relative path* (relative to the cache location provided by :func:`pooch.retrieve` or :meth:`pooch.Pooch.fetch`). cy)rFz.untarrrs rrz Untar.suffixrGrctj|d5}|jDcgc]}|jc}cdddScc}w#1swYyxYwrI)ropen getmembersrU)r rtar_filerRs rrzUntar._all_memberssG \\% %*2*=*=*?@*?$DII*?@& %@& %sAA A AAc <tj|d5}|j.tj d|||j |n|jD]}tj d||||j Dcgc]Y}tjj|jjtjj|r|[}}|j ||dddycc}w#1swYyxYw)rNrJNz"Untarring contents of '%s' to '%s'rOrPrQ) rr\r rrRrSr]r!r"r+rUr*)r rr r^rTrRrVs rrzUntar._extract_files \\% %||# !!8%###5"llFL%%;VUK%-$7$7$9&$9D77++DII6AAGG,,V4$9#&''['Q)+& %(&)& %sA8DAD -D DDNrWrrrrYrYs'4A !RrrYc@eZdZdZdeeeedZddddZd dZ d Z d Z y) Decompressa3 Processor that decompress a file and returns the decompressed version. Use with :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve` to decompress a downloaded data file so that it can be easily opened. Useful for data files that take a long time to decompress (exchanging disk space for speed). Supported decompression methods are LZMA (``.xz``), bzip2 (``.bz2``), and gzip (``.gz``). File names with the standard extensions (see above) can use ``method="auto"`` to automatically determine the compression method. This can be overwritten by setting the *method* argument. .. note:: To unpack zip and tar archives with one or more files, use :class:`pooch.Unzip` and :class:`pooch.Untar` instead. The output file is ``{fname}.decomp`` by default but it can be changed by setting the ``name`` parameter. .. warning:: Passing in ``name`` can cause existing data to be lost! For example, if a file already exists with the specified name it will be overwritten with the new decompressed file content. **Use this option with caution.** Parameters ---------- method : str Name of the compression method. Can be "auto", "lzma", "xz", "bzip2", or "gzip". name : None or str Defines the decompressed file name. The file name will be ``{fname}.decomp`` if ``None`` (default) or the given name otherwise. Note that the name should **not** include the full (or relative) path, it should be just the file name itself. N)autolzmaxzgzipbzip2rcrerf)z.xzz.gzz.bz2c ||_||_yr )methodrU)r rhrUs rrzDecompress.__init__Ns  rc,|j|dz}nGtjjtjj ||j}|dvstjj |s~t jd|||j|j|}t|d5}|j|5}tj||dddddd|S|S#1swYxYw#1swY|SxYw)aK Decompress the given file. The output file will be either ``{fname}.decomp`` or the given *name* class attribute. Parameters ---------- fname : str Full path of the compressed file in local storage. action : str Indicates what action was taken by :meth:`pooch.Pooch.fetch` or :func:`pooch.retrieve`: - ``"download"``: File didn't exist locally and was downloaded - ``"update"``: Local file was outdated and was re-download - ``"fetch"``: File exists and is updated so it wasn't downloaded pooch : :class:`pooch.Pooch` The instance of :class:`pooch.Pooch` that is calling this. Returns ------- fname : str The full path to the decompressed file. Nz.decomprz-Decompressing '%s' to '%s' using method '%s'.zw+b) rUr!r"r$dirnamer#rrRrh_compression_moduler\shutil copyfileobj)r rr4r5 decompressedmoduleoutput compresseds rr;zDecompress.__call__Rs6 99  9,L77<<(> JL + +277>>,3O L  ?   --e4FlE*f[[':&&z6:(+|('+s$D C=)D =D D  Dcvd}|j|jvr`d|jdt|jjd}|jdvrdj ||g}t ||jdk(rt jj|d}||jvrLd |dt|jjd}|d vrdj ||g}t ||j|j|S|j|jS) a Get the Python module compatible with fname and the chosen method. If the *method* attribute is "auto", will select a method based on the extension. If no recognized extension is in the file name, will raise a ValueError. z:To unpack zip/tar archives, use pooch.Unzip/Untar instead.zInvalid compression method 'z'. Must be one of 'z'.>tarzip rbzUnrecognized file extension '>.tar.zip) rhmoduleslistkeysr$ ValueErrorr!r"splitext extensions)r rerror_archivesmessageexts rrkzDecompress._compression_module~s1V ;;dll *.t{{m<##' (9(9(;#<"=RA {{n,((G^#<=W% % ;;& ''""5)"-C$//)3C59''+DOO,@,@,B'C&DBH**!hh'@AG ))<< 45 5||DKK((r)rbN) r<r=r>r?rcrebz2ryr~rr;rkrrrraras6)VTtcRG@J*X)rra)r?rAr!rrercrlzipfilertarfilerutilsrABCrrDrYrarrrrsj qqhER ERPIR IRX{){)r