python

关注公众号 jb51net

关闭
首页 > 脚本专栏 > python > Python tarfile模块解压缩

Python的tarfile模块解压缩.tar/.tar.gz等文件详解

作者:科雷learning

本文介绍了Python标准库tarfile的使用方法,包括tarfile.open、TarFile.add、TarFile.extractall、TarFile.getmembers等核心函数和参数的使用,以及注意事项,特别强调了在Windows环境下处理中文文件名乱码的问题,感兴趣的朋友跟随小编一起看看吧

Python的tarfile模块解压缩.tar/.tar.gz等文件

python中的标准库tarfile模块可以帮助我们快速压缩或者解压后缀为
.tar/.tar.gz/.tar.bz2/.tar.xz的文件。

01 tarfile核心类与函数介绍

因为tarfile是标准库,我们直接import tarfile即可使用。

tarfile模块的核心是TarFile类,通过它可以完成创建、读取、修改 tar 文件的操作。但在实际使用中我们经常使用tarfile.open函数,open函数其实调用的是tarfile.TarFile.open类函数,源代码如下:

open类函数比TarFile类本身支持更多的mode。

1. tarfile.open(name, mode='r', fileobj=None, **kwargs)

功能:打开或创建一个tar文件,返回TarFile对象。

参数

案例:创建不同格式的压缩文件,不同的压缩算法压缩后的文件大小是不同的。

import tarfile
with tarfile.open('example.tar', 'r') as tar:
    pass
with tarfile.open('example.tar.gz', 'w:gz') as tar:
    pass
with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    pass
with tarfile.open('example.tar.xz', 'w:xz') as tar:
    pass
#追加文件到已有的压缩文件
with tarfile.open('existing.tar', 'a') as tar:
    tar.add('new_file.txt')

2. TarFile.add(name, arcname=None, recursive=True, filter=None)

功能:将文件或目录添加到tar文件中。

参数解析:

name:指定要归档的文件或目录路径。

with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
  tar.add('/home/user/data.csv')  # 绝对路径
  tar.add('docs/README.md')       # 相对路径

arcname:设置文件在tar包中的归档名称(默认为原路径)。

with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    # 将本地文件归档为archive.tar中的data/input.csv
    tar.add('input.csv', arcname='data/input.csv')

recursive:是否递归归档目录内容(仅对目录有效),默认递归处理所有子目录。

with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    # 仅归档src目录本身,不包含其内容
    tar.add('src', recursive=False)

filter(Python 3.8+增加的参数,以前的版本是exclude参数)

:filter函数接收一个TarInfo对象,返回修改后的对象或None(排除该文件);使用时会对每个TarInfo对象进行转换或过滤。

案例1: 修改文件属性

def set_permissions(tarinfo):
    tarinfo.mode = 0o644# 设置文件权限
    return tarinfo
with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    tar.add('scripts', filter=set_permissions)

案例2 :基于条件过滤文件

def exclude_large_files(tarinfo):
    if tarinfo.size > 1024 * 1024:  # 大于1MB的文件
        print(f"排除大文件: {tarinfo.name}")
        return None
    return tarinfo
with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    tar.add('logs/', filter=exclude_large_files)

案例3: 动态修改归档路径

def remap_path(tarinfo):
    tarinfo.name = tarinfo.name.replace('src/', 'source/')
    return tarinfo
with tarfile.open('example.tar.bz2', 'w:bz2') as tar:
    tar.add('src/', filter=remap_path)

filter参数 vs exclude参数说明:

特性

filter (Python 3.8+)

exclude (旧版)

参数类型

处理TarInfo的函数

判断路径的函数

功能

修改或排除文件

仅排除文件

灵活性

高(可修改元数据)

低(仅路径判断)

兼容性

Python 3.8+

所有版本

3. TarFile.extractall(path='.', members=None, *, numeric_owner=False)

功能:解压tar文件中的所有内容到指定路径。

参数

案例:解压tar.gz全部的文件

import tarfile
with tarfile.open('project.tar.gz', 'r:gz') as tar:
    tar.extractall('extracted_project')

4. TarFile.getmembers()

功能:返回tar文件中所有成员的TarInfo对象列表,TarInfo对象包含了文件的详细元数据,如文件名、大小、修改时间等 。

import tarfile
with tarfile.open('project.tar', 'r') as tar:
    members_info = tar.getmembers()
    for info in members_info:
        print(f"文件名: {info.name}, 大小: {info.size}字节")
	print(f"修改时间: {info.mtime}, 权限: {info.mode}")

或者使用TarFile.gettarinfo函数获取单个文件的TarInfo对象,此处不在赘述。

5. TarFile.getnames()

功能:返回tar文件中所有成员的名称列表。

import tarfile
with tarfile.open('project2.tar.gz', 'r') as tar:
    print(tar.getnames())

6. TarFile.extract(member, path='.')

功能:解压指定的单个文件或目录。参数member填文件名或者带路径的文件名,如果找不到路径会报错。path默认解压到当前目录。

with tarfile.open('project2.tar.gz', 'r') as tar:
    tar.extract('dir1/Python从入门到精通.pdf',path='1/2') #将单个文件解压到某一个目录

7.内存中操作 tar 文件

使用io.BytesIO可以在内存中创建和操作 tar 文件,无需写入磁盘。

import tarfile
import io
buffer = io.BytesIO()
#使用fileobj参数
with tarfile.open(fileobj=buffer, mode='w') as tar:
    tar.add('data.txt')
    # 获取内存中的tar数据
    tar_data = buffer.getvalue().decode()
    print(tar_data)

02 函数总结

功能场景

核心函数 / 方法

关键参数 / 注意事项

创建 tar 文件

TarFile.open('name.tar', 'w')

选择合适的压缩模式(如'w:gz')

添加文件 / 目录

TarFile.add()

arcname可重命名归档路径

解压文件

TarFile.extract() / extractall()

指定正确的目标路径

遍历文件列表

TarFile.getmembers() / getnames()

用于检查归档内容

追加文件

TarFile.open('name.tar', 'a')

避免文件名冲突

03 注意事项

在windows环境下,执行压缩后,如果在电脑上直接打开,会发现中文显示乱码。

此时可以通过tarfile的解压函数extractall解压,然后再查看中文显示正常。

到此这篇关于Python的tarfile模块解压缩.tar/.tar.gz等文件详解的文章就介绍到这了,更多相关Python tarfile模块解压缩内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文