Bỏ qua đến nội dung chính
Mục lục

argparse và sys.argv: tham số dòng lệnh trong Python

AIDev Team · duyệt: Nguyễn Việt Chung

Bài 21/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

Thư viện argparse của Python đọc tham số dòng lệnh (command line arguments), tức các chữ bạn gõ sau tên file khi chạy python dem_tu.py bao_cao.txt --toi-thieu 4. Bạn dùng argparse khi một script nhỏ cần nhận tên file và vài tùy chọn từ người chạy, thay cho việc sửa biến trong code mỗi lần đổi file.

Cần biết trước: module sys và sys.argv, ép kiểu và pathlib.

Tham số dòng lệnh thô trong sys.argv

Các chữ gõ sau lệnh python nằm trong list sys.argv: phần tử đầu là tên file, các phần tử sau là từng đối số, tách theo dấu cách. Lưu đoạn code dưới đây thành xem_argv.py:

python
import sys

print(sys.argv)
print(sys.argv[3], type(sys.argv[3]).__name__)

Trình chạy trên trang không có dòng lệnh: ở đó sys.argv luôn là ['']. Vì vậy phần này chạy bằng terminal trên máy của bạn (trên Windows gõ python thay cho python3):

bash
python3 xem_argv.py bao_cao.txt --toi-thieu 4

KẾT QUẢ

['xem_argv.py', 'bao_cao.txt', '--toi-thieu', '4']
4 str

Số 4 đến dưới dạng chuỗi '4'. Với sys.argv thô, bạn tự lo hết: tùy chọn đứng ở chỗ nào, ép '4' sang số, báo lỗi khi người chạy quên tên file. Module argparse làm các việc đó thay bạn.

Đối số vị trí và tùy chọn với ArgumentParser

Một công cụ dòng lệnh dùng argparse có ba bước: tạo ArgumentParser, khai từng đối số bằng add_argument(), rồi đọc bằng parse_args(). Tên không mở bằng dấu gạch là đối số vị trí, bắt buộc phải có. Tên mở bằng -- là tùy chọn, được bỏ qua:

python
import argparse

parser = argparse.ArgumentParser(prog="dem_tu.py")
parser.add_argument("ten_file")
parser.add_argument("--toi-thieu", type=int, default=1)
args = parser.parse_args(["bao_cao.txt", "--toi-thieu", "4"])
print(args)
print(args.ten_file, args.toi_thieu + 1)

KẾT QUẢ

Namespace(ten_file='bao_cao.txt', toi_thieu=4)
bao_cao.txt 5

parse_args() trả về một đối tượng Namespace, mỗi đối số là một thuộc tính đọc bằng dấu chấm. Dấu gạch trong --toi-thieu thành dấu gạch dưới: args.toi_thieu. Trên máy, bạn gọi parse_args() không đối số và argparse tự đọc sys.argv[1:]. Trên trang, sys.argv[1:] rỗng, nên ví dụ truyền thẳng một list đóng vai các chữ gõ ở terminal. Đổi "4"] thành "7"] rồi chạy lại: dòng thứ hai in bao_cao.txt 8.

Đổi kiểu, giá trị mặc định và giới hạn lựa chọn

Ba tham số của add_argument() lo phần kiểm tra mà bạn phải tự viết với sys.argv. type=int ép chuỗi sang số nguyên như int(). default= là giá trị khi người chạy không gõ tùy chọn. choices= liệt kê các giá trị được nhận:

python
import argparse

parser = argparse.ArgumentParser(prog="dem_tu.py")
parser.add_argument("ten_file")
parser.add_argument("--toi-thieu", type=int, default=1)
parser.add_argument("--dem", choices=["tu", "dong"], default="tu")
print(parser.parse_args(["bao_cao.txt"]))
print(parser.parse_args(["--dem", "dong", "bao_cao.txt"]))

KẾT QUẢ

Namespace(ten_file='bao_cao.txt', toi_thieu=1, dem='tu')
Namespace(ten_file='bao_cao.txt', toi_thieu=1, dem='dong')

Dòng thứ hai cho thấy tùy chọn được đứng trước đối số vị trí: argparse nhận ra từng phần theo tên, không theo chỗ đứng. Khi giá trị không có trong choices, hay type=int không ép được, argparse in cách dùng đúng cùng một câu báo lỗi ra stderr rồi thoát với mã 2. Trên trang, giá trị sai cho ra dòng usage (có kèm mã màu), dòng error rồi một traceback dài kết thúc bằng SystemExit: 2, còn trên máy argparse chỉ in hai dòng đầu. Chạy công cụ ở cuối bài trên máy với một giá trị sai:

bash
python3 dem_tu.py bao_cao.txt --dem chu

