An article will guide you through the shutil module in Python

1. What is shutil

shutil can be simply understood as sh util#, meaning shell tool. The shutil module is a supplement to the os module and is mainly used for copying, deleting, moving, compressing and decompressing files.

2. Main methods of shutil module

1. shutil.copyfileobj(fsrc, fdst[ , length=16*1024])

Copy the content of the file to another file, and you can copy the content of the specified size. This method is the basis for other copy methods in the shutil module. Other methods essentially call this method.

Let us take a look at its source code:

def copyfileobj(fsrc, fdst, length=16*1024):


    while 1:
        buf = fsrc.read(length)
        if not buf:
            break
        fdst.write(buf)

The code is very simple and can be understood at a glance. But please note that fsrc and fdst are file objects opened using the open() method.

import shutil
s =open('fsrc.txt','r')
d=open('fdst.txt','w')
shutil.copyfileobj(s,d,length=16*1024)

##2. shutil.copyfile(src, dst)

Copy file

shutil.copyfile('f1.log', 'f2.log') #目标文件无需存在

3. shutil.copymode(src, dst)

Copy permission only. The content, groups, and users remain unchanged

shutil.copymode('f1.log', 'f2.log') #目标文件必须存在

4. shutil.copystat(src, dst)

Only copy status information, including: mode bits, atime, mtime, flags

shutil.copystat('f1.log', 'f2.log') #目标文件必须存在

5. shutil.copy(src, dst)

拷贝文件和权限

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

6. shutil.copy2(src, dst)

拷贝文件和状态信息

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

7. 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
folder1 = os.path.join(os.getcwd(),"aaa")
# bbb与ccc文件夹都可以不存在,会自动创建
folder2 = os.path.join(os.getcwd(),"bbb","ccc")
# 将"abc.txt","bcd.txt"忽略，不复制
shutil.copytree(folder1,folder2,ignore=shutil.ignore_patterns("abc.txt","bcd.txt"))

8. shutil.rmtree(path[, ignore_errors[, onerror]])

递归的去删除文件

import shutil  
shutil.rmtree('folder1')

9. shutil.move(src, dst)

递归的去移动文件，它类似mv命令，其实就是重命名。

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

10.shutil.make_archive(base_name, format[, root_dir[, base_dir, verbose, dry_run, owner, group, logger])

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

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

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

  <br/>

  如 data_bak        保存至当前路径如：/tmp/data_bak =>保存至/tmp/

• format：压缩包种类，“zip”, “tar”, “bztar”，“gztar”

• root_dir：要压缩的文件夹路径（默认当前目录）

  owner：用户，默认当前用户

  group：组，默认当前组

  logger：用于记录日志，通常是logging.Logger对象

  <br/>

  把当前目录下的文件压缩生成copy.zip文件到当前目录下注意：此操作会出现递归拷贝压缩导致文件损坏（当前目录下的copy.zip中会有copy.zip）

  import shutil
  shutil.make_archives('D:\copy3\copy','zip',base_dir='D:\copy2\\测试.txt')

  把D:\copy2\测试.txt文件压缩，在D:\copy3\路径下生成copy.zip。

  import shutilshutil.make_archives('copy','zip')

  
  
  

三、总结

    本文主要介绍了Python中shutil模块，对模块中主要的方法进行了详细的介绍。对遇到的问题进行详细的解答。最后使用Python编程语言，通过在实际开发中的项目。方便大家对shutil模块的认知。希望对大家的学习有帮助。

The above is the detailed content of An article will guide you through the shutil module in Python. For more information, please follow other related articles on the PHP Chinese website!