一、学习目标

1.1 学习目标

掌握Python内置模块tarfile的核心功能，包括：

• 理解tar归档文件的原理与常见压缩格式（gzip/bz2/lzma）
• 掌握tar文件的读写操作（创建、解压、查看、过滤）
• 熟悉安全防护机制（解压过滤器）与跨平台兼容性（Unicode处理）
• 能够在实际项目中灵活应用（如日志归档、软件包分发、数据备份）

1.2 知识导图（Mermaid）

二、tarfile模块基础

2.1 模块概述

tarfile是Python标准库中用于处理tar归档文件的内置模块，支持读写未压缩/压缩的tar文件（如.tar、.tar.gz、.tar.bz2等）。其核心价值在于：

• 归档管理：将多个文件/目录打包为单一文件（保留元数据）
• 压缩集成：通过扩展名自动处理gzip/bz2/lzma压缩
• 跨平台兼容：支持POSIX标准与Windows系统

2.2 常见tar格式对比（表1）

注：Python 3.8+默认使用PAX_FORMAT（更安全灵活）

三、核心功能

3.1 文件操作基础

3.1.1 打开tar文件：tarfile.open()

功能：通过指定模式打开tar文件（读/写/追加/创建），支持压缩格式自动处理。

原型：

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

参数说明：

• name：文件路径（如archive.tar.gz）
• mode：操作模式（见表2）
• fileobj：可选的二进制文件对象（如open('file.bin', 'rb')）
• **kwargs：压缩相关参数（如compresslevel=9）

模式对照表（表2）

示例代码（PEP8风格）：

import tarfile

# 读取gzip压缩的tar文件
with tarfile.open('data.tar.gz', 'r:gz') as tar:
    tar.list()  # 列出所有成员

# 创建bz2压缩的tar文件
with tarfile.open('backup.tar.bz2', 'w:bz2') as tar:
    tar.add('project/')  # 添加目录

3.1.2 检查文件类型：tarfile.is_tarfile()

功能：快速判断文件是否为有效的tar归档。

if tarfile.is_tarfile('archive.tar'):
    print("是有效的tar文件")

3.2 读操作

3.2.1 获取成员信息

• getmember(name)：获取指定名称的成员元数据（TarInfo对象）
• getmembers()：返回所有成员的TarInfo列表
• getnames()：返回所有成员名称的字符串列表

示例：查看tar内文件详情

with tarfile.open('docs.tar', 'r') as tar:
    for member in tar.getmembers():
        print(f"名称: {member.name}, 大小: {member.size}字节, 类型: {'目录' if member.isdir() else '文件'}")

3.2.2 解压操作

• extractall(path='.', members=None, filter='data')：解压所有/指定成员到目标路径
• extract(member, path='')：解压单个成员

安全要点：

• 必须指定filter参数（Python 3.12+默认要求）：防止路径遍历攻击（如../../../恶意文件）
• 推荐使用filter='data'（跨平台安全）或自定义过滤函数

实用案例：安全解压Python脚本

import tarfile
import os

def is_python_file(member):
    return member.name.endswith('.py')  # 只解压.py文件

with tarfile.open('scripts.tar.gz', 'r:gz') as tar:
    tar.extractall(path='extracted', members=filter(is_python_file, tar.getmembers()), filter='data')

3.3 写操作

3.3.1 添加文件/目录

• add(name, arcname=None, recursive=True, filter=None)：添加文件或目录（递归默认开启）
• addfile(tarinfo, fileobj=None)：通过TarInfo对象直接添加

编程技巧：

• 使用arcname重命名归档内的路径（如arcname='config/settings.ini'）
• 通过filter函数修改元数据（如统一设置用户权限）

示例：创建带过滤的归档

import tarfile
import time

def reset_metadata(tarinfo):
    tarinfo.uid = tarinfo.gid = 0      # 设置为root用户
    tarinfo.uname = tarinfo.gname = 'root'
    tarinfo.mtime = int(time.time())   # 更新修改时间为当前
    return tarinfo

with tarfile.open('config.tar.gz', 'w:gz') as tar:
    tar.add('settings.ini', arcname='app/config.ini', filter=reset_metadata)

3.3.2 直接创建TarInfo对象

通过gettarinfo()生成元数据，再配合addfile()添加内容：

tarinfo = tarfile.gettarinfo('data.bin', arcname='assets/data.bin')
with open('data.bin', 'rb') as f:
    tar.addfile(tarinfo, fileobj=f)  # 需手动提供文件对象

四、解压过滤器

4.1 为什么需要过滤？

tar格式允许存储绝对路径（如/etc/passwd）和路径遍历（如../../恶意文件），攻击者可能通过恶意归档覆盖系统关键文件。

4.2 过滤器类型（表3）

Python 3.14+默认使用'data'过滤器！

示例：强制安全解压

# 方式1：通过参数指定
tar.extractall(filter='data')

# 方式2：通过属性设置（影响后续所有操作）
tar.extraction_filter = tarfile.data_filter

五、应用与扩展

5.1 命令行工具

Python内置命令行接口，快速操作tar文件：

# 创建归档
python -m tarfile -c backup.tar /path/to/files

# 解压到指定目录
python -m tarfile -e archive.tar.gz ./extracted

# 列出文件
python -m tarfile -l data.tar

5.2 实用技巧

• 内存优化：处理大文件时使用stream=True模式（避免缓存全部元数据）
• 错误处理：设置errorlevel=2捕获非致命错误（如权限不足）
• 跨平台路径：始终使用os.path.join()构造路径，避免硬编码/或\

六、学习总结

6.1 核心知识点回顾

1. tarfile模块：Python标准库，支持读写tar归档及gzip/bz2/lzma压缩
2. 关键对象： TarFile：管理归档文件（打开/关闭/读写） TarInfo：存储文件元数据（名称/大小/权限/类型）
3. 安全实践：必须使用解压过滤器（推荐filter='data'）
4. 常见场景：日志归档、软件包分发、配置备份

6.2 推荐实践路径

6.3 常见问题解答

Q：为什么解压时提示DeprecationWarning？
A：Python 3.12+要求显式指定filter参数（默认不再信任归档），需添加filter='data'。

Q：如何处理超大型tar文件？
A：使用stream=True模式（减少内存占用），或分批次处理成员（通过生成器过滤）。

Q：tar与zip格式如何选择？
A：tar适合保留Unix权限/符号链接（归档场景），zip更适合跨平台通用分发（内置压缩）。

#编程# #学习# #python# #在头条记录我的2025#