KẾT QUẢ

usage: dem_tu.py [-h] [--toi-thieu TOI_THIEU] [--dem {tu,dong}] ten_file
dem_tu.py: error: argument --dem: invalid choice: 'chu' (choose from tu, dong)

Tùy bản Python, hai lựa chọn có thể nằm trong nháy đơn: 'tu', 'dong'. Thiếu ten_file thì dòng lỗi là the following arguments are required: ten_file.

Trang trợ giúp --help tự sinh

Mỗi parser có sẵn tùy chọn -h và --help, bạn không phải khai. Tham số description= của ArgumentParser và help= của từng add_argument() là chữ hiện trên trang đó. Với công cụ dem_tu.py ở mục cuối bài, lệnh trên máy cho ra:

bash
python3 dem_tu.py --help

KẾT QUẢ

usage: dem_tu.py [-h] [--toi-thieu TOI_THIEU] [--dem {tu,dong}] ten_file

Đếm từ trong file văn bản.

positional arguments:
  ten_file              file cần đếm

options:
  -h, --help            show this help message and exit
  --toi-thieu TOI_THIEU
                        chỉ đếm từ có từ chừng này ký tự
  --dem {tu,dong}       đếm từ hay đếm dòng

Trang trợ giúp giống tờ hướng dẫn dán trên hộp dụng cụ: người dùng đọc nó thay cho đọc code. Dòng usage đặt tùy chọn trong ngoặc vuông vì chúng được bỏ qua, còn ten_file đứng trần vì bắt buộc. Python 3.14 tô màu trang này khi in ra terminal. Trình chạy trên trang cũng tô màu nên chữ có thêm mã màu, vì vậy bài in trang trợ giúp ở terminal.

Ghép thành công cụ đếm từ

Đặt việc đọc tham số trong một hàm nhận cac_doi_so=None. Gọi không đối số thì parse_args(None) đọc sys.argv như khi chạy ở terminal. Truyền một list thì hàm chạy được cả trên trang, cả trong bài kiểm thử:

python
import argparse
from pathlib import Path
def dem_tu(cac_doi_so=None):
    parser = argparse.ArgumentParser(prog="dem_tu.py")
    parser.add_argument("ten_file")
    parser.add_argument("--toi-thieu", type=int, default=1)
    args = parser.parse_args(cac_doi_so)
    cac_tu = Path(args.ten_file).read_text(encoding="utf-8").split()
    so_tu = 0
    for tu in cac_tu:
        if len(tu) >= args.toi_thieu:
            so_tu += 1
    return so_tu
Path("bc.txt").write_text("Doanh thu tháng 9 tăng", "utf-8")
print(dem_tu(["bc.txt"]), dem_tu(["bc.txt", "--toi-thieu", "4"]))

KẾT QUẢ

5 3

Câu báo cáo có năm từ, ba từ dài từ bốn ký tự: Doanh, tháng, tăng. Bản đầy đủ dưới đây thêm --dem, chữ trợ giúp, và dòng if __name__ == "__main__": để chỉ gọi main() khi chạy file trực tiếp, như bài tự viết module giải thích. Lưu thành dem_tu.py cạnh một file bao_cao.txt hai dòng:

python
import argparse
from pathlib import Path


def main(cac_doi_so=None):
    parser = argparse.ArgumentParser(
        prog="dem_tu.py", description="Đếm từ trong file văn bản.")
    parser.add_argument("ten_file", help="file cần đếm")
    parser.add_argument("--toi-thieu", type=int, default=1,
                        help="chỉ đếm từ có từ chừng này ký tự")
    parser.add_argument("--dem", choices=["tu", "dong"],
                        default="tu", help="đếm từ hay đếm dòng")
    args = parser.parse_args(cac_doi_so)
    noi_dung = Path(args.ten_file).read_text(encoding="utf-8")
    if args.dem == "dong":
        so_dong = len(noi_dung.splitlines())
        print("Số dòng:", so_dong)
        return
    so_tu = 0
    for tu in noi_dung.split():
        if len(tu) >= args.toi_thieu:
            so_tu += 1
    print("Số từ:", so_tu)


if __name__ == "__main__":
    main()

Ba lần chạy với file bao_cao.txt có hai dòng Doanh thu tháng 9 tăng nhẹ và chi nhánh Huế dẫn đầu:

bash
python3 dem_tu.py bao_cao.txt
python3 dem_tu.py bao_cao.txt --toi-thieu 4
python3 dem_tu.py --dem dong bao_cao.txt

KẾT QUẢ

Số từ: 11
Số từ: 4
Số dòng: 2

