python内置库--shutil

发布时间 2023-05-23 23:49:01作者: 工作手记

1 简单介绍

shutil提供了一系列函数来对文件或目录进行高级操作,如复制 压缩 移动 删除等,功能和os模块功能的很类似,但shutil更加易用
shutil没有提供对单个文件的删除操作,单个文件的复制 移动 解压缩是支持的

2 相关函数

shutil.make_archive()

shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])
创建压缩文件并返回其名称
image
image
把当前目录下的所有文件压缩成zip文件
image

shutil.copy(src, dst, *, follow_symlinks=True)

复制文件src到作为文件或目录的dst,若dst是一个已存在的文件,已存在的文件将被替换

在父目录下面新建一个文件夹,把前面的zip文件复制到新建文件夹下面
image

shutil.copyfileobj(fsrc, fdst[, length])

将file-like object fsrc 的内容复制到 file-like object fdst

shutil.copy(src, dst, *, follow_symlinks=True)

将文件 src 复制到文件或目录 dst
src和dst是 path-like objects或字符串
注意, copy 会拷贝文件数据和文件的权限模式 (参见 os.chmod())。 其他元数据,例如文件的创建和修改时间不会被保留。 要保留所有原有的元数据,请改用 copy

shutil.copy2(src, dst, *, follow_symlinks=True)

类似于copy

shutil.ignore_patterns(*patterns)

工厂函数,它创建一个函数,用作 copytree() 的 ignore 可调用对象参数

shutil.copytree()

shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)
将目录及其所有子目录src 复制到目录dst下面,返回目标目录。 默认情况下dst在操作之前不存在,dst下的子目录在操作中也会被创建

copy_function 默认是copy2 即采用函数copy2的方式来复制

ignore 默认是None, 如果给出了 ignore,它必须是一个可调用对象如函数,可调用对象返回值的中的数据,在复制过程中将被忽略

dirs_exist_ok 默认为False,若dst 已存在,则会引发 FileExistsError。 如果 dirs_exist_ok 为真值,则复制操作遇到已存在的目录时将继续执行,并且在 dst 目录树中的文件将被 src 目录树中对应的文件所覆盖

复制目录src及其子目录的所有内容到目录dst
image
如上,当目的地目录已存在时 会报错。
现在加一个参数
image
复制成功

关于ignore 官方给的例子很赞

image
如上,第2个例子,在复制过程中并不会忽略任何文件,但是会持续记录正在哪一个目录下复制,path是正在复制的目录, names是该目录下一系列的文件名 是一个列表
借用前面copytree的例子 path name打印出来如下
image

shutil.move(src, dst, copy_function=copy2)

递将文件或目录及其所有子目录 (src) 移至另一位置 (dst) 并返回目标位置

移动父目录的兄弟目录下的test01到当前目录下
image

shutil.unpack_archive()

shutil.unpack_archive(filename[, extract_dir[, format[, filter]]])
解压文件
fileename 是要解压文件的路径 是存放解压后的内容的地方,默认是当前目录
extract_dir 是存放解压后的内容的地方,可以是一个不存在的目录(执行中会被自动创建),默认值是当前目录

解压前面的压缩文件到一个不存在的新目录
image

shutil.rmtree()

shutil.rmtree(path, ignore_errors=False, onerror=None, *, dir_fd=None)
删除目录及其子目录
path 为目录的路径,path不能是文件,否则会报错
删除存放解压内容的目录
image

shutil.get_archive_formats()

返回支持的压缩格式列表。 所返回序列中的每个元素为一个元组 (name, description)。

默认情况下 shutil 提供以下格式:

zip: ZIP 文件(如果 zlib 模块可用)。

tar: 未压缩的 tar 文件。 对于新归档文件将使用 POSIX.1-2001 pax 格式。

gztar: gzip 压缩的 tar 文件(如果 zlib 模块可用)。

bztar: bzip2 压缩的 tar 文件(如果 bz2 模块可用)。

xztar: xz 压缩的 tar 文件(如果 lzma 模块可用

image