用於自動化測試的 Python Shutil 模組

介紹

在軟體開發的動態領域，透過自動化測試確保應用程式品質至關重要。自動化測試涉及運行大量需要特定檔案和目錄設定的測試。有效地設定和拆除測試環境是此過程的重要組成部分，如果沒有合適的工具，這通常會是一項乏味且容易出錯的任務。

找到合適的工具來簡化任務可以帶來很大的不同。標準實用程式模組 Shutil 是 shell 實用程式的縮寫。它提供了用於複製、移動和刪除文件和目錄的高級文件操作，可以簡化測試環境的管理。本部落格解釋了 Shutil 模組如何簡化自動化軟體測試中的檔案操作。

為了確保每個測試都從正確的環境開始，我們需要自動化設定過程，創建一致且隔離的測試環境。

開始使用 Shutil

Shutil模組是Python標準函式庫的一部分，所以我們不需要安裝任何額外的東西。只需將其導入到腳本的開頭即可。

# Import shell utility module
import shutil

基本文件複製方法

在測試應用程式時，我們經常需要一組特定的資料檔案。四種常見方法提供了使用shutil模組複製檔案的簡單有效的方法，而不是手動複製檔案。

1. shutil.copy()
2. shutil.copy2()
3. shutil.copyfile()
4. shutil.copyfileobj()

1.shutil.copy()方法

shutil.copy(source, destination, *, follow_symlinks=True)

此方法將來源檔案複製到目標中指定的目錄或文件，並傳回檔案的目標。它複製檔案的資料和檔案的權限模式，但不保留複製的檔案的元資料（檔案建立和修改時間）。來源和目標應該是類似路徑的物件或字串。目標可以指定檔案或目錄。如果目標指定了目錄路徑，則檔案將以來源路徑的檔案名稱複製到目標目錄。
使用符號連結時：

• 如果 follow_symlinks=True，目標將是來源中符號連結指向的檔案的副本。參數 follow_symlinks 預設值為 True。

• 如果 follow_symlinks=False，目的地將建立為符號連結。
  

# Import shell utility module
import shutil

#  Copy the content of source_file.txt to destination_file.txt
shutil.copy('source_file.txt', 'destination_file.txt')

2.shutil.copy2()方法

shutil.copy2(source, destination, *, follow_symlinks=True)

shutil.copy2() 方法提供了保留檔案的所有元資料的附加功能。其他特徵與 Shutil.copy() 方法相同。目標可以指定檔案或目錄。如果目標是目錄，則檔案將以與來源檔案名稱相同的名稱複製。

# Import shell utility module
import shutil

#  Copy the content of source_file.txt to destination_file.txt
shutil.copy2('source_file.txt', 'destination_file.txt')

我在自動化測試時使用了這種方法，因為它會複製文件內容及其大多數相關元數據，以便我們可以通過編程方式實現與在圖形文件管理器中使用鍵盤快捷鍵複製和粘貼文件相同的結果，而且它也緊密相連在圖形檔案管理器中使用滑鼠複製典型複製和貼上操作的行為。

3.shutil.copyfile()方法

shutil.copyfile(source, destination, *, follow_symlinks=True)

使用此方法，檔案的內容可以從來源複製到目標，而無需元資料。來源和目標應該是類似路徑的物件或字串。目標路徑只能指定檔案路徑，不能指定目錄路徑。

# Import shell utility module
import shutil

#  Copy the content of source_file.txt to destination_file.txt
shutil.copyfile('source_file.txt', 'destination_file.txt')

4.shutil.copyfileobj()方法

shutil.copyfileobj(fsrc, fdst, length)

此方法將來源檔案物件的內容複製到目標檔案物件。來源和目標必須是類似文件的物件。它不保留元數據，也不傳回任何值。可選的長度參數指定緩衝區大小的整數值。

# Import shell utility module
import shutil

# Create file objects
source_file_object = open("../hello.txt", "r")
destination_file_object = open("CopyFile/copyFalseSrcPath.txt", "w")

# Copy the content of the file object to another file object
shutil.copyfileobj(source_file_object, destination_file_object)

預防常見錯誤：

• 來源和目標不能在shutil.copy()、shutil.copy2()和shutil.copyfile()指定相同的路徑。如果來源和目標指定相同的檔案路徑，則將引發異常「SameFileError」。 Shutil.copyfileobj() 中不會引發此錯誤，因為它會覆寫目標檔案（如果已存在）。
• 如果來源指定的檔案路徑不存在，將會引發「FileNotFound」錯誤。

結論

每種方法都提供了文件操作的不同方面，提供了靈活性和強大的功能來滿足各種測試需求。 Python 的 Shutil 模組提供了軟體測試中高效檔案操作的必備工具：

• Shutil.copy：非常適合基本檔案複製，包括權限。
• Shutil.copy2：非常適合複製檔案及其大部分元數據，包括時間戳記。
• Shutil.copyfile：最適合快速、簡單的內容複製，無需元資料。
• Shutil.copyfileobj：啟用類別檔案物件之間的精確複製。

其他一些在自動化測試時有用的常用實用函數是：

1. Shutil.mkdirs()：遞迴建立目錄。對於設定測試或組織文件所需的目錄結構很有用。
2. Shutil.copytree()：遞歸複製整個目錄樹。非常適合複製複雜的目錄結構（包括所有檔案和子目錄），以建立或備份測試或部署環境。
3. Shutil.rmtree()：遞迴刪除目錄樹。對於測試後清理或完全刪除臨時目錄及其內容至關重要。
4. Shutil.move()：將檔案或目錄移到另一個位置。有效地重新定位檔案系統中的檔案或目錄，促進組織或部署流程。
5. Shutil.make_archive()：建立目錄及其內容的檔案（例如 AIP 或 TAR）。對於出於分發或備份目的打包目錄很有用。

更多實用函數和詳細說明可以參考官方文件。

Python 中的Shutil 模組不僅是軟體測試中的多功能工具集，而且還適用於軟體開發的各個領域，例如版本控制和部署、資料科學和機器學習、IT 和系統管理、研究和學術界等。更多。

將shutil整合到我們的測試流程中，我們可以用最少的程式碼執行複雜的文件操作，節省我們的時間和精力，讓我們專注於開發高品質的軟體。

以上是用於自動化測試的 Python Shutil 模組的詳細內容。更多資訊請關注PHP中文網其他相關文章！