funfile

一个实用的 Python 文件操作工具库，提供带进度条的压缩/解压、并发写入、pickle 序列化等功能的增强封装。

原 nltfile 已迁回 funfile；旧包保留兼容入口，新代码请使用 funfile。

特性

带进度条的 tar 压缩与解压，用法与标准库一致
自动识别常见 zip/tar 格式，并阻止 tar 路径穿越
线程安全的后台文件写入，支持指定偏移量
pickle 序列化/反序列化的便捷封装
常用文件系统操作（创建目录、删除、复制）

安装

pip install funfile

依赖

Python >= 3.10
nltlog >= 1.0.0
tqdm >= 4.66.5

使用

tar 压缩/解压（带进度条）

用法与标准库 tarfile 一致，自动显示进度条：

from funfile import tarfile

# 压缩
with tarfile.open("results.tar.xz", "w|xz") as tar:
    tar.add("a.txt")

# 解压
with tarfile.open("results.tar.xz", "r|xz") as tar:
    tar.extractall("local")

也可以使用快捷函数：

from funfile.compress.tarfile import file_entar, file_detar

# 一键压缩
file_entar("mydir", "mydir.tar.xz")

# 一键解压
file_detar("mydir.tar.xz", "output")

zip 解压

from funfile import zipfile

with zipfile.ZipFile("archive.zip") as zf:
    zf.extractall("output")

通用解压

根据文件后缀自动选择解压方式，支持 .zip、.tar、.tar.gz、.tgz、.tar.bz2、.tar.xz、.txz。tar 解压默认只接受普通文件和目录，拒绝目标目录之外的路径及链接、设备等特殊成员：

from funfile.compress.allfile import extractall

extractall("archive.tar.gz", "output")

并发文件写入

线程安全的后台写入，适用于多线程生产数据的场景。离开 with 时会等待数据落盘，后台写入错误会传播给调用方：

from funfile import ConcurrentFile

with ConcurrentFile("output.txt", mode="w") as fw:
    fw.write("hello, funfile.")
    fw.write("another line.")

支持指定偏移量的随机写入：

with ConcurrentFile("output.bin", mode="wb") as fw:
    fw.write(b"chunk1", offset=0)
    fw.write(b"chunk2", offset=1024)

pickle 序列化

便捷的 pickle 读写封装：

pickle 可以执行序列化数据中的代码，只加载可信来源的数据。

from funfile.pickle import dump, load, dumps, loads

# 写入文件
dump({"key": "value"}, "data.pkl")

# 从文件读取
data = load("data.pkl")

# 序列化为 bytes
raw = dumps({"key": "value"})

# 从 bytes 反序列化
obj = loads(raw)

文件系统工具

from funfile.funos import makedirs, delete

# 递归创建目录（已存在不报错）
makedirs("path/to/dir")

# 删除文件或递归删除目录
delete("path/to/dir")

from funfile.file import copy

# 复制文件
copy("src.txt", "dst.txt")

获取文件/目录大小

from funfile import get_size

# 获取文件大小（字节）
size = get_size("large_file.bin")

# 递归获取目录大小
size = get_size("mydir", recursive=True)

文件哈希

from funfile import file_md5, file_sha256

md5 = file_md5("archive.tar.xz")
sha256 = file_sha256("archive.tar.xz")

项目结构

src/funfile/
├── __init__.py            # 顶层导出
├── funos.py               # 文件系统工具（makedirs, delete）
├── file/
│   ├── core.py            # 文件复制
│   └── concurrent.py      # 并发文件写入
├── compress/
│   ├── tarfile.py         # 带进度条的 tar 操作
│   ├── zipfile.py         # zip 操作封装
│   └── allfile.py         # 通用解压
├── utils/
│   ├── size.py            # 文件大小与可读格式
│   ├── hash.py            # 文件哈希
│   └── tqdm_bar.py        # 文件进度条
└── pickle/
    └── core.py            # pickle 序列化封装

许可证

Apache License 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

funfile-1.0.39-py3-none-any.whl (18.5 kB view details)

Uploaded Aug 26, 2026 Python 3

File details

Details for the file funfile-1.0.39-py3-none-any.whl.

File metadata

Download URL: funfile-1.0.39-py3-none-any.whl
Upload date: Aug 26, 2026
Size: 18.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for funfile-1.0.39-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1052de435bb72a89e1ac74f6ae8e1beebb866da35a062490d150c04abfeb21b7`
MD5	`241f51ed81c38f4923c7bb5b292d6c7a`
BLAKE2b-256	`67e219606f648a3bb8b993c6dcde34eb81f2f5a0ccaf722ff6e4b3730ded2ffc`