讲师中心 微信公众号
AI工具推荐 视频效率加速

怎样在Python中使用tarfile模块排除指定文件打包?

夏涛姑娘_9194

夏涛姑娘_9194

发布时间:2026-09-04 09:38:24

|

194人浏览过

|

来源于php中文网

原创

tarfile.add() 没有 exclude 参数,正确方式是使用 filter 参数传入过滤函数,该函数接收 TarInfo 对象并返回 None(跳过)或原对象(保留),需注意路径为相对路径且统一用正斜杠分隔。

怎样在python中使用tarfile模块排除指定文件打包?

tarfile.add() 的 exclude 参数根本不存在

别被文档误导了——tarfile.add() 方法**没有 exclude 参数**。这是新手最常踩的坑,搜到过时教程或误读 API 说明后硬加 exclude=...,结果报 TypeError: add() got an unexpected keyword argument 'exclude'。

真正能控制排除逻辑的是 filter 参数,它接收一个函数,对每个待加入的 tarfile.TarInfo 对象做判断,返回 None 表示跳过,返回原 TarInfo 对象表示保留。

实操建议:

  • 写一个过滤函数,检查 tarinfo.name(路径字符串)是否匹配要排除的模式
  • 注意路径是相对路径,且用正斜杠分隔(即使在 Windows 上),比如 "logs/error.log"、"__pycache__/main.cpython-311.pyc"
  • 用 os.path.normpath() 或 pathlib.PurePath 做路径标准化更安全,避免因路径拼接导致匹配失败

用 filter 函数排除单个文件或目录

最常见需求:跳过 .git 目录、venv、或某个临时文件。直接看可运行的最小例子:

立即学习“Python免费学习笔记(深入)”;

import tarfile
import os

def exclude_git_and_pyc(tarinfo):
    name = tarinfo.name
    if name.startswith('.git/') or name == '.git':
        return None
    if name.endswith('.pyc') or '__pycache__' in name:
        return None
    return tarinfo

with tarfile.open('archive.tar.gz', 'w:gz') as tar:
    tar.add('myproject/', filter=exclude_git_and_pyc)

关键点:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • filter 函数必须接收单个 tarinfo 参数,不能多也不能少
  • tarinfo.name 是归档内显示的路径,不含前导 /;tarinfo.isfile()、tarinfo.isdir() 可用于类型判断
  • 如果想排除整个目录,只检查 name == 'dirname' 不够——子路径如 'dirname/sub/file.txt' 还会进来,所以要用 startswith('dirname/')

排除多个指定文件名(非通配)的可靠写法

如果只是想排除几个固定名字的文件(比如 config.local.yaml、secrets.env),用集合判断最快最清晰:

EXCLUDE_NAMES = {'config.local.yaml', 'secrets.env', '.env'}

def exclude_by_name(tarinfo):
    return None if os.path.basename(tarinfo.name) in EXCLUDE_NAMES else tarinfo

但注意:os.path.basename() 在 tarinfo.name 为 'a/b/.env' 时返回 '.env',没问题;但如果 tarinfo.name == '.env'(顶层文件),也成立。这个逻辑覆盖全。

容易被忽略的陷阱:

  • 不要用 in EXCLUDE_NAMES 直接查 tarinfo.name——因为路径可能带目录前缀,'./.env' 就不会命中
  • Windows 用户别用 \ 做分割,tarfile 内部统一转为 /,硬写反斜杠会导致匹配失效
  • filter 函数里抛异常会中断整个打包,调试时建议先 print(name) 看实际路径格式

性能与兼容性提醒:filter 会在每个文件上调用

如果你打包的是几十万小文件的项目,filter 函数会被调用几十万次。虽然本身开销小,但频繁的字符串操作(比如反复 startswith()、endswith())叠加起来可观。

优化建议:

  • 把排除规则预编译成正则(仅当模式复杂时),例如 re.compile(r'.(log|tmp)$'),比多次 str.endswith() 更快
  • 避免在 filter 里做磁盘 I/O 或网络请求——它本应是纯内存判断
  • filter 在 Python 3.2+ 才支持,旧版本只能先生成文件列表再逐个 add(),但那样无法保留目录结构元数据

最麻烦的其实是路径边界——比如想排除 docs 目录,但不想误杀 documentation.md。这时候必须严格区分 name == 'docs' 和 name.startswith('docs/'),少一个条件就漏排除或多排除。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1831

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4884

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1789

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

29137

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3487

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3487

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1223

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn