菜单

Python模块zipfile

2011年03月24日 - Python

Python ZipFile模块用来做zip格式编码的压缩和解压缩的,由于是很常见的zip格式,所以这个模块使用频率也是比较高的,在这里对ZipFile的使用方法做一些记录。即方便自己也方便别人。
ZipFile里有两个非常重要的class, 分别是ZipFile和ZipInfo, 在绝大多数的情况下,我们只需要使用这两个class就可以了。ZipFile是主要的类,用来创建和读取zip文件而ZipInfo是存储的zip文件的每个文件的信息的。

比如要读取一个Python ZipFile模块,这里假设filename是一个文件的路径:

  1. import ZipFile
  2. z = ZipFile.ZipFile(filename, 'r')  # 这里的第二个参数用r表示是读取zip文件,w是创建一个zip文件
  3. for f in z.namelist():
  4. print f

上面的代码是读取一个zip压缩包里所有文件的名字。z.namelist() 会返回压缩包内所有文件名的列表。

再看看下面一个:

  1. import ZipFile
  2. z = ZipFile.ZipFile(filename, 'r')
  3. for i in z.infolist():
  4. print i.file_size, i.header_offset

这里使用了z.infolist(), 它返回的就是压缩包内所有文件的信息,就是一个ZipInfo的列表。一个ZopInfo对象中包含了压缩包内一个文件的信息,其中比较常用的是 filename, file_size, header_offset, 分别为文件名,文件大小,文件数据在压缩包中的偏移。其实之前的z.namelist()就是读取的ZopInfo中的filename,组成一个 list返回的。
从压缩包里解压缩出一个文件的方法是使用ZipFile的read方法:

  1. import ZipFile
  2. z = ZipFile.ZipFile(filename, 'r')
  3. print z.read(z.namelist()[0])

这样就读取出z.namelist()中的第一个文件,并且输出到屏幕,当然也可以把它存储到文件。

下面是创建zip压缩包的方法:

与读取的方法其实很类似的:

  1. import ZipFile, os
  2. z = ZipFile.ZipFile(filename, 'w')  # 注意这里的第二个参数是w,这里的filename是压缩包的名字

假设要把一个叫testdir中的文件全部添加到压缩包里(这里只添加一级子目录中的文件):

  1. if os.path.isdir(testdir):
  2. for d in os.listdir(testdir):
  3. z.write(testdir+os.sep+d)
  4. # close() 是必须调用的!
  5. z.close()

上面的代码非常的简单。想想还有一个问题,如果我把一个test/111.txt 添加到压缩包里之后我希望在包里它放到test22/111.txt怎么办呢?其实这个就是Python ZipFile模块的write方法中第二个参数的作用了。只需要这样调用:

  1. z.write("test/111.txt", "test22/111.txt")
下面具体介绍一下:

class zipfile.ZipFile(file[, mode[, compression[, allowZip64]]])

创建一个ZipFile对象,表示一个zip文件。参数file表示文件的路径或类文件对象(file-like object);参数mode指示打开zip文件的模式,默认值为'r',表示读已经存在的zip文件,也可以为'w'或'a','w'表示新建一个 zip文档或覆盖一个已经存在的zip文档,'a'表示将数据附加到一个现存的zip文档中。参数compression表示在写zip文档时使用的压缩 方法,它的值可以是zipfile. ZIP_STOREDzipfile. ZIP_DEFLATED。如果要操作的zip文件大小超过2G,应该将allowZip64设置为True。 ZipFile还提供了如下常用的方法和属性:

ZipFile.getinfo(name):

获取zip文档内指定文件的信息。返回一个zipfile.ZipInfo对象,它包括文件的详细信息。将在下面 具体介绍该对象。

ZipFile.infolist()

  获取zip文档内所有文件的信息,返回一个zipfile.ZipInfo的列表。

ZipFile.namelist()

获取zip文档内所有文件的名称列表。

ZipFile.extract(member[, path[, pwd]])

将zip文档内的指定文件解压到当前目录。参数member指定要解压的文件名称或对应的ZipInfo对象;参数path指定了解析文件保存的文件夹;参数pwd为解压密码。下面一个例子将保存在程序根目录下的txt.zip内的所有文件解压到D:\Work目录:
  1. import zipfile, os
  2. zipFile = zipfile.ZipFile(os.path.join(os.getcwd(), 'txt.zip'))
  3. for file in zipFile.namelist():
  4. zipFile.extract(file, r'd:\Work')
  5. zipFile.close()

