Python高級(jí)文件操作之shutil庫(kù)詳解

前言

什么算是高層的文件操作呢？

普通的文件操作，我們一般只涉及創(chuàng)建文件，文件夾以及寫入文件等等。假如我現(xiàn)在需要復(fù)制一個(gè)文件的內(nèi)容到另一個(gè)文件之中，用pathlib等都只能先打開復(fù)制文件，然后進(jìn)行將其讀出來(lái)保存，然后再寫入新的文件，這種普通的復(fù)制操作，無(wú)形之中增加了許多步驟。

而shutil庫(kù)可以直接完成復(fù)制符間的操作，同時(shí)還支持歸檔。本篇，將詳細(xì)介紹文件的高層次操作。

一、copyfile()

copyfile()函數(shù)用于將一個(gè)文件的內(nèi)容復(fù)制到另一個(gè)文件之中，準(zhǔn)備的來(lái)說(shuō)，它不是copy內(nèi)容，而是直接copy文件，并重命名。

示例如下：

import shutil

shutil.copyfile('week.csv', 'week_copy.csv')

很簡(jiǎn)單，就一行代碼，第1個(gè)參數(shù)是需要copy的源文件，第2個(gè)參數(shù)是需要復(fù)制的新文件。運(yùn)行之后，效果如下：

二、copy()與copy2()

不過(guò)，copyfile()函數(shù)用于復(fù)制文件有一個(gè)缺陷，該函數(shù)的原理是通過(guò)打開源文件進(jìn)行讀取。所以，如果是某些特殊的文件，比如是UNIX設(shè)備節(jié)點(diǎn)，沒(méi)有權(quán)限會(huì)報(bào)IOERROR錯(cuò)誤。

還需要注意的是，通過(guò)copyfile()函數(shù)復(fù)制的文件是一個(gè)新文件，它不包括舊文件的訪問(wèn)時(shí)間與修改時(shí)間。

而copy2()函數(shù)可以復(fù)制文件后保留訪問(wèn)時(shí)間，修改時(shí)間。示例如下：

import shutil
import os
import time

shutil.copy2('week.csv', 'week_copy.csv')
stat_info1 = os.stat('week.csv')
stat_info2 = os.stat('week_copy.csv')
print("源文件信息")
print(oct(stat_info1.st_mode))
print('文件創(chuàng)建時(shí)間:{}'.format(time.ctime(stat_info1.st_ctime)))
print('文件訪問(wèn)時(shí)間:{}'.format(time.ctime(stat_info1.st_atime)))
print('文件修改時(shí)間:{}'.format(time.ctime(stat_info1.st_mtime)))
print("復(fù)制文件信息")
print(oct(stat_info2.st_mode))
print('文件創(chuàng)建時(shí)間:{}'.format(time.ctime(stat_info2.st_ctime)))
print('文件訪問(wèn)時(shí)間:{}'.format(time.ctime(stat_info2.st_atime)))
print('文件修改時(shí)間:{}'.format(time.ctime(stat_info2.st_mtime)))

運(yùn)行之后，效果如下：

而copy()與copyfile()一樣都是復(fù)制文件的函數(shù)，不過(guò)copy()你給它一個(gè)文件夾名或者文件都可以復(fù)制，如果給文件夾名稱，它會(huì)復(fù)制到文件夾下的目錄中，當(dāng)然復(fù)制的文件同名。而copyfile()如果給的是一個(gè)文件夾名稱會(huì)報(bào)錯(cuò)。

示例如下：

import shutil
import os

os.mkdir('data')
shutil.copy('week.csv', 'data')

運(yùn)行之后，效果如下：

三、copymode()與copystat()

通過(guò)copy2()函數(shù)，我們知道了如何復(fù)制文件內(nèi)容和文件信息等操作。但是其復(fù)制并不包含文件的權(quán)限，比如我們的Win10系統(tǒng)C盤中，有些文件只能讀不能寫，那么如果將權(quán)限也復(fù)制過(guò)去呢？

答案是：copymode()函數(shù)，示例如下：

import shutil
import os, stat

with open("temp.txt", 'wt') as file:
    file.write("11111111111111111")
os.chmod("temp.txt", stat.S_IREAD)
shutil.copymode('temp_copymode.txt', 'temp.txt')
print(oct(os.stat('temp.txt').st_mode))
print(oct(os.stat('temp_copymode.txt').st_mode))

