subprocess trong Python: chạy lệnh ngoài chương trình
Bài 23/25 · Chương 19
Thư viện chuẩn thường dùng
- 8 phút
- Trung cấp
- Python 3.14
- Cập nhật
Trong bài này · 12
Module subprocess trong Python chạy một lệnh ngoài chương trình, như một công cụ dòng lệnh hay một script Python khác, rồi đưa lại cho bạn mã thoát và những gì lệnh đó in ra. Bạn dùng subprocess khi script báo cáo cần gọi một công cụ có sẵn trên máy, chẳng hạn chạy dem_tu.py cho từng file rồi gom kết quả, thay cho việc gõ lệnh đó bằng tay trong terminal.
Cần biết trước: module sys, list và try/except.
Chạy một lệnh bằng subprocess.run()
Một lệnh gõ trong terminal gồm tên chương trình và các đối số. Lệnh dưới đây bảo Python tính 6 * 7 (trên Windows gõ python thay cho python3):
python3 -c "print(6 * 7)"KẾT QUẢ
42subprocess.run() chạy đúng lệnh đó từ trong chương trình: bạn đưa một list, phần tử đầu là chương trình, mỗi đối số một phần tử. Ví dụ gọi chính Python làm lệnh ngoài, vì lệnh đó có trên mọi máy đã cài Python. sys.executable là đường dẫn tới trình thông dịch đang chạy, nên bạn không phải đoán python hay python3.
Trình duyệt không chạy được tiến trình con, nên các khối code của bài không có nút Chạy. Kết quả là của một lần chạy bằng Python 3.14 trên Linux:
import subprocess
import sys
ket_qua = subprocess.run([sys.executable, "-c", "print(6 * 7)"])
print("Mã thoát:", ket_qua.returncode)
print(type(ket_qua).__name__)KẾT QUẢ
42
Mã thoát: 0
CompletedProcessChạy trên máy của bạn · Đoạn này cần Python cài trên máy, trang không chạy được.
Dòng 42 do lệnh con in thẳng ra màn hình. run() chờ lệnh chạy xong rồi trả về một CompletedProcess. Thuộc tính returncode là mã thoát: 0 nghĩa là xong việc, số khác 0 là lệnh báo lỗi, như mã mà sys.exit() đặt. Chép đoạn code về máy. Đổi print(6 * 7) thành print(6 * 8) rồi chạy lại: dòng đầu in 48.
Lấy kết quả in ra: capture_output= và text=
Script báo cáo cần đọc con số mà lệnh con in, không chỉ để nó hiện lên màn hình. capture_output=True giữ lại những gì lệnh in vào hai thuộc tính stdout và stderr. Mặc định đó là bytes, thêm text=True thì Python giải mã chúng thành chuỗi:
import subprocess
import sys
lenh = [sys.executable, "-c", "print('DH1024', 3)"]
kq = subprocess.run(lenh, capture_output=True)
print(kq.stdout)
kq = subprocess.run(lenh, capture_output=True, text=True)
print(repr(kq.stdout), repr(kq.stderr))
so_luong = int(kq.stdout.split()[1])
print(so_luong + 1)KẾT QUẢ
b'DH1024 3\n'
'DH1024 3\n' ''
4Chạy trên máy của bạn · Đoạn này cần Python cài trên máy, trang không chạy được.
Lệnh con không in gì ra màn hình nữa: các dòng nằm trong kq.stdout, kể cả dấu xuống dòng cuối. stderr rỗng vì lệnh không báo lỗi. Có chuỗi rồi, bạn tách và ép kiểu như với một chuỗi bình thường. Trên Windows, chuỗi bytes của dòng đầu có thêm \r trước \n, còn text=True đổi cặp đó về \n.
Dừng khi lệnh lỗi: check= và CalledProcessError
Một lệnh báo lỗi không làm chương trình của bạn dừng: run() vẫn trả về bình thường, chỉ returncode khác 0. Thêm check=True thì run() báo lỗi CalledProcessError khi mã thoát khác 0. Ở ví dụ dưới, lệnh con thoát bằng sys.exit() kèm một câu, câu đó đi ra stderr và mã thoát là 1:
import subprocess
import sys
loi = "import sys; sys.exit('bao_cao.txt: not found')"
kq = subprocess.run([sys.executable, "-c", loi],
capture_output=True, text=True)
print(kq.returncode, kq.stderr.strip())
try:
subprocess.run([sys.executable, "-c", loi],
capture_output=True, text=True, check=True)
except subprocess.CalledProcessError as e:
print("Lệnh lỗi, mã", e.returncode)
print(e.stderr.strip())KẾT QUẢ
1 bao_cao.txt: not found
Lệnh lỗi, mã 1
bao_cao.txt: not foundChạy trên máy của bạn · Đoạn này cần Python cài trên máy, trang không chạy được.
Đối tượng lỗi giữ lại returncode, stdout và stderr của lệnh, nên nhánh except vẫn đọc được câu báo lỗi. Bọc try quanh đúng lời gọi run(). Khi chương trình không có trên máy, run() báo FileNotFoundError trước khi có mã thoát nào, kể cả khi có check=True.
Không dùng shell=True với dữ liệu người dùng
run() còn nhận cả lệnh dưới dạng một chuỗi kèm shell=True: chuỗi đó được giao cho shell của hệ điều hành (sh trên Linux và macOS, cmd trên Windows) đọc như khi gõ trong terminal. Shell hiểu các dấu đặc biệt như &&, ;, |, nên một tên file do người dùng gõ có thể mang theo cả một lệnh khác.
Với list, không shell nào đọc tên file: chương trình con nhận nguyên chuỗi đó làm một đối số. Lệnh con dưới đây in list đối số mà nó nhận:
import subprocess
import sys
ten_file = "bao_cao.txt && echo DA CHAY THEM LENH"
in_doi_so = "import sys; print(sys.argv[1:])"
subprocess.run([sys.executable, "-c", in_doi_so, ten_file])KẾT QUẢ
['bao_cao.txt && echo DA CHAY THEM LENH']Chạy trên máy của bạn · Đoạn này cần Python cài trên máy, trang không chạy được.
Cả chuỗi lạ chỉ là một tên file không có thật, nên dem_tu.py sẽ báo không tìm thấy file và dừng. Dạng list giống điền từng ô của một tờ đơn: viết gì vào ô "tên file" thì nó vẫn chỉ là tên file. shell=True chỉ an toàn khi cả chuỗi do chính bạn viết sẵn trong code.
Kiểm tra nhanh
Với
lenhcủa ví dụ mãDH1024,kq = subprocess.run(lenh, capture_output=True)không cótext=True.kq.stdoutmang giá trị nào?'DH1024 3\n'b'DH1024 3\n'None
Những câu nào đúng khi lệnh con thoát với mã
1?- Không có
check=True,run()trả về bình thường vàreturncodebằng1 - Có
check=True,run()báoCalledProcessError - Có
check=True, chương trình của bạn vẫn chạy tiếp như không có gì - Đối tượng
CalledProcessErrorcóreturncodebằng1
- Không có
ten_filelà chữ người dùng gõ vào. Lời gọi nào chạydem_tu.pyan toàn?subprocess.run("python3 dem_tu.py " + ten_file, shell=True)subprocess.run(f"python3 dem_tu.py {ten_file}", shell=True)subprocess.run([sys.executable, "dem_tu.py", ten_file])
Trong khung bẫy không kiểm
returncode, khối in ra gì?Báo cáo xong:rồi không còn gìBáo cáo xong: bao_cao.txt: not found- Python dừng với
CalledProcessError
Bài tập
Tóm tắt kết quả của một lệnh
Công cụ báo cáo gọi subprocess.run(lenh, capture_output=True, text=True) rồi đưa kết quả cho tom_tat(ket_qua). Như một CompletedProcess, ket_qua có returncode (số nguyên), stdout và stderr (chuỗi). Viết thân hàm:
returncodebằng0: trả về dòng cuối có chữ củastdout, đã cắt khoảng trắng hai đầu.returncodekhác0, kể cả số âm: trả về"Lỗi ", mã thoát,": ", rồi dòng cuối có chữ củastderr, đã cắt khoảng trắng.
Không có dòng nào có chữ thì phần dòng là chuỗi rỗng.
Ví dụ: returncode bằng 2 và stderr là "usage: ...\nerror: sai\n" thì hàm trả về "Lỗi 2: error: sai".
Trả về: câu tóm tắt, một str.
def tom_tat(ket_qua):
pass # Viết thân hàm thay cho dòng nàyTóm tắt
subprocess.run([chương_trình, đối_số, ...])chạy lệnh, chờ nó xong và trả vềCompletedProcess.returncodelà mã thoát:0là xong việc, khác0là lệnh lỗi. Lỗi của lệnh không tự làm chương trình dừng.capture_output=Truegiữ lạistdout,stderrdạng bytes, thêmtext=Trueđể có chuỗi.check=TruebáoCalledProcessErrorkhi mã thoát khác0. Đối tượng lỗi giữreturncode,stderr.Có dữ liệu người dùng thì truyền lệnh dạng list, không
shell=True, để shell không đọc dấu&&,;trong đó.
Câu hỏi thường gặp
Nên chạy lệnh trong Python bằng hàm nào?
Dùng subprocess.run(). os.system("lệnh") luôn chạy qua shell và chỉ trả về một số trạng thái, không lấy được những gì lệnh in ra, nên có cả cái bẫy chèn lệnh lẫn ít thông tin hơn. Bảng tra thư viện chuẩn về hệ điều hành liệt kê cả hai.
Vì sao subprocess.run(["dir"]) báo lỗi trên Windows?
dir là lệnh có sẵn bên trong cmd. Trên máy không có file chương trình nào tên dir để chạy, nên Python báo FileNotFoundError. Lệnh ls của macOS/Linux là chương trình thật nên chạy được. Muốn liệt kê file thì dùng os.listdir() của bài module os, chạy giống nhau ở mọi hệ.
Chạy lệnh trong Python có giới hạn thời gian được không?
Được: subprocess.run(lenh, timeout=10) chờ tối đa 10 giây. Hết giờ mà lệnh chưa xong, Python dừng lệnh đó và báo subprocess.TimeoutExpired, lỗi bạn bắt bằng try/except như CalledProcessError. Nên đặt timeout khi lệnh con có thể treo, như một lệnh chờ mạng.
Lệnh con in tiếng Việt thì đọc thế nào cho khỏi lỗi?
Thay text=True bằng encoding="utf-8" để Python giải mã đầu ra theo UTF-8, như bài bytes và UTF-8 giải thích. Lệnh con cũng phải in bằng UTF-8: trên Windows, một script Python con cần cờ -X utf8 ([sys.executable, "-X", "utf8", "dem_tu.py"]), nếu không nó in theo bảng mã của máy.
Chủ đề
Bài này có hữu ích?
Hỏi đáp
Tham vấn chuyên môn
Nhà sáng lập AIDev và VietPlatform · Thạc sĩ AI MSE
- Tốt nghiệp thủ khoa xuất sắc Thạc sĩ AI MSE.
- Đồng sáng lập, CTO E-University, SVOnline: số hóa 10+ đại học, 40.000+ sinh viên.
- Xây hệ thống AI cho doanh nghiệp tại VietPlatform.