Python中的shutil.copytree

发布时间：2023-05-20

Python中的shutil.copytree是一个强大且易于使用的函数，可以帮助我们将目录及其所有子目录和文件复制到新的目录中。本文将从多个方面详细介绍shutil.copytree函数的用法。

一、基本语法

shutil.copytree函数的基本语法如下：

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

其中，src是源目录，dst是目标目录。如果目标目录不存在，则会创建它，如果存在，则会覆盖。 参数symlinks是一个布尔值，表示是否复制符号链接（默认为False）。参数ignore是一个回调函数，用于过滤不需要复制的文件。 参数copy_function是一个可选的复制函数（默认为shutil.copy2），可以用于自定义备份操作。参数ignore_dangling_symlinks是一个布尔值，表示是否忽略指向不存在目录的符号链接（默认为False）。

二、示例代码

下面是一个示例代码，演示了如何使用shutil.copytree函数：

import shutil
# 源目录
src = "/home/user/old"
# 目标目录
dst = "/home/user/new"
# 复制目录
shutil.copytree(src, dst)

以上代码将源目录/home/user/old复制到目标目录/home/user/new中。

三、复制文件夹

使用shutil.copytree函数可以复制整个文件夹，包括其中的所有文件和子文件夹。下面是一个示例代码，演示了如何复制一个包含文件和子文件夹的文件夹：

import shutil
# 源目录
src = "/home/user/folder"
# 目标目录
dst = "/home/user/backup"
# 复制目录
shutil.copytree(src, dst)

以上代码将源目录/home/user/folder复制到目标目录/home/user/backup中。

四、忽略文件

在使用shutil.copytree函数时，可以使用参数ignore来忽略一些不需要复制的文件。下面是一个示例代码，演示了如何使用参数ignore来忽略一些文件：

import shutil
import os
# 忽略的文件
def ignore_files(dir, files):
    return [file for file in files if os.path.isfile(os.path.join(dir, file)) and file.endswith(".txt")]
# 源目录
src = "/home/user/folder"
# 目标目录
dst = "/home/user/backup"
# 复制目录并忽略txt文件
shutil.copytree(src, dst, ignore=shutil.ignore_patterns("*.txt"))

以上代码将源目录/home/user/folder复制到目标目录/home/user/backup中，并忽略所有的txt文件。

五、复制符号链接

shutil.copytree函数默认情况下不会复制符号链接。如果要复制符号链接，请设置symlinks参数为True。下面是一个示例代码，演示了如何复制包含符号链接的文件夹：

import shutil
# 源目录
src = "/home/user/folder"
# 目标目录
dst = "/home/user/backup"
# 复制目录并复制符号链接
shutil.copytree(src, dst, symlinks=True)

以上代码将源目录/home/user/folder复制到目标目录/home/user/backup中，并复制其中的符号链接。

六、自定义复制函数

除了使用默认的复制函数外，还可以使用自定义的复制函数来备份文件。下面是一个示例代码，演示了如何使用自定义的复制函数：

import shutil
import os
# 自定义复制函数
def backup_file(src_file, dst_dir):
    shutil.copy2(src_file, dst_dir)
    os.rename(os.path.join(dst_dir, os.path.basename(src_file)), os.path.join(dst_dir, os.path.basename(src_file) + ".bak"))
# 源文件
src_file = "/home/user/data.txt"
# 目标文件夹
dst_dir = "/home/user/backup"
# 自定义备份操作
shutil.copytree(src_file, dst_dir, copy_function=backup_file)

以上代码将源文件/home/user/data.txt备份到目标文件夹/home/user/backup中，并以.bak为后缀名重命名。

七、忽略不存在的符号链接

如果需要忽略指向不存在目录的符号链接，请设置ignore_dangling_symlinks参数为True。下面是一个示例代码，演示了如何忽略不存在的符号链接：

import shutil
# 源目录
src = "/home/user/folder"
# 目标目录
dst = "/home/user/backup"
# 复制目录并忽略不存在的符号链接
shutil.copytree(src, dst, ignore_dangling_symlinks=True)

以上代码将源目录/home/user/folder复制到目标目录/home/user/backup中，并忽略其中的不存在的符号链接。

八、总结

本文详细介绍了shutil.copytree函数的用法，包括基本语法、复制文件夹、忽略文件、复制符号链接、自定义复制函数和忽略不存在的符号链接等方面的内容。在日常开发中，使用shutil.copytree函数可以快速、方便地备份文件和文件夹。

推荐文章