python内置库--shutil

Posted 2023-05-24 MyRecords

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]]]]]]])
创建压缩文件并返回其名称


把当前目录下的所有文件压缩成zip文件

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

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

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

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

如上，当目的地目录已存在时 会报错。
现在加一个参数

复制成功

关于ignore 官方给的例子很赞

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

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

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

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

shutil.unpack_archive()

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

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

shutil.rmtree()

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

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 模块可用

python内置模块（shutil）--034

一、简介

shutil是高级的文件，文件夹，压缩包处理模块

 

二、使用

1、将文件内容拷贝到另外一个文件中【shutil.copyfileobj(fsrc, fdst[, length])】

import shutil

f1 = open("E:\python-project\\f1.txt",‘r‘,encoding=‘utf-8‘)

f2 = open("E:\python-project\\f2.txt",‘w‘,encoding=‘utf-8‘)

shutil.copyfileobj(f1,f2)

　　

 

2、拷贝文件(复制文件) 【shutil.copyfile(src, dst)】

import shutil

shutil.copyfile(‘E:\python-project\\f1.txt‘,‘E:\python-project\\f3.txt‘)

　　

 

3、仅拷贝权限，内容、组、用户均不变【shutil.copymode(src, dst)】

import shutil

shutil.copymode("E:\python-project\\f1.txt",‘E:\python-project\\f3.txt‘)

　　

 

4、仅拷贝状态的信息，包括：mode bits,atime,mtime,flags【shutil.copystat(src, dst)】

import shutil

shutil.copystat("E:\python-project\\f1.txt",‘E:\python-project\\f3.txt‘)

 

 

5、拷贝文件和权限【shutil.copy(src, dst)】

import shutil

shutil.copy("E:\python-project\\f1.txt",‘E:\python-project\\f4.txt‘)

 

　　

6、拷贝文件和状态信息【shutil.copy2(src, dst)】

import shutil

shutil.copy2("E:\python-project\\f1.txt",‘E:\python-project\\f5.txt‘)

　　

 

7、递归的去拷贝文件夹【shutil.copytree(src, dst, symlinks=False, ignore=None)】

import shutil

shutil.copytree("E:\python-project\Atm",‘E:\python-project\\a‘)

　　

 

8、递归的删除文件【shutil.rmtree(path[, ignore_errors[, onerror]])】

import shutil

shutil.rmtree(‘E:\python-project\\a‘)

　　

 

9、递归的移动文件，类似mv命令，其实就是重命名【shutil.move(src, dst)】

import shutil

shutil.move(‘E:\python-project\\f5.txt‘,‘E:\python-project\\f6.txt‘)

　　

 

10、压缩包的处理【shutil.make_archive(base_name, format,...)】

创建压缩包并返回文件路径，例如：zip、tar

base_name： 压缩包的文件名，也可以是压缩包的路径。只是文件名时，则保存至当前目录，否则保存至指定路径，

如：www                        =>保存至当前路径

如：/Users/wupeiqi/www =>保存至/Users/wupeiqi/

format：        压缩包种类，“zip”, “tar”, “bztar”，“gztar”

root_dir：        要压缩的文件夹路径（默认当前目录）

owner：        用户，默认当前用户

group：        组，默认当前组

logger：        用于记录日志，通常是logging.Logger对象

 

例：将E:\python-project下的Atm目录打包为ff.zip放到E:\python-project目录下

import shutil

shutil.make_archive(‘E:\python-project\\ff‘,‘zip‘,‘E:\python-project\Atm‘)

　　

 

11、shutil 对压缩包的处理是通过调用ZipFile 和 TarFile两个模块来进行的

（1）zipfile压缩解压（压缩指定文件）

打包：

import zipfile

z= zipfile.ZipFile(‘E:\python-project\\a.zip‘,‘w‘)

z.write(‘E:\python-project\\f6.txt‘)

z.write(‘E:\python-project\\f1.txt‘)

z.close()

　　

解压：

z = zipfile.ZipFile(‘E:\python-project\\a.zip‘,‘r‘)

z.extractall()

z.close()

　　

 

（2）tarfile压缩解压

打包：

import tarfile

tar = tarfile.open(‘E:\python-project\\b.zip‘,‘w‘)

tar.add(‘E:\python-project\\f4.txt‘)

tar.add(‘E:\python-project\\f2.txt‘)

tar.close()

　　

解压：

tar = tarfile.open(‘E:\python-project\\b.zip‘,‘r‘)

tar.extractall()

tar.close()