需要注意的是，copymode()復(fù)制的只是文件權(quán)限，不是文件，也就是被賦予權(quán)限的文件名必須存在后才能將某個(gè)文件的權(quán)限復(fù)制給它。比如這里temp_copymode.txt獲取temp.txt權(quán)限，那么temp_copymode.txt必須存在后才能操作。而且這只是復(fù)制權(quán)限，并沒(méi)有復(fù)制內(nèi)容。（stat.S_IXGRP組用戶組執(zhí)行權(quán)限）

至于copystat()函數(shù)，不僅復(fù)制權(quán)限，而且也復(fù)制了文件的信息。具體代碼如下：

import shutil
import os, stat
import time

with open("temp.txt", 'wt') as file:
    file.write("11111111111111111")
os.chmod("temp.txt", stat.S_IXGRP)
shutil.copystat('temp_copymode.txt', 'temp.txt')
stat_info1 = os.stat('temp.txt')
stat_info2 = os.stat('temp_copymode.txt')
print("源文件信息")
print(oct(stat_info1.st_mode))
print('文件創(chuàng)建時(shí)間:{}'.format(time.ctime(stat_info1.st_ctime)))
print('文件訪問(wèn)時(shí)間:{}'.format(time.ctime(stat_info1.st_atime)))
print('文件修改時(shí)間:{}'.format(time.ctime(stat_info1.st_mtime)))
print("復(fù)制文件信息")
print(oct(stat_info2.st_mode))
print('文件創(chuàng)建時(shí)間:{}'.format(time.ctime(stat_info2.st_ctime)))
print('文件訪問(wèn)時(shí)間:{}'.format(time.ctime(stat_info2.st_atime)))
print('文件修改時(shí)間:{}'.format(time.ctime(stat_info2.st_mtime)))

運(yùn)行之后，效果如下：

四、復(fù)制整個(gè)文件夾

上面的所有復(fù)制都是針對(duì)單個(gè)文件的操作，但其實(shí)我們還會(huì)在實(shí)際的項(xiàng)目中，將整個(gè)文件夾復(fù)制到另一個(gè)位置。而且復(fù)制整個(gè)文件夾肯定會(huì)用到遞歸，不過(guò)shutil庫(kù)有一個(gè)更簡(jiǎn)單的函數(shù)用于實(shí)現(xiàn)該操作：copytree()。

示例如下：

import shutil

shutil.copytree('./text', './text_copy')

這里一行代碼就可以完成整個(gè)文件夾的實(shí)現(xiàn)。需要注意的是，第2個(gè)參數(shù)為需要復(fù)制到的目錄，但該文件夾不能存在，copytree()函數(shù)會(huì)自動(dòng)創(chuàng)建的，如果存在會(huì)報(bào)錯(cuò)。

參數(shù)copy_function

有時(shí)候，我們復(fù)制文件夾并不是需要將整個(gè)文件夾都復(fù)制過(guò)來(lái)，而是只需要指定的符合規(guī)則的文件，比如我們只需要某個(gè)文件夾下的所有后綴為py的文件，那么怎么篩選呢？

示例如下：

import shutil

def verbose_copy(src, dst):
    if src.endswith(".py"):
        return shutil.copy2(src, dst)

shutil.copytree('./text', './text_copy', copy_function=verbose_copy)

這里，我們通過(guò)copytree()函數(shù)的參數(shù)copy_function進(jìn)行參數(shù)，該參數(shù)提供一個(gè)函數(shù)用于篩選符合規(guī)則的文件進(jìn)行復(fù)制，比如這里，我們提供了一個(gè)函數(shù)，并判斷后綴是否是.py然后再創(chuàng)建，當(dāng)然，它會(huì)保存目錄結(jié)構(gòu)，但只復(fù)制.py后綴的文件。

參數(shù)ignore

copytree()不僅只有copy_function參數(shù)，還有一個(gè)ignore參數(shù)，它可以過(guò)濾掉某些文件，比如還是如上面一樣，但是我們不需要.py后綴的文件，其他文件都復(fù)制，那么可以這樣實(shí)現(xiàn)。

import shutil

shutil.copytree('./text', './text_copy', ignore=shutil.ignore_patterns('*.py'))

