python包合集-shutil

2022 年 8 月 18 日
筆記
python包合集

一、簡介

　　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)

十二、rmtree()

　　1、描述：遞歸的去刪除文件

　　2、語法：shutil.rmtree(path[, ignore_errors[, onerror]])

　　3、程式碼示例

shutil.rmtree('/Users/houlei/Desktop/code/python/python_demo/shutil_demo/test1/test2')

Tags: python包合集