Check if file is zip python
Source code: Lib/zipfile.py Show
The ZIP file format is a common archive and compression standard. This module provides tools to create, read, write, append, and list a ZIP file. Any advanced use of this module will require an understanding of the format, as defined in PKZIP Application Note. This module does not currently handle multi-disk ZIP files. It can handle ZIP files that use the ZIP64 extensions (that is ZIP files that are more than 4 GiB in size). It supports decryption of encrypted files in ZIP archives, but it currently cannot create an encrypted file. Decryption is extremely slow as it is implemented in native Python rather than C. The module defines the following items: exceptionzipfile. BadZipFile ¶The error raised for bad ZIP files. New in version 3.2. exceptionzipfile. BadZipfile ¶Alias of Deprecated since version 3.2. exceptionzipfile. LargeZipFile ¶The error raised when a ZIP file would require ZIP64 functionality but that has not been enabled. classzipfile. ZipFile The class for reading and writing ZIP files. See section ZipFile Objects for constructor details. classzipfile. Path A pathlib-compatible wrapper for zip files. See section Path Objects for details. New in version 3.8. classzipfile. PyZipFile
Class for creating ZIP archives containing Python libraries. classzipfile. ZipInfo (filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))¶Class used to represent information about a
member of an archive. Instances of this class are returned by the zipfile. is_zipfile (filename)¶Returns Changed in version 3.1: Support for file and file-like objects. zipfile. ZIP_STORED ¶The numeric constant for an uncompressed archive member. zipfile. ZIP_DEFLATED ¶The numeric constant for the usual ZIP compression method. This requires the zipfile. ZIP_BZIP2 ¶The numeric constant for the BZIP2 compression method. This requires the New in version 3.3. zipfile. ZIP_LZMA ¶The numeric constant for the LZMA compression method. This requires the New in version 3.3. Note The ZIP file format specification has included support for bzip2 compression since 2001, and for LZMA compression since 2006. However, some tools (including older Python releases) do not support these compression methods, and may either refuse to process the ZIP file altogether, or fail to extract individual files. See also PKZIP Application NoteDocumentation on the ZIP file format by Phil Katz, the creator of the format and algorithms used. Info-ZIP Home PageInformation about the Info-ZIP project’s ZIP archive programs and development libraries. ZipFile Objects¶classzipfile. ZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *,
strict_timestamps=True)¶Open a ZIP file, where file can be a path to a file (a string), a file-like object or a path-like object. The mode parameter should be compression is the ZIP compression method to use when writing the archive, and should be
If allowZip64 is The compresslevel parameter controls the compression level to use when writing files to the archive. When using The strict_timestamps argument, when set to If the file is created with mode ZipFile is also a context manager and therefore supports the with ZipFile('spam.zip', 'w') as myzip: myzip.write('eggs.txt') New in version 3.2: Added the ability to use Changed in version 3.3: Added support for
Changed in version 3.4: ZIP64 extensions are enabled by default. Changed in version 3.5: Added support for writing to
unseekable streams. Added support for the Changed in version 3.6: Previously, a plain Changed in version 3.6.2: The file parameter accepts a path-like object. Changed in version 3.7: Add the compresslevel parameter. New in version 3.8: The strict_timestamps keyword-only argument ZipFile. close ()¶Close the archive file. You must call
ZipFile. getinfo (name)¶Return a
ZipFile. infolist ()¶Return a list containing a
ZipFile. namelist ()¶Return a list of archive members by name. ZipFile. open (name, mode='r', pwd=None,
*, force_zip64=False)¶Access a member of the archive as a binary file-like object. name can be either the name of a file within the archive or a
with ZipFile('spam.zip') as myzip: with myzip.open('eggs.txt') as myfile: print(myfile.read()) With mode With When writing a file, if the file size is not known in advance but may exceed 2 GiB, pass Note The Changed in version 3.6: Changed in version 3.6: Calling Extract a member from the archive to the current working directory; member must be its full name or a
Returns the normalized path created (a directory or new file). Note If a member filename is an absolute path, a drive/UNC sharepoint and leading (back)slashes will be stripped, e.g.: Changed in version 3.6: Calling Changed in version 3.6.2: The path parameter accepts a path-like object. Extract all members from the archive to the current working directory. path specifies a different directory to extract to.
members is optional and must be a subset of the list returned by Warning Never extract archives from untrusted sources without prior inspection. It is possible that files are created outside of path, e.g. members that have absolute filenames starting with Changed in version 3.6.2: The path parameter accepts a path-like object. ZipFile. printdir ()¶Print a table of contents for the archive to ZipFile. setpassword (pwd)¶Set pwd as default password to extract encrypted files. ZipFile. read (name,
pwd=None)¶Return the bytes of the file name in the archive. name is the name of the file in the archive, or a Changed in version 3.6: Calling
ZipFile. testzip ()¶Read all the files in the archive and check their CRC’s and file headers. Return the name of the first bad file, or else return Changed in version 3.6: Calling
ZipFile. write (filename, arcname=None, compress_type=None, compresslevel=None)¶Write the file named filename to the archive, giving it
the archive name arcname (by default, this will be the same as filename, but without a drive letter and with leading path separators removed). If given, compress_type overrides the value given for the compression parameter to the constructor for the new entry. Similarly, compresslevel will override the constructor if given. The archive must be open with mode Note Archive names should be relative to the archive root, that is, they should not start with a path separator. Note If Note A leading slash in the filename may lead to the archive being impossible to open in some zip programs on Windows systems. Changed in version 3.6: Calling
ZipFile. writestr (zinfo_or_arcname, data, compress_type=None, compresslevel=None)¶Write a file into the archive. The contents is data, which may
be either a If given, compress_type overrides the value given for the compression parameter to the constructor for the new entry, or in
the zinfo_or_arcname (if that is a Note When passing a Changed in version 3.2: The compress_type argument. Changed in version 3.6: Calling The following data attributes are also available: ZipFile. filename ¶Name of the ZIP file. ZipFile. debug ¶The level of debug output to use. This may be set from The comment associated with the ZIP file as a Path Objects¶classzipfile. Path (root,
at='')¶Construct a Path object from a
Path objects expose the following features of Path
objects are traversable using the Path. name ¶The final path component. Path. open (mode='r', *, pwd,
**)¶Invoke Changed in version 3.9: Added support for text and binary modes for open. Default mode is now text. Path. iterdir ()¶Enumerate the children of the current directory. Path. is_dir ()¶
Return Path. is_file ()¶Return Path. exists ()¶Return Path. read_text (*,
**)¶Read the current file as unicode text. Positional and keyword arguments are passed through to Path. read_bytes ()¶Read the current file as bytes. Path. joinpath (*other)¶Return a new Path object with each of the other arguments joined. The following are equivalent: >>> Path(...).joinpath('child').joinpath('grandchild') >>> Path(...).joinpath('child', 'grandchild') >>> Path(...) / 'child' / 'grandchild' Changed in version 3.10: Prior to 3.10, PyZipFile Objects¶The zipfile. PyZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True,
optimize=- 1)¶New in version 3.2: The optimize parameter. Changed in version 3.4: ZIP64 extensions are enabled by default. Instances have one method in addition to those of
writepy (pathname, basename='',
filterfunc=None)¶Search for files If the optimize parameter to If the optimize parameter to If pathname is a file, the filename must end with basename is intended for internal use only. filterfunc, if given, must be a function taking a single string argument. It will be passed each path (including each individual full file path) before it is added to the archive. If filterfunc
returns a false value, the path will not be added, and if it is a directory its contents will be ignored. For example, if our test files are all either in >>> zf = PyZipFile('myprog.zip') >>> def notests(s): ... fn = os.path.basename(s) ... return (not (fn == 'test' or fn.startswith('test_'))) >>> zf.writepy('myprog', filterfunc=notests) The string.pyc # Top level name test/__init__.pyc # Package directory test/testall.pyc # Module test.testall test/bogus/__init__.pyc # Subpackage directory test/bogus/myfile.pyc # Submodule test.bogus.myfile New in version 3.4: The filterfunc parameter. Changed in version 3.6.2: The pathname parameter accepts a path-like object. Changed in version 3.7: Recursion sorts directory entries. ZipInfo Objects¶Instances of the There is one classmethod to make a
ZipInfo. from_file (filename, arcname=None, *,
strict_timestamps=True)¶Construct a filename should be the path to a file or directory on the filesystem. If arcname is specified, it is used as the name within the archive. If arcname is not specified, the name will be the same as filename, but with any drive letter and leading path separators removed. The strict_timestamps argument, when set to New in version 3.6. Changed in version 3.6.2: The filename parameter accepts a path-like object. New in version 3.8: The strict_timestamps keyword-only argument Instances have the following methods and attributes: ZipInfo. is_dir ()¶Return This uses the entry’s name: directories should always end with New in version 3.6. ZipInfo. filename ¶Name of the file in the archive. ZipInfo. date_time ¶The time and date of the last modification to the archive member. This is a tuple of six values:
Note The ZIP file format does not support timestamps before 1980. ZipInfo. compress_type ¶Type of compression for the archive member. Comment for the individual archive member as a
Expansion field data. The PKZIP Application Note contains some comments on the internal structure of the data contained in this ZipInfo. create_system ¶System which created ZIP archive. ZipInfo. create_version ¶PKZIP version which created ZIP archive. PKZIP version needed to extract archive. ZipInfo. reserved ¶Must be zero. ZipInfo. flag_bits ¶ZIP flag bits. ZipInfo. volume ¶Volume number of file header. ZipInfo. internal_attr ¶Internal attributes. ZipInfo. external_attr ¶External file attributes. Byte offset to the file header. ZipInfo. CRC ¶CRC-32 of the uncompressed file. ZipInfo. compress_size ¶Size of the compressed data. ZipInfo. file_size ¶Size of the uncompressed file. Command-Line Interface¶The If you want to create a new ZIP archive, specify its name after the $ python -m zipfile -c monty.zip spam.txt eggs.txt
Passing a directory is also acceptable: $ python -m zipfile -c monty.zip life-of-brian_1979/
If you want to extract a ZIP archive into the specified directory, use the
$ python -m zipfile -e monty.zip target-dir/
For a list of the files in a ZIP archive, use the $ python -m zipfile -l monty.zip
Command-line options¶-l ¶
--list ¶List files in a zipfile. -c ¶
--create ¶Create zipfile from source files. -e ¶Extract zipfile into target directory. -t ¶ --test ¶Test whether the zipfile is valid or not. Decompression pitfalls¶The extraction in zipfile module might fail due to some pitfalls listed below. From file itself¶Decompression may fail due to incorrect password / CRC checksum / ZIP format or unsupported compression method / decryption. File System limitations¶Exceeding limitations on different file systems can cause decompression failed. Such as allowable characters in the directory entries, length of the file name, length of the pathname, size of a single file, and number of files, etc. Resources limitations¶The lack of memory or disk volume would lead to decompression failed. For example, decompression bombs (aka ZIP bomb) apply to zipfile library that can cause disk volume exhaustion. Interruption¶Interruption during the decompression, such as pressing control-C or killing the decompression process may result in incomplete decompression of the archive. How do you know if a file is a zip file?Other Methods of Identification
Explorer doesn't display file type extensions by default, so if you want to identify a ZIP file by type, you'll need to choose the "details" view. Right-click in Explorer, go to "View" and select "Details." ZIP files will list "Compressed (zipped) Folder" as the file type.
Is ZipFile included in Python?Yes! Python has several tools that allow you to manipulate ZIP files. Some of these tools are available in the Python standard library. They include low-level libraries for compressing and decompressing data using specific compression algorithms, such as zlib , bz2 , lzma , and others.
How do I read a ZipFile in Python?We create a ZipFile object in READ mode and name it as zip. printdir() method prints a table of contents for the archive. extractall() method will extract all the contents of the zip file to the current working directory. You can also call extract() method to extract any file by specifying its path in the zip file.
How do I use a ZipFile module in Python?Create a zip archive from multiple files in Python
Create a ZipFile object by passing the new file name and mode as 'w' (write mode). It will create a new zip file and open it within ZipFile object. Call write() function on ZipFile object to add the files in it. call close() on ZipFile object to Close the zip file.
|