Python 程式設計的世界

徹底解析Python的subprocess模組｜從基礎到應用

Python 實踐指南
佐川 直弘
By 佐川 直弘 (運営者)
※記事内に広告を含みます。Amazonアソシエイトとして適格販売により収入を得ています。
目次

1. 什麼是 Python 的 subprocess 模組

概要

Python 的subprocess模組是一個強大的工具，用於從 Python 執行系統命令和外部程式。透過這個模組，可以管理標準輸入輸出和處理程序，讓 Python 程式與外部程式的整合變得更加容易。相比傳統的os.system()和commands模組，subprocess提供了更安全、更靈活的處理程序控制。

主要用途

  • 執行 Shell 命令: 執行簡單的系統命令。
  • 管理處理程序: 執行外部程式並重定向標準輸入輸出。
  • 非同步處理: 管理長時間執行或需要並行處理的任務。

2. 基本用法：subprocess.run()

基本使用方法

subprocess.run()是一個簡單的函數，用於從 Python 內部執行系統命令。例如，要列出目錄中的檔案，可以使用以下程式碼：

import subprocess

result = subprocess.run(['ls', '-l'], capture_output=True, text=True)
print(result.stdout)

這段程式碼執行了ls -l命令，並將輸出儲存在stdout中進行處理。透過capture_output=True，可捕獲標準輸出；text=True則將結果作為字串處理。

錯誤處理

使用subprocess.run()時，如果命令失敗，可以透過stderr獲取錯誤訊息，並檢查returncode確認執行結果。

result = subprocess.run(['ls', 'nonexistentfile'], capture_output=True, text=True)
if result.returncode != 0:
    print(f"錯誤: {result.stderr}")

這個範例中，如果指定的檔案不存在，將顯示錯誤訊息。

3. 非同步執行：subprocess.Popen()

使用Popen進行非同步處理

subprocess.run()是同步處理，在命令執行結束之前，Python 程式無法繼續執行後續操作。而使用subprocess.Popen()可以非同步執行程序，同時處理其他任務。

import subprocess

proc = subprocess.Popen(['sleep', '5'], stdout=subprocess.PIPE)
print("處理程序已啟動")
proc.wait()
print("處理程序已結束")

這段程式碼非同步執行了sleep 5命令，並允許同時處理其他操作。

控制標準輸入與輸出

Popen允許更靈活地控制標準輸入和輸出。例如，下列程式碼從檔案中讀取資料，透過cat命令處理後寫入另一個檔案。

with open('input.txt', 'r') as infile, open('output.txt', 'w') as outfile:
    proc = subprocess.Popen(['cat'], stdin=infile, stdout=outfile)
    proc.wait()

這使得標準輸入和輸出可以透過檔案重定向進行處理。

侍エンジニア塾

4. 使用範例：自動化腳本

檔案備份

subprocess非常適合用於系統管理和定期任務的自動化。例如，以下程式碼會自動將檔案複製到備份目錄。

import subprocess

files_to_backup = ['file1.txt', 'file2.txt', 'file3.txt']
backup_dir = '/backup/directory/'

for file in files_to_backup:
    subprocess.run(['cp', file, backup_dir])

這段程式碼會將指定的檔案複製到備份資料夾中，適合用於自動化備份任務。

侍エンジニア塾

5. 安全性與最佳實踐

shell=True的風險

選用shell=True選項時，會透過 Shell 執行命令，但這樣做會帶來安全風險。特別是當接收外部輸入並直接傳遞時，可能會導致 Shell 注入攻擊。建議使用shell=False來降低此風險。

import subprocess

# 推薦做法（安全）
subprocess.run(['ls', '-l'])

# shell=True（需注意安全）
subprocess.run('ls -l', shell=True)

跨平台兼容性

系統命令在不同作業系統中可能有所不同。以下範例使用 Python 的platform模組，根據作業系統切換執行的命令。

import platform
import subprocess

if platform.system() == "Windows":
    subprocess.run(['dir'], shell=True)
else:
    subprocess.run(['ls', '-l'])

6. 疑難排解與除錯

常見錯誤與對策

使用subprocess時，經常會遇到找不到檔案或沒有存取權限的錯誤。透過stderr捕獲錯誤訊息並檢查returncode，可以取得詳細的錯誤資訊。

除錯提示

使用check=True選項，可以在命令執行失敗時拋出例外，以便及早發現問題。此外，可以將標準輸出和錯誤訊息記錄下來，幫助除錯。

import subprocess

try:
    result = subprocess.run(['ls', '-l'], check=True, capture_output=True, text=True)
    print(result.stdout)
except subprocess.CalledProcessError as e:
    print(f"發生錯誤: {e}")

7. 非同步處理與 asyncio 的整合

使用 asyncio 進行非同步處理

透過asyncio與subprocess的整合，可以同時並行處理多個程序。以下範例展示了如何使用asyncio非同步執行ls命令並捕獲輸出結果。

import asyncio
import subprocess

async def run_command():
    proc = await asyncio.create_subprocess_exec('ls', '-l',
        stdout=asyncio.subprocess.PIPE,
        stderr=asyncio.subprocess.PIPE)

    stdout, stderr = await proc.communicate()

    if stdout:
        print(f'[stdout]n{stdout.decode()}')
    if stderr:
        print(f'[stderr]n{stderr.decode()}')

asyncio.run(run_command())

這段程式碼會非同步執行命令，並處理標準輸出和錯誤訊息。透過asyncio，可以更有效地管理非同步任務。

年収訴求

8. 總結

Python 的subprocess模組是一個功能強大且靈活的工具，適用於執行外部命令、自動化任務和非同步處理。透過學習基本操作、錯誤處理和安全性最佳實踐，您可以有效地將subprocess應用於各種場景。

此外，與asyncio的結合提供了更高效的非同步解決方案，特別適合需要同時執行多個任務的情況。

現在就開始將subprocess模組整合到您的 Python 專案中，提升工作流程的效率吧！

広告