這樣，就不會(huì)復(fù)制*.py規(guī)則的文件。

五、刪除整個(gè)文件夾

既然有復(fù)制整個(gè)文件夾，那么肯定shutil庫(kù)也會(huì)提供反向的操作用于刪除整個(gè)文件夾。刪除整個(gè)文件夾的函數(shù)為：rmtree()。

import shutil

shutil.rmtree('./text_copy')

這樣，我們就刪除了上面復(fù)制的文件夾內(nèi)容。

六、移動(dòng)文件夾或文件

除了復(fù)制文件與文件夾之外，我們?cè)趯?shí)際的項(xiàng)目中，還會(huì)移動(dòng)整個(gè)某個(gè)文件或某個(gè)目錄到另一個(gè)位置，shutil庫(kù)提供了move()函數(shù)用于移動(dòng)文件或文件夾。

示例如下：

import shutil

shutil.move('week.csv', './text')

這里，我們將csv文件移動(dòng)到了剛才用于復(fù)制的text源文件目錄。（移動(dòng)文件夾一樣操作，只是將文件名改為文件夾名）

七、查找文件

在更多的文件操作中，我們往往還需要查找某個(gè)文件。而shutil庫(kù)提供了which()函數(shù)用于搜索查找目標(biāo)文件。它有3個(gè)參數(shù)：mode可以設(shè)置查找文件的權(quán)限，path為需要查找的路徑，cmd為要查找的文件。

示例如下：

import shutil

filename = shutil.which('python')
print(filename)

運(yùn)行之后，效果如下：

八、歸檔

shutil庫(kù)提供了更多高層函數(shù)來(lái)創(chuàng)建和解壓歸檔文件。我們先來(lái)看看shutil庫(kù)支持哪些格式，示例如下：

import shutil

for format,desc in shutil.get_archive_formats():
    print('{:5}:{}'.format(format,desc))

運(yùn)行之后，效果如下：

簡(jiǎn)單的理解就是支持的壓縮格式。

8.1 壓縮文件

我們先來(lái)看一個(gè)簡(jiǎn)單的例子，將某個(gè)文件夾進(jìn)行壓縮，代碼如下：

import shutil

shutil.make_archive('text','gztar',root_dir='..',base_dir='base_demo')

這里我們將text文件夾，壓縮格式為gztar。運(yùn)行之后，效果如下：

其中，root_dir指定要壓縮的路徑根目錄（默認(rèn)當(dāng)前目錄），只能指定路徑，優(yōu)先級(jí)低于base_dir。base_dir指定要壓縮文件的路徑，可以指定路徑下的文件名，也可以指定路徑。

8.2 解壓縮

既然有壓縮，肯定也就有解壓縮。shutil庫(kù)提供了unpack_archive()進(jìn)行解壓縮文件。示例如下：

import shutil

shutil.unpack_archive('text.tar.gz',extract_dir='text_un')

unpack_archive()函數(shù)的第1個(gè)參數(shù)為需要解壓的文件，第2個(gè)參數(shù)為需要解壓到哪里。

8.3 文件系統(tǒng)空間

完成一個(gè)長(zhǎng)時(shí)間運(yùn)行的可能耗盡可用空間的操作之前，最好先檢查本地文件系統(tǒng)，來(lái)看看有多少可用的空間。shutil庫(kù)提供了disk_usage()函數(shù)來(lái)返回包括總空間，當(dāng)前正在使用的空間以及未使用的空間。

示例如下：

import shutil

(total, used, free) = shutil.disk_usage("E:/")
BytesPerGB = 1024 * 1024 * 1024
print ("Total: %.2fGB" % (float(total)/BytesPerGB))
print ("Used: %.2fGB" % (float(used)/BytesPerGB))
print ("Free: %.2fGB" % (float(free)/BytesPerGB))

運(yùn)行之后，效果如下：

這里博主是獲取電腦E盤的信息，比如這里獲取到E盤總大小total為238G，已使用Used為43G，未使用Free：194G。一個(gè)健壯的程序必然很嚴(yán)謹(jǐn)，所以在操作文件時(shí)，特別是比較大的文件時(shí)，一定要判斷磁盤的大小之后再操作。

到此這篇關(guān)于Python高級(jí)文件操作之shutil庫(kù)詳解的文章就介紹到這了,更多相關(guān)Python shutil庫(kù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！