[转]Python shutil 模块

转自：

https://www.cnblogs.com/wuzhiblog/p/6535527.html

https://www.cnblogs.com/caibao666/p/6433864.html

---

shutil 复制、移动、重命名、删除

shutil 名字来源于 shell utilities，有学习或了解过Linux的人应该都对 shell 不陌生，可以借此来记忆模块的名称。该模块拥有许多文件（夹）操作的功能，包括复制、移动、重命名、删除等等

1. chutil.copy(source, destination)
   shutil.copy() 函数实现文件复制功能，将 source 文件复制到 destination 文件夹中，两个参数都是字符串格式。如果 destination 是一个文件名称，那么它会被用来当作复制后的文件名称，即等于 复制 + 重命名。举例如下：

   >> import shutil
   >> import os
   >> os.chdir('C:\')
   >> shutil.copy('C:\spam.txt', 'C:\delicious')
   'C:\delicious\spam.txt'
   >> shutil.copy('eggs.txt', 'C:\delicious\eggs2.txt')
   'C:\delicious\eggs2.txt'

   如代码所示，该函数的返回值是复制成功后的字符串格式的文件路径

2. shutil.copytree(source, destination)
   shutil.copytree()函数复制整个文件夹，将 source 文件夹中的所有内容复制到 destination 中，包括 source 里面的文件、子文件夹都会被复制过去。两个参数都是字符串格式。

   注意，如果 destination 文件夹已经存在，该操作并返回一个 FileExistsError 错误，提示文件已存在。即表示，如果执行了该函数，程序会自动创建一个新文件夹（destination参数）并将 source 文件夹中的内容复制过去
   举例如下：

>> import shutil
>> import os
>> os.chdir('C:\')
>> shutil.copytree('C:\bacon', 'C:\bacon_backup')
'C:\bacon_backup'

如以上代码所示，该函数的返回值是复制成功后的文件夹的绝对路径字符串
所以该函数可以当成是一个备份功能

1. shutil.move(source, destination)
   shutil.move() 函数会将 source 文件或文件夹移动到 destination 中。返回值是移动后文件的绝对路径字符串。
   如果 destination 指向一个文件夹，那么 source 文件将被移动到 destination 中，并且保持其原有名字。例如：

>> import shutil
>> shutil.move('C:\bacon.txt', 'C:\eggs')
'C:\eggs\bacon.txt'

上例中，如果 C:\eggs 文件夹中已经存在了同名文件 bacon.txt，那么该文件将被来自于 source 中的同名文件所重写。

如果 destination 指向一个文件，那么 source 文件将被移动并重命名，如下：

>> shutil.move('C:\bacon.txt', 'C:\eggs\new_bacon.txt')
'C:\eggs\new_bacon.txt'

等于是移动+重命名

<b>注意，如果 destination 是一个文件夹，即没有带后缀的路径名，那么 source 将被移动并重命名为 destination</b>，如下：

>> shutil.move('C:\bacon.txt', 'C:\eggs')
'C:\eggs'

即 bacon.txt 文件已经被重命名为 eggs，是一个没有文件后缀的文件

最后，destination 文件夹必须是已经存在的，否则会引发异常：

>> shutil.move('spam.txt', 'C:\does_not_exist\eggs\ham')
Traceback (most recent call last):
File "D:\Python36\lib\shutil.py", line 538, in move
os.rename(src, real_dst)
FileNotFoundError: [WinError 3] 系统找不到指定的路径。: 'test.txt' -> 'C:\does_not_exist\eggs\ham'
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "<pyshell#5>", line 1, in 
shutil.move('test.txt', 'C:\does_not_exist\eggs\ham')
File "D:\Python36\lib\shutil.py", line 552, in move
copy_function(src, real_dst)
File "D:\Python36\lib\shutil.py", line 251, in copy2
copyfile(src, dst, follow_symlinks=follow_symlinks)
File "D:\Python36\lib\shutil.py", line 115, in copyfile
with open(dst, 'wb') as fdst:
FileNotFoundError: [Errno 2] No such file or directory: 'C:\does_not_exist\eggs\ham'

1. 永久性删除文件和文件夹
   这里有涉及到 os 模块中的相关函数
   os.unlink(path) 会删除 path 路径文件
   os.rmdir(path)　会删除 path 路径文件夹，但是这个文件夹必须是空的，不包含任何文件或子文件夹
   shutil.rmtree(path) 会删除 path 路径文件夹，并且在这个文件夹里面的所有文件和子文件夹都会被删除

利用函数执行删除操作时，应该倍加谨慎，因为如果想要删除 txt 文件，而不小心写到了 rxt ，那么将会给自己带来麻烦
此时，我们可以利用字符串的 endswith 属性对文件格式进行检查与筛选

---

shutil：高级的 文件、文件夹、压缩包 处理模块

shutil.copyfileobj(fsrc, fdst[, length])（copyfileobj方法只会拷贝文件内容）
将文件内容拷贝到另一个文件中

import shutil

shutil.copyfileobj(open('old.xml','r'), open('new.xml', 'w'))

shutil.copyfile(src, dst)　　（copyfile只拷贝文件内容）
拷贝文件

shutil.copyfile('f1.log', 'f2.log')

shutil.copy(src, dst) 拷贝文件和权限

shutil.copy('f1.log', 'f2.log')

shutil.copy2(src, dst)

拷贝文件和状态信息

shutil.copy2('f1.log', 'f2.log'

shutil.copymode(src, dst)　　（前提是dst文件存在，不然报错）
仅拷贝权限。内容、组、用户均不变

shutil.copymode('f1.log', 'f2.log')

shutil.copystat(src, dst)
仅拷贝状态的信息，即文件属性，包括：mode bits, atime, mtime, flags

shutil.copystat('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*'))

shutil.copytree('f1', 'f2', symlinks=True, ignore=shutil.ignore_patterns('*.pyc', 'tmp*'))

shutil.rmtree(path[, ignore_errors[, onerror]])
递归的去删除文件

shutil.rmtree('folder1')

shutil.move(src, dst)
递归的去移动文件，它类似mv命令，其实就是重命名。

shutil.move('folder1', 'folder3')

shutil.make_archive(base_name, format,...)

创建压缩包并返回文件路径，例如：zip、tar

创建压缩包并返回文件路径，例如：zip、tar

• base_name： 压缩包的文件名，也可以是压缩包的路径。只是文件名时，则保存至当前目录，否则保存至指定路径， 如：www                        =>保存至当前路径 如：/Users/wupeiqi/www =>保存至/Users/wupeiqi/
• format： 压缩包种类，“zip”, “tar”, “bztar”，“gztar”
• root_dir： 要压缩的文件夹路径（默认当前目录）
• owner： 用户，默认当前用户
• group： 组，默认当前组
• logger： 用于记录日志，通常是logging.Logger对象
  

  #将 /Users/wupeiqi/Downloads/test 下的文件打包放置当前程序目录
  
  import shutil
  
  ret = shutil.make_archive("wwwwwwwwww", 'gztar', root_dir='/Users/wupeiqi/Downloads/test')
  
  #将 /Users/wupeiqi/Downloads/test 下的文件打包放置 /Users/wupeiqi/目录
  
  import shutil
  
  ret = shutil.make_archive("/Users/wupeiqi/wwwwwwwwww", 'gztar', root_dir='/Users/wupeiqi/Downloads/test')

  

shutil 对压缩包的处理是调用 ZipFile 和 TarFile 两个模块来进行的，详细：

import zipfile

# 压缩
z = zipfile.ZipFile('laxi.zip', 'w')
z.write('a.log')
z.write('data.data')
z.close()

# 解压
z = zipfile.ZipFile('laxi.zip', 'r')
z.extractall()
z.close()

import tarfile

# 压缩
tar = tarfile.open('your.tar','w')
tar.add('/Users/wupeiqi/PycharmProjects/bbs2.log', arcname='bbs2.log')
tar.add('/Users/wupeiqi/PycharmProjects/cmdb.log', arcname='cmdb.log')
tar.close()

# 解压
tar = tarfile.open('your.tar','r')
tar.extractall()  # 可设置解压地址
tar.close()

备注：zipfile压缩不会保留文件的状态信息，而tarfile会保留文件的状态信息