python应用-shutil详解文件复制/移动/删除功能

shutil 模块是 Python 的标准库模块（直接导入，无需下载），提供了像在电脑上操作文件、文件夹的功能，如复制、移动、删除文件和文件夹等。

shutil 模块的__all__包含的函数如下：

主要函数如下图所示：

复制文件

使用 shutil.copy() 和shutil.copy2h函数可以复制文件，不支持复制目录。copy函数和copy2函数的区别是：

shutil.copy2函数：在复制文件时会尝试保留源文件的元数据，如文件权限、最后修改时间等。

shutil.copy函数：不会保留这些元数据，它只进行简单的文件内容复制。

我们看下源代码可以看出区别：主要是标红框的函数copystat和copymode

顺便说下copymode和copystat函数：

shutil.copymode() 和 shutil.copystat() 功能如下：

1. shutil.copymode(src, dst)

shutil.copymode()函数用于复制源文件src的权限位到目标文件dst。比如特定的读取、写入或执行权限，但不会复制文件的内容、组或用户信息。
 

2. shutil.copystat(src, dst)

shutil.copystat()函数则用于复制源文件src的状态信息到目标文件dst，包括权限位、最后访问时间、最后修改时间和标志值。

举例：

import shutil
shutil.copy2('/Users/htsc/Desktop/dir1/dir2/1.txt','/Users/htsc/Desktop/dir1/dir2/2.txt',)
shutil.copy('/Users/htsc/Desktop/dir1/dir2/1.txt','/Users/htsc/Desktop/dir1/dir3/1.txt',)

复制文件夹

使用 shutil.copytree() 可以递归复制整个文件夹的内容到新文件夹，在 Python 3.8及以上版本中，shutil.copytree() 的函数参数如下：

shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=shutil.copy2, dirs_exist_ok=False)

参数说明：

• src: 源目录路径。
• dst: 目标目录路径。如果目录不存在，copytree() 会创建它。
• symlinks: 如果为 True，则源目录中的符号链接将被复制为符号链接，而不是复制链接指向的文件或目录；默认为 False，此时会复制符号链接指向的文件或目录。
• ignore: 一个可调用对象（如函数），它接受两个参数：源目录和目录中的文件列表，并应返回一个要忽略的文件名列表。这可以用来排除某些不需要复制的文件或目录。如果不提供，则默认复制所有文件和目录。
• copy_function: 用于复制文件和目录的函数；默认为 shutil.copy2，
• dirs_exist_ok: 如果目标目录已存在，设置此参数为 True ，允许 copytree 继续执行，而不是抛出 FileExistsError 异常。这个参数在 Python 3.8 版本中添加。

以下是部分源代码,可以看出这个函数一个大致工作流程： 先列出源目录的文件夹和文件内容，然后根据传入的ignore函数过滤不需要复制的内容，然后递归创建新目录，复制文件和目录到新目录。

ignore函数在shutil库中如下：

举例：复制dir2到dir3目录，过滤‘1.docx’的文档，传入ignore函数对象。

shutil.copytree('/Users/htsc/Desktop/dir1/dir2','/Users/htsc/Desktop/dir1/dir3',
                ignore=shutil.ignore_patterns('1.docx'),
                dirs_exist_ok=True)

结果如下：新目录dir3并没有1.docx文件。并且不会覆盖目标目录dir3的test文件夹。

移动文件或文件夹

使用 shutil.move() 可以移动文件或文件夹到目标文件夹；移动时会判断目标是目录还是文件，然后做不同处理。

举例：

1. 将目录dir2移动到目标目录dir3中：

shutil.move('/Users/htsc/Desktop/dir1/dir2','/Users/htsc/Desktop/dir1/dir3')

执行后结果：

如果目标目录dir3中已经存在dir2目录，会报错

2 移动文件

将文件移动到新目录，如果新目录有同名文件会报错。如果没有重名文件，相当于复制一个文件到新目录，并rename改为新文件名字。

shutil.move('/Users/htsc/Desktop/dir1/dir2/1.txt','/Users/htsc/Desktop/dir1/dir3/3.txt')

删除文件或文件夹

shutil.rmtree() 可以递归地删除文件夹及其内容，包括为空或者不为空的内容。

参数说明：

• path：要删除的目录的路径。
• ignore_errors：如果设置为 True，则忽略删除过程中的错误（例如，如果某些文件或目录无法删除）。默认为 False，即遇到错误时会抛出异常。
• onerror：一个处理错误的回调函数，它会在删除过程中遇到错误时被调用。该函数接受两个参数：一个异常实例和一个包含引发异常的路径名的元组。

#删除dir2目录下所有内容
shutil.rmtree('/Users/htsc/Desktop/dir1/dir2')

之前文章我们也介绍了os.rmdir()和os.removedirs()函数，区别是这两个函数不能删除非空目录，而shutil .rmtree就像是增强版的删除功能，当然两者在不同的使用场景下各有优劣。

共勉： 东汉·班固《汉书·枚乘传》：“泰山之管穿石，单极之绠断干。水非石之钻，索非木之锯，渐靡使之然也。”

-----指水滴不断地滴，可以滴穿石头；

-----比喻坚持不懈，集细微的力量也能成就难能的功劳。

----感谢读者的关注，阅读和学习，您的支持就是我们最大的动力。