常用函数组合(持续更新)
shutil模块的常见函数列表
复制类
- shutil.copy(src, dst):将文件src复制至dst。dst可以是个目录,会在该目录下创建与src同名的文件,若该目录下存在同名文件,将会报错提示已经存在同名文件。权限会被一并复制。
- shutil.copy2(src, dst):将文件src复制至dst。dst可以是个目录,会在该目录下创建与src同名的文件,若该目录下存在同名文件,将会报错提示已经存在同名文件。权限、上次访问时间、上次修改时间和src的标志会一并复制至dst。
- shutil.copyfile(src, dst):将src文件内容复制至dst文件。
- shutil.copyfileobj(fsrc, fdst[, length]):将fsrc文件内容复制至fdst文件,length为fsrc每次读取的长度,用做缓冲区大小(用的较少)
- shutil.copytree(src, dst, symlinks=False, ignore=None):复制整个文件目录(无论文件夹是否为空,均可以复制,而且会复制文件夹中的所有内容)
- copymode(src, dst): 将src文件权限复制至dst文件。文件内容,所有者和组不受影响
- copystat(src, dst): 将权限,上次访问时间,上次修改时间以及src的标志复制到dst。文件内容,所有者和组不受影响
删除/移动类
- rmtree(path, ignore_errors=False, οnerrοr=None): 移除文档树,将文件夹目录删除
- move(src, dst): 将src移动至dst目录下。若dst目录不存在,则效果等同于src改名为dst。若dst目录存在,将会把src文件夹的所有内容移动至该目录下面
压缩/解压类
- make_archive(base_name, format, root_dir, …): 生成压缩文件
- unpack_archive(filename, extract_dir=None, format=None): 解压操作。Python3新增方法
复制类函数代码演示
shutil.copy(src, dst)
功能:将文件src复制至dst。dst可以是个目录,会在该目录下创建与src同名的文件,若该目录下存在同名文件,将会报错提示已经存在同名文件。权限会被一并复制。本质是先后调用了copyfile与copymode而已
- src:源文件路径
- dst:复制至dst文件夹或文件
- follow_symlinks:设置为False时,src, dst皆为软连接,可以复制软连接权限,如果设置为True,则当成普通文件复制权限。默认为True。Python3新增参数
import shutil,os
shutil.copy("./资料/1.txt","./资料/1-1.txt")
# 或者(在这不用)
#shutil.copy("file.txt",os.path.join(os.getcwd(),"copy"))#参考使用
shutil.copy2(src, dst)
功能:将文件src复制至dst。dst可以是个目录,会在该目录下创建与src同名的文件,若该目录下存在同名文件,将会报错提示已经存在同名文件。权限、上次访问时间、上次修改时间和src的标志会一并复制至dst。本质是先后调用了copyfile与copystat方法而已
- src:源文件路径
- dst:复制至dst文件夹或文件
- follow_symlinks:设置为False时,src, dst皆为软连接,可以复制软连接权限、上次访问时间,上次修改时间以及src的标志,如果设置为True,则当成普通文件复制权限。默认为True。Python3新增参数
import shutil,os
shutil.copy2("./资料/1.txt","./资料/1-2.txt")
# 或者
#shutil.copy2("file.txt",os.path.join(os.getcwd(),"copy")) #参考使用
shutil.copyfile(src, dst)
功能:将src文件内容复制至dst文件
- src: 源文件路径
- dst: 复制至dst文件,若dst文件不存在,将会生成一个dst文件;若存在将会被覆盖
- follow_symlinks:设置为True时,若src为软连接,则当成文件复制;如果设置为False,复制软连接。默认为True。Python3新增参数
import shutil
shutil.copyfile("./资料/1.txt","./资料/1_empty.txt")
执行前
执行后
shutil.copyfileobj(fsrc, fdst[, length])(用的比较少)
功能:将fsrc文件内容复制至fdst文件,length为fsrc每次读取的长度,用做缓冲区大小
- fsrc: 源文件
- fdst: 复制至fdst文件
- length: 缓冲区大小,即fsrc每次读取的长度
import shutil
shutil.copyfileobj(open('./资料/1.txt','r'), open('./资料/2.txt', 'a'))#追加操作
执行前
执行后
shutil.copytree(src, dst, symlinks=False, ignore=None)
功能:复制整个文件目录(无论文件夹是否为空,均可以复制,而且会复制文件夹中的所有内容)
- src:源文件夹
- dst:复制至dst文件夹,该文件夹会自动创建,需保证此文件夹不存在,否则将报错
- symlinks:是否复制软连接,True复制软连接,False不复制,软连接会被当成文件复制过来,默认False
- ignore:忽略模式,可传入ignore_patterns()
- copy_function:拷贝文件的方式,可以传入一个可执行的处理函数,默认为copy2,Python3新增参数
- ignore_dangling_symlinks:sysmlinks设置为False时,拷贝指向文件已删除的软连接时,将会报错,如果想消除这个异常,可以设置此值为True。默认为False,Python3新增参数
import shutil,os
shutil.copytree("./资料/ceshi","./资料/taiget/",ignore=shutil.ignore_patterns("abc.txt","bcd.txt"))#忽略哪些文件
执行前
执行后(会新创建文件夹,并将原始文件夹里的内容完整的复制到新文件夹内)
copymode(src, dst)(次)
功能:将src文件权限复制至dst文件。文件内容,所有者和组不受影响
- src: 源文件路径
- dst: 将权限复制至dst文件,dst路径必须是真实的路径,并且文件必须存在,否则将会报文件找不到错误
- follow_symlinks:设置为False时,src, dst皆为软连接,可以复制软连接权限,如果设置为True,则当成普通文件复制权限。默认为True。Python3新增参数
import shutil
shutil.copymode("file.txt","file_copy.txt")
copystat(src, dst) (次)
功能:将权限,上次访问时间,上次修改时间以及src的标志复制到dst。文件内容,所有者和组不受影响
- src: 源文件路径
- dst: 将权限复制至dst文件,dst路径必须是真实的路径,并且文件必须存在,否则将会报文件找不到错误
- follow_symlinks:设置为False时,src, dst皆为软连接,可以复制软连接权限、上次访问时间,上次修改时间以及src的标志,如果设置为True,则当成普通文件复制权限。默认为True。Python3新增参数
import shutil
shutil.copystat("file.txt","file_copy.txt")
删除/移动类函数代码演示
rmtree(path, ignore_errors=False, οnerrοr=None)(只能删除文件夹,不能删除文件)
功能:移除整个目录,无论是否空
- ignore_errors:是否忽略错误,默认False
- onerror:定义错误处理函数,需传递一个可执行的处理函数,该处理函数接收三个参数:函数、路径和excinfo
import shutil
shutil.rmtree('./资料/taiget')
shutil.move(src, dst)
功能:文件移动,可重命名,会删除原文件,新路径需指定文件名
- src:源文件夹或文件
- dst:移动至dst文件夹,或将文件改名为dst文件。如果src为文件夹,而dst为文件将会报错
- copy_function:拷贝文件的方式,可以传入一个可执行的处理函数。默认为copy2,Python3新增参数
import shutil
#重命名文件夹
shutil.move('./资料/ceshi', './资料/ceshi1')
#移动文件进入新移动的文件夹
shutil.move('./资料/1-2.txt', './资料/ceshi1')
压缩/解压类函数代码演示
make_archive(base_name, format, root_dir, …)
功能:生成压缩文件
- base_name:压缩文件的文件名,不允许有扩展名,因为会根据压缩格式生成相应的扩展名
- format:压缩格式
- root_dir:将制定文件夹进行压缩
- get_archive_formats(): 获取支持的压缩文件格式。目前支持的有:tar、zip、gztar、bztar。在Python3还多支持一种格式xztar
import shutil
#指定要压缩的文件
base_name = "./资料/2.txt"
#指定压缩形式
format = "zip"
#指定压缩后放在哪里
root_dir = "./资料/"
shutil.make_archive(base_name, format, root_dir)
unpack_archive(filename, extract_dir=None, format=None)
功能:解压操作
- filename:文件路径
- extract_dir:解压至的文件夹路径。文件夹可以不存在,会自动生成
- format:解压格式,默认为None,会根据扩展名自动选择解压格式
import shutil
#指定压缩文件的地址
zip_path = "./资料/2.txt.zip"
#指定解压缩到哪里
extract_dir = "./资料/ceshi1/"
shutil.unpack_archive(zip_path, extract_dir)