Viết CLI trong Python với Argparse

Trong lập trình, giao diện dòng lệnh (CLI) là một công cụ mạnh mẽ cho phép người dùng tương tác trực tiếp với các chương trình thông qua terminal hoặc command prompt. Python cung cấp một thư viện mạnh mẽ có tên là argparse, giúp dễ dàng xây dựng các CLI với các tùy chọn và đối số phức tạp. Trong bài viết này, chúng ta sẽ khám phá cách sử dụng argparse để tạo một CLI đơn giản trong Python.

Giới Thiệu về Argparse

argparse là một module trong thư viện chuẩn của Python, được thiết kế để xử lý các đối số dòng lệnh. Nó cung cấp các công cụ để xác định những gì chương trình yêu cầu và cũng tự động tạo ra các thông điệp trợ giúp và thông báo lỗi khi cần thiết.

Các Tính Năng Chính của Argparse

• Xử lý đối số: Hỗ trợ các đối số vị trí và tùy chọn.
• Tự động tạo help: Tự động tạo các thông điệp trợ giúp, chỉ ra cách sử dụng các đối số trong chương trình.
• Kiểm soát lỗi: Tự động kiểm tra loại và giới hạn của đối số, phát ra thông báo lỗi khi đầu vào không hợp lệ.

Bắt Đầu với Argparse

Để sử dụng argparse, bạn cần nhập module và tạo một đối tượng ArgumentParser. Sau đó, bạn sẽ thêm các đối số mà CLI của bạn yêu cầu.

Khởi Tạo ArgumentParser

import argparse

parser = argparse.ArgumentParser(description='Example CLI application with argparse.')

Trong đoạn mã trên, chúng ta đã khởi tạo một ArgumentParser với một mô tả ngắn gọn về ứng dụng.

Thêm Đối Số

argparse cho phép bạn thêm các đối số vị trí (bắt buộc) và các đối số tùy chọn.

Đối Số Vị Trí

parser.add_argument('echo', help='Echo the string you use here')

Đối số echo là một đối số vị trí, người dùng cần cung cấp một giá trị cho nó khi chạy chương trình.

Đối Số Tùy Chọn

parser.add_argument('--verbosity', help='increase output verbosity', action='store_true')

Đối số --verbosity là một đối số tùy chọn. Nếu nó được sử dụng, giá trị của nó sẽ là True.

Phân Tích Đối Số

Sau khi đã định nghĩa xong các đối số, bạn cần phân tích các đối số này từ sys.argv bằng phương thức parse_args().

args = parser.parse_args()

Sử Dụng Giá Trị Đối Số

Sau khi các đối số được phân tích, bạn có thể sử dụng chúng trong chương trình của mình.

if args.verbosity:
    print(f"verbosity turned on")
if args.echo:
    print(f"Echo: {args.echo}")

Ví Dụ Đầy Đủ

Kết hợp tất cả lại, dưới đây là một ví dụ đơn giản về cách sử dụng argparse để xây dựng một CLI:

import argparse

def main():
    parser = argparse.ArgumentParser(description="Sample CLI using argparse.")
    parser.add_argument('echo', help="Echo the string you use here")
    parser.add_argument('--verbosity', help="increase output verbosity", action='store_true')
    args = parser.parse_args()

    if args.verbosity:
        print("verbosity turned on")
    if args.echo:
        print(f"Echo: {args.echo}")

if __name__ == '__main__':
    main()

Trong ví dụ này, chương trình nhận một đối số vị trí echo và một đối số tùy chọn --verbosity. Khi chạy chương trình, bạn có thể cung cấp các giá trị cho các đối số này để thấy cách chúng được xử lý.

Kết Luận

argparse là một công cụ mạnh mẽ và linh hoạt trong Python, cho phép bạn dễ dàng xây dựng các CLI phức tạp với ít công sức. Với khả năng tự động tạo help và kiểm soát lỗi, nó giúp các ứng dụng của bạn trở nên thân thiện và dễ sử dụng hơn. Bằng cách sử dụng argparse, bạn có thể tạo ra các giao diện dòng lệnh chuyên nghiệp, giúp người dùng tương tác với các chương trình Python của bạn một cách hiệu quả.