o a&iL5@sdZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z GdddZ Gd d d e Z Gd d d e ZGd ddZdS)z Post-processing hooks N)ZipFile)TarFile) get_loggerc@s.eZdZdZdZd ddZddZddZdS) ExtractorProcessoraF 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. NcC||_||_dSN)members extract_dir)selfr r r ;C:\wamp64\www\opt\env\Lib\site-packages\pooch/processors.py__init__+ zExtractorProcessor.__init__cCs|jdur|jdurtd|jdur||j|_n|jtjjddd}tj||j|_|dvs9tj|jsHtj |jdd| ||jd d t |jD}|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. NzVDerived classes must define either a 'suffix' attribute or an 'extract_dir' attribute.r)maxsplitrupdatedownloadT)exist_okcSs*g|]\}}}|D] }tj||q qSr )ospathjoin).0r_filesfnamer r r Xs z/ExtractorProcessor.__call__..) suffixr NotImplementedErrorrsplitrrseprexistsmakedirs _extract_filewalk)r ractionpooch archive_dirfnamesr r r __call__/s  zExtractorProcessor.__call__cCst)z This method receives an argument for the archive to extract and the destination path. MUST BE IMPLEMENTED BY CHILD CLASSES. )r)r rr r r r r#_sz ExtractorProcessor._extract_file)NN)__name__ __module__ __qualname____doc__rrr)r#r r r r rs   0rc@eZdZdZdZddZdS)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`). z.unzipcst|dF}|jdurtd|||j|dn!|jD]%td||fdd|D}|j||dqWddSWddS1sNwYdS) o This method receives an argument for the archive to extract and the destination path. rNz"Unzipping contents of '%s' to '%s'r!Extracting '%s' from '%s' to '%s'csg|] }|r|qSr ) startswith)rnamememberr r rs  z'Unzip._extract_file..r r)rr rinfo extractallnamelist)r rr zip_filesubdir_membersr r6r r#s$    "zUnzip._extract_fileNr*r+r,r-rr#r r r r r/g r/c@r.)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`). z.untarcst|dF}|jdurtd|||j|dn!|jD]%td||fdd|D}|j||dqWddSWddS1sOwYdS) r0r1Nz"Untarring contents of '%s' to '%s'r2r3csg|] }|jr|qSr )r5r4)rr9r6r r rs  z'Untar._extract_file..r8)ropenr rr9r: getmembers)r rr Ztar_filer=r r6r r#s$   "zUntar._extract_fileNr>r r r r r@r?r@c@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)autolzmaxzgzipbzip2rErGrH)z.xzz.gzz.bz2rDcCrr)methodr5)r rIr5r r r rrzDecompress.__init__c Cs|jdur |d}n tjtj||j}|dvs tj|shtd|||j| |}t |d,}| |}t ||Wdn1sKwYWd|SWd|S1scwY|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) r5rrrdirnamer!rr9rI_compression_modulerAshutil copyfileobj)r rr%r& decompressedmoduleoutput compressedr r r r)s,       zDecompress.__call__cCsd}|j|jvr'd|jdt|jd}|jdvr#d||g}t||jdkr^tj|d}||j vrVd |dt|j d}|d vrRd||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 rDzUnrecognized file extension '>z.zipz.tar) rImoduleslistkeysr ValueErrorrrsplitext extensions)r rZerror_archivesmessageextr r r rK@s*        zDecompress._compression_module)rDN) r*r+r,r-rErGbz2rVr[rr)rKr r r r rCs+   ,rC)r-rr^rGrErLzipfilertarfilerutilsrrr/r@rCr r r r s   Q;?