shutil模块高阶文件操作
shutil 模块提供了一系列对文件和文件集合的高阶操作。 特别是提供了一些支持文件拷贝和删除的函数。 对于单个文件的操作,请参阅 os 模块。
目录和文件操作
文件内容拷贝
shutil.copyfileobj(fsrc, fdst[, length])
将fsrc的内容拷贝到fdst。
fsrc:源文件对象
fdst:目标文件对象。
length:整数值,如果给出则为缓冲区大小。为负值表示拷贝数据时不对源数据进行分块循环处理;默认情况下会分块读取数据以避免不受控制的内存消耗。
import shutil
shutil.copyfileobj(open('old.xml','r'), open('new.xml', 'w'))
文件拷贝
shutil.copyfile(src, dst, *, follow_symlinks=True)

将名为 src 的文件的内容拷贝到名为 dst 的文件
src:源文件路径
dst:完整的目标文件路径
shutil.copyfile('f1.log', 'f2.log') #目标文件无需存在
权限拷贝
shutil.copymode(src, dst, *, follow_symlinks=True)
从 src 拷贝权限位到 dst。 文件的内容、所有者和分组将不受影响。 src 和 dst 均为字符串形式的路径名。
shutil.copymode('f1.log', 'f2.log') #目标文件必须存在
状态信息拷贝
shutil.copystat(src, dst, *, follow_symlinks=True)
从 src 拷贝权限位、最近访问时间、最近修改时间以及旗标到 dst。 在 Linux上,copystat() 还会在可能的情况下拷贝“扩展属性”。 文件的内容、所有者和分组将不受影响。 src 和 dst 均为路径类对象或字符串形式的路径名。
shutil.copystat('f1.log', 'f2.log') #目标文件必须存在
文件和权限拷贝
shutil.copy(src, dst, *, follow_symlinks=True)
将文件 src 拷贝到文件或目录 dst。 src和dst应为路径类对象或字符串。如果dst指定了一个目录,文件将使用 src 中的基准文件名拷贝到dst中。 将返回新创建文件所对应的路径。
import shutil
shutil.copy('f1.log', 'f2.log')
shutil.copy2(src, dst, *, follow_symlinks=True)
类似于 copy(),区别在于 copy2() 还会尝试保留文件的元数据。
import shutil
shutil.copy2('f1.log', 'f2.log')
递归的去拷贝文件夹
shutil.ignore_patterns(*patterns)
shutil.copytree(src, dst, symlinks=False, ignore=None)
shutil.copytree('folder1', 'folder2', ignore=shutil.ignore_patterns('*.pyc', 'tmp*')) #目标目录不能存在,注意对folder2目录父级目录要有可写权限,ignore的意思是排除
删除目录树
shutil.rmtree(path, ignore_errors=False, οnerrοr=None)
递归的去删除文件,删除一个完整的目录树;path 必须指向一个目录。 如果 ignore_errors 为真值,删除失败导致的错误将被忽略;如果为假值或是省略,此类错误将通过调用由 onerror 所指定的处理程序来处理,或者如果此参数被省略则将引发一个异常。
shutil.rmtree('folder1')
递归移动文件或目录
shutil.move(src, dst, copy_function=copy2)
递归地将一个文件或目录 (src) 移至另一位置 (dst) 并返回目标位置。
如果目标是已存在的目录,则 src 会被移至该目录下。 如果目标已存在但不是目录,它可能会被覆盖
shutil.move('folder1', 'folder3')
查找可执行文件路径
shutil.which(cmd, mode=os.F_OK | os.X_OK, path=None)
返回当给定的 cmd 被调用时将要运行的可执行文件的路径。 如果没有 cmd 会被调用则返回 None。
mode 是一个传递给 os.access() 的权限掩码,在默认情况下将确定文件是否存在并且为可执行文件。
当未指定 path 时,将会使用 os.environ() 的结果,返回 "PATH" 的值或回退为 os.defpath。
shutil.which("python")
归档操作
在 3.5 版更改: 添加了对 xztar 格式的支持。
本模块也提供了用于创建和读取压缩和归档文件的高层级工具。 它们依赖于 zipfile 和 tarfile 模块。
shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])
创建压缩包并返回文件路径,例如:zip、tar
base_name:压缩包的文件名,也可以是压缩包的路径。只是文件名时,则保存至当前目录,否则保存至指定路径
format:压缩包种类,“zip”, “tar”, “bztar”,“gztar”
root_dir:要压缩的文件夹路径(默认当前目录)
owner:用户,默认当前用户
group:组,默认当前组
logger:用于记录日志,通常是logging.Logger对象
#将 /data 下的文件打包放置当前程序目录
import shutil
ret = shutil.make_archive("data_bak", 'gztar', root_dir='/data')
#将 /data下的文件打包放置 /tmp/目录
import shutil
ret = shutil.make_archive("/tmp/data_bak", 'gztar', root_dir='/data')