U `{j=@sdZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z Gdddej ZGd d d eZGd d d eZGd ddZdS)z Post-processing hooks N)ZipFile)TarFile) get_loggerc@sPeZdZdZd ddZeejddZejddZ ejd d Z d d Z dS)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`). NcCs||_||_dSN)members extract_dir)selfrr r O/var/www/html/bwave/python/venv/lib/python3.8/site-packages/pooch/processors.py__init__/szExtractorProcessor.__init__cCsdS)z String appended to unpacked archive folder name. Only used if extract_dir is None. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr r r r r suffix3szExtractorProcessor.suffixcCsdS)zf Return all the members in the archive. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr )r fnamer r r _all_members<szExtractorProcessor._all_memberscCsdS)z This method receives an argument for the archive to extract and the destination path. MUST BE IMPLEMENTED BY CHILD CLASSES. Nr )r rr r r r _extract_fileCsz ExtractorProcessor._extract_filec s0jdkr|j_n(|jtjjddd}tj|j_jdksPjs\|}nj}|dkstj jrt fdd|Dstj jdd  |jg}t jD]n\}}} | D]^} tjtjtj|j| jdkstfd djDr|tj|| qq|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. Nr)maxsplitrupdatedownloadc3s&|]}tjtjj|VqdSr)ospathexistsjoinr .0mrr r ssz.ExtractorProcessor.__call__..T)exist_okc3s |]}tj|VqdSr) startswithrrnormpathr)relpathr r rs)r rrsplitrrseprrrrallmakedirsrwalkr!r"anyappend) r ractionpooch archive_dirrfnamesr_filesfilenamer )r"r r __call__Ks8    zExtractorProcessor.__call__)NN) __name__ __module__ __qualname____doc__r propertyabcabstractmethodrrrr1r r r r rs    rc@s,eZdZdZeddZddZddZdS) 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`). cCsdS)l String appended to unpacked archive folder name. Only used if extract_dir is None. z.unzipr rr r r rsz Unzip.suffixc Cs*t|d}|W5QRSQRXdS)(Return all members from a given archive.rN)rnamelist)r rzip_filer r r rs zUnzip._all_membersc st|dp}|jdkr4td|||j|dnB|jD]:td||fdd|D}|j||dq:W5QRXdS) o This method receives an argument for the archive to extract and the destination path. r<Nz"Unzipping contents of '%s' to '%s'r!Extracting '%s' from '%s' to '%s'cs*g|]"}tj|tjr|qSr )rrr!r )rnamememberr r sz'Unzip._extract_file..rr)rrrinfo extractallr=)r rr r>subdir_membersr rCr rs&    zUnzip._extract_fileNr2r3r4r5r6rrrr r r r r9s  r9c@s,eZdZdZeddZddZddZdS) 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`). cCsdS)r:z.untarr rr r r rsz Untar.suffixc Cs6t|d }dd|DW5QRSQRXdS)r;r<cSsg|] }|jqSr )rBrrGr r r rEsz&Untar._all_members..N)ropen getmembers)r rtar_filer r r rszUntar._all_membersc st|dp}|jdkr6td|||j|dnB|jD]:td||fdd|D}|j||dq.rF)rrMrrrGrHrN)r rr rOrIr rCr rs&   zUntar._extract_fileNrJr r r r rKs  rKc@sFeZdZdZdeeeedZddddZdd d Z d d Z d dZ dS) 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)autolzmaxzgzipbzip2rRrTrU)z.xzz.gzz.bz2rQcCs||_||_dSr)methodrB)r rVrBr r r r NszDecompress.__init__c Cs|jdkr|d}ntjtj||j}|dks@tj|std|||j| |}t |d(}| |}t ||W5QRXW5QRX|S)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) rBrrrdirnamerrrGrV_compression_modulerMshutil copyfileobj)r rr*r+ decompressedmoduleoutput compressedr r r r1Rs      zDecompress.__call__cCsd}|j|jkrNd|jdt|jd}|jdkrFd||g}t||jdkrtj|d}||j krd |dt|j d}|d krd||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'.>ziptar rQzUnrecognized file extension '>.zip.tar) rVmoduleslistkeysr ValueErrorrrsplitext extensions)r rZerror_archivesmessageextr r r rX~s"    zDecompress._compression_module)rQN) r2r3r4r5rRrTbz2rerjr r1rXr r r r rPs +  ,rP)r5r7rrmrTrRrYzipfilertarfilerutilsrABCrr9rKrPr r r r s   tHL