ZipFile.extractall([path[, members[, pwd]]])

解压zip文档中的所有文件到当前目录。参数members的默认值为zip文档内的所有文件名称列表,也可以自己设置,选择要解压的文件名称。

ZipFile.printdir()

将zip文档内的信息打印到控制台上。

ZipFile.setpassword(pwd)

设置zip文档的密码。

ZipFile.read(name[, pwd])

获取zip文档内指定文件的二进制数据。下面的例子演示了read()的使用,zip文档内包括一个txt.txt的文本文件,使用read()方法读取其二进制数据,然后保存到D:\txt.txt。
  1. #coding=gbk
  2. import zipfile, os
  3. zipFile = zipfile.ZipFile(os.path.join(os.getcwd(), 'txt.zip'))
  4. data = zipFile.read('txt.txt')
  5. (lambda f, d: (f.write(d), f.close()))(open(r'd:\txt.txt', 'wb'), data)  #一行语句就完成了写文件操作。仔细琢磨哦~_~
  6. zipFile.close()

ZipFile.write(filename[, arcname[, compress_type]])

将指定文件添加到zip文档中。filename为文件路径,arcname为添加到zip文档之后保存的名称, 参数compress_type表示压缩方法,它的值可以是zipfile. ZIP_STOREDzipfile. ZIP_DEFLATED。下面的例子演示了如何创建一个zip文档,并将文件D:\test.doc添加到压缩文档中。
  1. import zipfile, os
  2. zipFile = zipfile.ZipFile(r'D:\test.zip'), 'w')
  3. zipFile.write(r'D:\test.doc', 'ok.doc', zipfile.ZIP_DEFLATED)
  4. zipFile.close()

ZipFile.writestr(zinfo_or_arcname, bytes)

writestr()支持将二进制数据直接写入到压缩文档。

Class ZipInfo

ZipFile.getinfo(name) 方法返回的是一个ZipInfo对象,表示zip文档中相应文件的信息。它支持如下属性: ZipInfo.filename: 获取文件名称。 ZipInfo.date_time: 获取文件最后修改时间。返回一个包含6个元素的元组:(年, 月, 日, 时, 分, 秒) ZipInfo.compress_type: 压缩类型。 ZipInfo.comment: 文档说明。 ZipInfo.extr: 扩展项数据。 ZipInfo.create_system: 获取创建该zip文档的系统。 ZipInfo.create_version: 获取 创建zip文档的PKZIP版本。 ZipInfo.extract_version: 获取 解压zip文档所需的PKZIP版本。 ZipInfo.reserved: 预留字段,当前实现总是返回0。 ZipInfo.flag_bits: zip标志位。 ZipInfo.volume: 文件头的卷标。 ZipInfo.internal_attr: 内部属性。 ZipInfo.external_attr: 外部属性。 ZipInfo.header_offset: 文件头偏移位。 ZipInfo.CRC: 未压缩文件的CRC-32。 ZipInfo.compress_size: 获取压缩后的大小。 ZipInfo.file_size: 获取未压缩的文件大小。 下面一个简单的例子说明这些属性的意思:
  1. import zipfile, os
  2. zipFile = zipfile.ZipFile(os.path.join(os.getcwd(), 'txt.zip'))
  3. zipInfo = zipFile.getinfo('doc.doc')
  4. print 'filename:', zipInfo.filename
  5. print 'date_time:', zipInfo.date_time
  6. print 'compress_type:', zipInfo.compress_type
  7. print 'comment:', zipInfo.comment
  8. print 'extra:', zipInfo.extra
  9. print 'create_system:', zipInfo.create_system
  10. print 'create_version:', zipInfo.create_version
  11. print 'extract_version:', zipInfo.extract_version
  12. print 'extract_version:', zipInfo.reserved
  13. print 'flag_bits:', zipInfo.flag_bits
  14. print 'volume:', zipInfo.volume
  15. print 'internal_attr:', zipInfo.internal_attr
  16. print 'external_attr:', zipInfo.external_attr
  17. print 'header_offset:', zipInfo.header_offset
  18. print 'CRC:', zipInfo.CRC
  19. print 'compress_size:', zipInfo.compress_size
  20. print 'file_size:', zipInfo.file_size
  21. zipFile.close()

发表评论

电子邮件地址不会被公开。 必填项已用*标注