Kiểm tra nhanh

  1. Sau import argparse, p = argparse.ArgumentParser() và p.add_argument("--toi-thieu", type=int, default=1), p.parse_args([]).toi_thieu trả về gì?

    • 1
    • None
    • "1"
  2. Những điều nào đúng với parser.add_argument("--kieu-dem", choices=["tu", "dong"], default="tu")?

    • Giá trị đọc được bằng args.kieu-dem
    • Gõ --kieu-dem chu thì argparse in lỗi và thoát với mã 2
    • Gõ --kieu-dem chu thì argparse lặng lẽ dùng "tu"
    • Trang --help hiện {tu,dong} cạnh --kieu-dem
  3. Sau import argparse, p = argparse.ArgumentParser(), p.add_argument("--toi-thieu") và a = p.parse_args(["--toi-thieu", "4"]), a.toi_thieu + 1 báo lỗi gì?

    • 5
    • Báo lỗi TypeError
    • "41"
  4. Vì sao ví dụ trên trang gọi parser.parse_args(["bao_cao.txt"]) với một list thay cho parse_args()?

    • parse_args() không đối số đọc ô Dữ liệu nhập (stdin), mà ô đó đang trống
    • List giúp argparse chạy nhanh hơn
    • Trên trang sys.argv là [''], nên parse_args() không có đối số nào để đọc
Đúng hết lần đầu +15 XP

Bài tập

Đọc tham số của công cụ đếm từ

Công cụ đếm từ gọi doc_lenh(cac_doi_so) để đọc các chữ người chạy gõ, ở dạng list chuỗi. Viết thân hàm bằng argparse: tạo ArgumentParser, khai bằng add_argument() rồi đọc bằng parse_args(cac_doi_so):

  • ten_file: đối số vị trí.

  • --toi-thieu: số nguyên, mặc định 1.

  • --dem: chỉ nhận "tu" hoặc "dong", mặc định "tu".

Giá trị sai thì để argparse tự dừng chương trình. Hàm không sửa list cac_doi_so.

Ví dụ: doc_lenh(["ghi_chu.txt", "--dem", "dong"]) trả về ("ghi_chu.txt", 1, "dong").

Trả về: bộ ba tên file, số ký tự tối thiểu, kiểu đếm, một tuple.

python
import argparse

def doc_lenh(cac_doi_so):
    pass  # Viết thân hàm thay cho dòng này

Tóm tắt

  • sys.argv cho mọi chữ gõ sau lệnh python ở dạng chuỗi, argparse đọc phần đó thay bạn.

  • ArgumentParser(), add_argument(), parse_args(): tên không gạch là đối số vị trí bắt buộc, tên --ten là tùy chọn.

  • type=int ép giá trị sang số, default= dùng khi tùy chọn vắng mặt, choices= chặn giá trị lạ.

  • Giá trị sai làm argparse in lỗi ra stderr và thoát với mã 2. --help tự có, chữ lấy từ description=, help=.

  • --toi-thieu đọc là args.toi_thieu. Trên trang truyền một list cho parse_args() vì sys.argv là [''].

Câu hỏi thường gặp

Có nên dùng sys.argv thay cho argparse không?

Với một script chỉ nhận đúng một tên file, sys.argv[1] là đủ, như bài module sys chỉ cách. Khi có tùy chọn, giá trị mặc định hay cần báo lỗi rõ ràng cho người chạy, argparse ngắn hơn và chắc hơn phần kiểm tra tự viết.

Tùy chọn bật tắt không có giá trị khai thế nào?

Dùng action="store_true": parser.add_argument("--chi-tiet", action="store_true"). Có --chi-tiet trên dòng lệnh thì args.chi_tiet là True, không có thì là False. Tùy chọn này không nhận giá trị đi kèm.

Tùy chọn dòng lệnh đặt được tên viết tắt như -t không?

Được. Khai cả hai tên trong một lời gọi: parser.add_argument("-t", "--toi-thieu", type=int, default=1). Người chạy gõ -t 4 hay --toi-thieu 4 đều được, và thuộc tính vẫn lấy theo tên dài, args.toi_thieu.

Đọc file theo tên từ dòng lệnh thì đường dẫn tính từ đâu?

Tên tương đối như bao_cao.txt tính từ thư mục mà terminal đang đứng khi chạy lệnh. Thư mục chứa script chỉ trùng với nó khi bạn chạy lệnh ngay trong đó. Muốn tìm file nằm cạnh script thì ghép với Path(__file__).parent, như bài pathlib giải thích.

Chủ đề

argparse

Bài này có hữu ích?

Hỏi đáp

Đang tải câu hỏi…

Tham vấn chuyên môn

Nguyễn Việt Chung

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.
Biên soạn: AIDev Team · Rà soát · Quy trình biên tập