Python的shutil模块:文件处理的得力助手
对话实录
小白:(苦恼)我在Python中处理文件时,总是觉得自带的open函数不太够用,有没有更强大的工具呀?
专家:(微笑)那你可不能错过shutil模块!它就像是文件处理的瑞士军刀,提供了大量便捷的函数来操作文件和目录,接下来我给你详细讲讲。
shutil模块基础认知
1. 文件复制
shutil.copy() 和shutil.copy2函数可以复制文件,不支持复制目录。copy函数和copy2函数的区别是:
- shutil.copy2函数:在复制文件时会尝试保留源文件的元数据,如文件权限、最后修改时间等。
- shutil.copy函数:不会保留这些元数据,它只进行简单的文件内容复制。
我们看下源代码可以看出区别:主要是标红框的函数copystat和copymode
顺便说下shutil.copymode() 和 shutil.copystat() 功能如下:
- shutil.copymode(src, dst)
shutil.copymode()函数用于复制源文件src的权限位到目标文件dst。比如特定的读取、写入或执行权限,但不会复制文件的内容、组或用户信息。
2. shutil.copystat(src, dst)
shutil.copystat()函数则用于复制源文件src的状态信息到目标文件dst,包括权限位、最后访问时间、最后修改时间和标志值。
import shutil
shutil.copy('source.txt', 'destination1.txt')
shutil.copy2('source.txt', 'destination2.txt')
2. 目录复制
使用shutil.copytree函数能够递归地复制整个目录及其子目录和文件。假设我们有一个名为my_folder的目录,要将其复制为my_folder_backup:
import shutil
shutil.copytree('my_folder','my_folder_backup')
这样my_folder中的所有内容,包括子目录和文件都会被完整地复制到my_folder_backup中。
3.文件移动与重命名
shutil.move函数既能移动文件(如果新目录有同名文件会报错),也能对文件进行重命名。比如将old_name.txt文件移动到new_directory目录下,并将其重命名为new_name.txt:
import shutil
shutil.move('old_name.txt', 'new_directory/new_name.txt')
如果目标路径和源路径在同一目录,那么就相当于对文件进行重命名。在整理文件、批量修改文件名等场景中,shutil.move非常实用。
4.文件删除
shutil.rmtree函数用于删除整个目录及其所有内容。例如要删除temp_folder目录及其包含的所有文件和子目录:
import shutil
shutil.rmtree('temp_folder')
需谨慎使用此函数,因为一旦执行,被删除的目录和文件将无法恢复。在清理临时文件、删除不再需要的项目文件夹等场景中,它能快速完成任务。
5.文件压缩与解压缩
shutil模块支持常见的压缩格式,如.zip和.tar。
- 压缩文件:使用shutil.make_archive函数可以创建压缩文件。例如将my_project目录压缩为my_project.zip:
import shutil
shutil.make_archive('my_project', 'zip','my_project')
这里第一个参数是压缩文件的名称(不包含扩展名),第二个参数是压缩格式,第三个参数是要压缩的目录。
- 解压缩文件:shutil.unpack_archive函数用于解压缩文件。假设我们有一个archive.zip压缩文件,要将其解压到extract_folder目录:
import shutil
shutil.unpack_archive('archive.zip', 'folder')
在分发项目、备份数据以及下载和解压资源等场景中,文件压缩与解压缩功能十分常用。
闭坑指南
文件复制时的权限问题
在进行文件复制时,如果目标目录的权限设置不允许写入,会导致复制失败。例如在 Linux 系统中,目标目录权限为只读:
import shutil
# 假设 /readonly_dir 权限为只读
# 错误示范,会报错 PermissionError
# shutil.copy('source.txt', '/readonly_dir/destination.txt')
在复制文件前,要确保目标路径有足够的写入权限,可通过修改目录权限或选择有写入权限的目标路径来解决。
目录删除时的误操作
shutil.rmtree函数一旦执行,被删除目录及其内容将无法恢复。如果不小心指定了错误的目录名,可能会造成严重的数据丢失。例如:
import shutil
# 错误示范,误将重要目录删除
# shutil.rmtree('important_project')
在使用shutil.rmtree前,务必仔细确认要删除的目录是否正确,或者可以先进行一些测试性操作,确保无误后再正式执行。
压缩与解压缩的格式不匹配
在进行文件压缩和解压缩时,要确保指定的格式与实际文件格式匹配。例如尝试将一个.tar.gz文件按.zip格式解压缩:
import shutil
# 错误示范,格式不匹配会报错
# shutil.unpack_archive('archive.tar.gz', 'extract_folder', 'zip')
在压缩和解压缩文件前,要明确文件的实际格式,并选择正确的压缩和解压缩格式参数。
专家工具箱
1. 自定义文件复制过滤
shutil.copytree函数可以接受一个ignore参数,用于指定过滤规则,只复制符合条件的文件和目录。例如,只复制目录中的.py文件,忽略其他文件和目录:
import shutil
#自定义过滤函数
def ignore_non_py_files(src, names):
return [name for name in names if not name.endswith('.py')]
#传入ignore参数
shutil.copytree('source', 'dest', ignore = ignore_non_py_files)
#也可以使用shutil自带的过滤函数,忽略的文件后缀可以填多个
#并且参数dirs_exist_ok=True 表示允许继续执行,而不是抛出FileExistsError异常。这个参数在 Python 3.8 版本中添加。
shutil.copytree('source', 'dest', ignore=shutil.ignore_patterns('*.py','*.docx'),
dirs_exist_ok=True)
在选择性备份代码文件、筛选特定类型文件进行处理等场景中,这种自定义过滤功能非常有用。
2. 安全的文件操作
为了避免在文件移动或删除操作中因意外导致数据丢失,可以先进行备份操作。例如在移动文件前,先复制一份作为备份:
import shutil
import os
source_file = 'important_file.txt'
backup_file = 'important_file_backup.txt'
destination_dir = 'new_location'
# 备份文件
shutil.copy(source_file, backup_file)
# 移动文件
shutil.move(source_file, os.path.join(destination_dir, os.path.basename(source_file)))
在处理重要文件时,这种先备份再操作的方式可以有效降低数据丢失风险。
小白:(眼睛放光)哇,shutil模块原来这么强大,能解决这么多文件处理的难题!
专家:(点头)没错,熟练掌握shutil模块,你在Python文件处理方面会更加得心应手,快去实践一下吧!
常用函数速查表
函数 | 用法 | 说明 |
shutil.copy2 | shutil.copy2(source, destination) | 复制文件 |
shutil.copytree | shutil.copytree(source, destination[, ignore]) | 递归复制目录 |
shutil.move | shutil.move(source, destination) | 移动或重命名文件 / 目录 |
shutil.rmtree | shutil.rmtree(directory) | 删除目录及其所有内容 |
shutil.make_archive | shutil.make_archive(base_name, format[, root_dir]) | 创建压缩文件 |
shutil.unpack_archive | shutil.unpack_archive(filename, extract_dir[, format]) | 解压缩文件 |