python包合集shutil示例代码详解

Glenna ·

更新时间:2024-11-14

· 1587 次阅读

一、简介

二、copy()

三、copy2() 复制文件和状态信息

四、copyfileobj()

五、copyfile()

六、copytree()

七、move()

八、disk_usage()

九、 make_archive()

十、 get_archive_formats()

十一、unpack_archive()

十二、rmtree()

一、简介

shutil是 python 中的高级文件操作模块，与os模块形成互补的关系，os主要提供了文件或文件夹的新建、删除、查看等方法，还提供了对文件以及目录的路径操作。shutil模块提供了移动、复制、压缩、解压等操作，恰好与os互补，共同一起使用，基本能完成所有文件的操作。是一个非常重要的模块。

二、copy()

1、描述：复制文件

2、语法：shutil.copy(fsrc，path)，返回值：返回复制之后的路径

fsrc：源文件

path：目标地址

3、代码示例：

import shutil
# 1、 copy() 复制文件
result1 = shutil.copy('/Users/houlei/Desktop/code/python/python_demo/shutil_demo/a.txt',
                      '/Users/houlei/Desktop/code/python/python_demo/shutil_demo/b.txt')
print('result1 = {}'.format(result1))

4、输出结果

houlei@houleideMacBook-Pro shutil_demo % python3 shutil_demo.py
result1 = /Users/houlei/Desktop/code/python/python_demo/shutil_demo/b.txt

5、解释：这是在/Users/houlei/Desktop/code/python/python_demo/shutil_demo 目录下就多了一个b.txt

三、copy2() 复制文件和状态信息

1、描述：复制文件和状态信息，作用和用法都同 copy() 类似

2、语法：shutil.copy(fsrc，path)，返回值：返回复制之后的路径

fsrc：源文件

path：目标地址

四、copyfileobj()

1、描述：以文件对象的形式，将一个文件的内容拷贝到另一个文件中，如果目标文件本身就有内容，来源文件的内容会把目标文件的内容覆盖掉。如果文件不存在它会自动创建一个。

2、语法：shutil.copyfileobj(fsrc, fdst[, length=16*1024])

fsrc：源文件

fdst：复制至fdst文件

length：缓冲区大小，即fsrc每次读取的长度

3、代码演示

f1 = open('a.txt', 'r')  # 读取一个文件
f2 = open('c.txt', 'w')  # 写入一个文件
shutil.copyfileobj(f1, f2, length=10*1024)

4、说明：这时就将a.txt 里面的内容复制到了c.txt中

五、copyfile()

1、描述：将一个文件的内容拷贝到另一个文件中，目标文件无需存在

2、语法：shutil.copyfile(src, dst,follow_symlinks)

src：源文件路径

dst：复制至dst文件，若dst文件不存在，将会生成一个dst文件；若存在将会被覆盖

follow_symlinks：设置为True时，若src为软连接，则当成文件复制；如果设置为False，复制软连接。默认为True

3、代码示例

shutil.copyfile('/Users/houlei/Desktop/code/python/python_demo/shutil_demo/b.txt',
                '/Users/houlei/Desktop/code/python/python_demo/shutil_demo/d.txt')

4、解释：这时在/Users/houlei/Desktop/code/python/python_demo/shutil_demo 目录下就会有一个d.txt

六、copytree()

1、描述：复制整个目录文件，不需要的文件类型可以不复制

2、语法：shutil.copytree(oripath, despath,ignore= shutil.ignore_patterns("*.xls", "*.doc"))

oripath : "来源路径"

despath : "目标路径"

ignore : shutil.ignore_patterns() 是对内容进行忽略筛选，将对应的内容进行忽略。

3、工程示例

该项目中创建一个test1,文件夹里面创建，e.doc, f.xls, g.txt 等不同后缀的文件用做测试

4、代码演示

shutil.copytree('/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1',
                '/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test2',
                ignore=shutil.ignore_patterns("*.doc")) # 过滤掉后缀为.doc的文件

七、move()

1、描述：移动文件或文件夹

2、语法：shutil.move(src, dst)

3、代码演示

shutil.move('/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1/e.doc',
            "/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test2")

八、disk_usage()

1、描述：查看磁盘使用信息，计算磁盘总存储，已用存储，剩余存储信息。

2、语法：shutil.disk_usage('盘符')

3、返回值：元组

4、代码演示

result = shutil.disk_usage("/Users/houlei")
print('result = {}'.format(result))

5、输出结果

result = usage(total=250790436864, used=155602710528, free=77850771456)

九、 make_archive()

1、描述：压缩打包

2、语法：make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,dry_run=0, owner=None, group=None, logger=None)

base_name：压缩包的文件名，也可以是压缩包的路径。只是文件名时，则保存至当前目录，否则保存至指定路径

format：压缩或者打包格式"zip", "tar", "bztar"or "gztar"

root_dir : 将哪个目录或者文件打包（也就是源文件）

3、代码演示

# 将test2 打包后放在test1中，压缩后的名字叫test2_package, 格式是tar
shutil.make_archive(base_name='/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1/test2_package', 
                    format="tar",
                    root_dir='/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test2')

十、 get_archive_formats()

1、描述：获取支持的压缩文件格式。目前支持的有：tar、zip、gztar、bztar。在Python3还多支持一种格式xztar

2、代码演示

result = shutil.get_archive_formats()
print('result = {}'.format(result))

3、输出结果

result = [('bztar', "bzip2'ed tar-file"), ('gztar', "gzip'ed tar-file"), ('tar', 'uncompressed tar file'), ('xztar', "xz'ed tar-file"), ('zip', 'ZIP file')]

十一、unpack_archive()

1、描述：解压文件。

2、语法：unpack_archive(filename, extract_dir=None, format=None)

filename：文件路径

extract_dir：解压至的文件夹路径。文件夹可以不存在，会自动生成

format：解压格式，默认为None，会根据扩展名自动选择解压格式

3、代码示例

shutil.unpack_archive(filename='/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1/test2_package.tar',
                      extract_dir='/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1/test2',
                      format=None)