Hướng dẫn python change yaml value - python thay đổi giá trị yaml

Tạo trình phân tích cú pháp

Bước đầu tiên trong việc sử dụng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Đối tượng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Thêm đối số

Việc điền vào

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Sau đó, gọi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Phân tích đối số

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Trong một tập lệnh,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

ăn xin¶

Theo mặc định, các đối tượng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Sự trợ giúp cho chương trình này sẽ hiển thị

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Để thay đổi hành vi mặc định này, một giá trị khác có thể được cung cấp bằng đối số

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Lưu ý rằng tên chương trình, cho dù được xác định từ

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

cách sử dụng¶

Theo mặc định,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Thông báo mặc định có thể được ghi đè với đối số từ khóa

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Bộ xác định định dạng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

sự mô tả¶

Hầu hết các cuộc gọi đến Trình xây dựng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Theo mặc định, mô tả sẽ được bọc dòng để nó phù hợp với không gian đã cho. Để thay đổi hành vi này, hãy xem đối số Formatter_Class.

Epilogn

Một số chương trình muốn hiển thị mô tả bổ sung của chương trình sau khi mô tả các đối số. Văn bản như vậy có thể được chỉ định bằng đối số

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Như với đối số mô tả, văn bản

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

cha mẹ¶

Đôi khi, một số trình phân tích cú pháp chia sẻ một bộ đối số chung. Thay vì lặp lại các định nghĩa của các đối số này, một trình phân tích cú pháp duy nhất với tất cả các đối số được chia sẻ và có thể sử dụng đối số

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Lưu ý rằng hầu hết các trình phân tích cú pháp cha sẽ chỉ định

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Ghi chú

Bạn phải khởi tạo hoàn toàn các trình phân tích cú pháp trước khi chuyển chúng qua

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

formatter_ class¶¶

Các đối tượng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Vượt qua

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

prefix_chars¶

Hầu hết các tùy chọn dòng lệnh sẽ sử dụng

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Đối số

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Fromfile_prefix_chars¶

Đôi khi, khi xử lý một danh sách đối số đặc biệt dài, có thể có ý nghĩa để giữ danh sách các đối số trong một tệp thay vì gõ nó vào dòng lệnh. Nếu đối số

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Các đối số được đọc từ một tệp theo mặc định là một dòng trên mỗi dòng (nhưng xem thêm

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Đối số

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

arging_default¶

Nói chung, các mặc định đối số được chỉ định bằng cách chuyển một mặc định cho

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

cho phép_abbrev¶

Thông thường, khi bạn chuyển một danh sách đối số cho phương thức

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Tính năng này có thể bị tắt bằng cách đặt

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

Mới trong phiên bản 3.5.

xung đột_handler¶

Các đối tượng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

Đôi khi (ví dụ: khi sử dụng cha mẹ), có thể hữu ích khi chỉ cần ghi đè bất kỳ đối số cũ nào với cùng một chuỗi tùy chọn. Để có được hành vi này, giá trị

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

Lưu ý rằng các đối tượng

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

add_help¶

Theo mặc định, các đối tượng ArgentParSer thêm một tùy chọn chỉ hiển thị thông báo trợ giúp của trình phân tích cú pháp. Ví dụ: hãy xem xét một tệp có tên

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Nếu

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

{state: deleted}

Đôi khi, nó có thể hữu ích để vô hiệu hóa việc bổ sung tùy chọn trợ giúp này. Điều này có thể đạt được bằng cách chuyển

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

Tùy chọn trợ giúp thường là

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

{state: deleted}

exit_on_error¶

Thông thường, khi bạn chuyển một danh sách đối số không hợp lệ cho phương thức

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Nếu người dùng muốn bắt lỗi theo cách thủ công, tính năng này có thể được bật bằng cách đặt

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

Mới trong phiên bản 3.9.

Tên hoặc Cờ

Phương pháp

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Ví dụ, một đối số tùy chọn có thể được tạo như:

{state: deleted}

Trong khi một đối số vị trí có thể được tạo như:

{state: deleted}

Khi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

hoạt động¶

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  26 - Điều này chỉ lưu trữ giá trị đối số. Đây là hành động mặc định. Ví dụ:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  1

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  27 - Điều này lưu trữ giá trị được chỉ định bởi đối số từ khóa Const; Lưu ý rằng đối số từ khóa Const mặc định là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37. Hành động

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  27 được sử dụng phổ biến nhất với các đối số tùy chọn chỉ định một số loại cờ. Ví dụ:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  2

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  28 và

  def set_state(state):
      file_name = "file_to_edit.yaml"
      with open(file_name) as f:
          doc = yaml.safe_load(f)
      doc['state'] = state
      with open(file_name, 'w') as f:
          yaml.safe_dump(doc, f, default_flow_style=False)
  

  85 - Đây là những trường hợp đặc biệt của

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  27 được sử dụng để lưu trữ các giá trị

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  43 và

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  44 tương ứng. Ngoài ra, chúng tạo ra các giá trị mặc định tương ứng là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  44 và

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  43. Ví dụ:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  3

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  29 - Điều này lưu trữ một danh sách và nối mỗi giá trị đối số vào danh sách. Nó rất hữu ích để cho phép một tùy chọn được chỉ định nhiều lần. Nếu giá trị mặc định là không trống, các phần tử mặc định sẽ có trong giá trị phân tích cú pháp cho tùy chọn, với bất kỳ giá trị nào từ dòng lệnh được thêm vào sau các giá trị mặc định đó. Ví dụ sử dụng:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  4

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  30 - Điều này lưu trữ một danh sách và nối các giá trị được chỉ định bởi đối số từ khóa Const vào danh sách; Lưu ý rằng đối số từ khóa Const mặc định là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37. Hành động

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  30 thường hữu ích khi nhiều đối số cần lưu trữ các hằng số vào cùng một danh sách. Ví dụ:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  5

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  31 - Điều này đếm số lần đối số từ khóa xảy ra. Ví dụ, điều này rất hữu ích cho việc tăng mức độ dài dòng:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  6

  Lưu ý, mặc định sẽ là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37 trừ khi được đặt rõ ràng thành 0.

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  32 - Điều này in một thông báo trợ giúp hoàn chỉnh cho tất cả các tùy chọn trong trình phân tích cú pháp hiện tại và sau đó thoát. Theo mặc định, một hành động trợ giúp được tự động thêm vào trình phân tích cú pháp. Xem

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  50 để biết chi tiết về cách tạo ra đầu ra.

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  33 - Điều này mong đợi một đối số từ khóa

  {state: deleted}
  

  00 trong cuộc gọi

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  53 và in thông tin phiên bản và thoát khi được gọi:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  7

• {state: deleted}
  

  02 - Điều này lưu trữ một danh sách và mở rộng từng giá trị đối số cho danh sách. Ví dụ sử dụng:

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  8

  Mới trong phiên bản 3.8.

Bạn cũng có thể chỉ định một hành động tùy ý bằng cách chuyển một lớp con hành động hoặc đối tượng khác thực hiện cùng một giao diện.

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

{state: deleted}

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

Mới trong phiên bản 3.9.

Cách được đề xuất để tạo hành động tùy chỉnh là mở rộng

{state: deleted}

{state: deleted}

{state: deleted}

{state: deleted}

Một ví dụ về một hành động tùy chỉnh:

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Để biết thêm chi tiết, xem

{state: deleted}

nargs¶

Các đối tượng của ArgumpParser thường liên kết một đối số dòng lệnh duy nhất với một hành động duy nhất được thực hiện. Đối số từ khóa

{state: deleted}

• {state: deleted}
  

  13 (một số nguyên).

  {state: deleted}
  

  13 Đối số từ dòng lệnh sẽ được tập hợp lại với nhau thành một danh sách. Ví dụ:

  parser.add_argument('filename')           # positional argument
  parser.add_argument('-c', '--count')      # option that takes a value
  parser.add_argument('-v', '--verbose',
                      action='store_true')  # on/off flag
  

  1

  Lưu ý rằng

  {state: deleted}
  

  15 tạo ra một danh sách một mục. Điều này khác với mặc định, trong đó mặt hàng được sản xuất bởi chính nó.

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  39. Một đối số sẽ được tiêu thụ từ dòng lệnh nếu có thể và được tạo ra như một mục duy nhất. Nếu không có đối số dòng lệnh nào có mặt, giá trị từ mặc định sẽ được tạo ra. Lưu ý rằng đối với các đối số tùy chọn, có một trường hợp bổ sung - chuỗi tùy chọn có mặt nhưng không được theo sau bởi một đối số dòng lệnh. Trong trường hợp này, giá trị từ const sẽ được sản xuất. Một số ví dụ để minh họa điều này:

  parser.add_argument('filename')           # positional argument
  parser.add_argument('-c', '--count')      # option that takes a value
  parser.add_argument('-v', '--verbose',
                      action='store_true')  # on/off flag
  

  2

  Một trong những cách sử dụng phổ biến hơn của

  {state: deleted}
  

  17 là cho phép các tệp đầu vào và đầu ra tùy chọn:

  parser.add_argument('filename')           # positional argument
  parser.add_argument('-c', '--count')      # option that takes a value
  parser.add_argument('-v', '--verbose',
                      action='store_true')  # on/off flag
  

  3

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  40. Tất cả các đối số dòng lệnh có mặt được thu thập vào một danh sách. Lưu ý rằng thường không có ý nghĩa gì khi có nhiều hơn một đối số vị trí với

  {state: deleted}
  

  19, nhưng có thể có nhiều đối số tùy chọn với

  {state: deleted}
  

  19. Ví dụ:

  parser.add_argument('filename')           # positional argument
  parser.add_argument('-c', '--count')      # option that takes a value
  parser.add_argument('-v', '--verbose',
                      action='store_true')  # on/off flag
  

  4

• with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  41. Giống như

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  40, tất cả các arg dòng lệnh hiện tại được thu thập vào một danh sách. Ngoài ra, một thông báo lỗi sẽ được tạo nếu có ít nhất một đối số dòng lệnh. Ví dụ:

  parser.add_argument('filename')           # positional argument
  parser.add_argument('-c', '--count')      # option that takes a value
  parser.add_argument('-v', '--verbose',
                      action='store_true')  # on/off flag
  

  5

Nếu đối số từ khóa

{state: deleted}

hăng sô¶

Đối số

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

• Khi

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  53 được gọi với

  {state: deleted}
  

  28 hoặc

  {state: deleted}
  

  29. Các hành động này thêm giá trị

  {state: deleted}
  

  24 vào một trong các thuộc tính của đối tượng được trả về bởi

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  55. Xem mô tả hành động cho các ví dụ. Nếu

  {state: deleted}
  

  24 không được cung cấp cho

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  53, nó sẽ nhận được giá trị mặc định là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37.

• Khi

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  53 được gọi với các chuỗi tùy chọn (như

  def set_state(state):
      file_name = "file_to_edit.yaml"
      with open(file_name) as f:
          doc = yaml.safe_load(f)
      doc['state'] = state
      with open(file_name, 'w') as f:
          yaml.safe_dump(doc, f, default_flow_style=False)
  

  50 hoặc

  def set_state(state):
      file_name = "file_to_edit.yaml"
      with open(file_name) as f:
          doc = yaml.safe_load(f)
      doc['state'] = state
      with open(file_name, 'w') as f:
          yaml.safe_dump(doc, f, default_flow_style=False)
  

  51) và

  {state: deleted}
  

  17. Điều này tạo ra một đối số tùy chọn có thể được theo sau bởi 0 hoặc một đối số dòng lệnh. Khi phân tích các dòng lệnh, nếu chuỗi tùy chọn gặp phải không có đối số dòng lệnh theo nó, giá trị của

  {state: deleted}
  

  24 sẽ được coi là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37 thay thế. Xem mô tả NARGS cho các ví dụ.

Đã thay đổi trong phiên bản 3.11:

{state: deleted}

{state: deleted}

{state: deleted}

{state: deleted}

{state: deleted}

{state: deleted}

mặc định¶

Tất cả các đối số tùy chọn và một số đối số vị trí có thể được bỏ qua tại dòng lệnh. Đối số từ khóa

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Nếu không gian tên đích đã có một bộ thuộc tính, mặc định hành động sẽ không ghi được quá nhiều:

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Nếu giá trị

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Đối với các đối số vị trí với NARG bằng

{state: deleted}

{state: deleted}

{state: deleted}

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Cung cấp

{state: deleted}

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

loại hình¶

Theo mặc định, trình phân tích cú pháp đọc các đối số dòng lệnh trong các chuỗi đơn giản. Tuy nhiên, khá thường xuyên, chuỗi dòng lệnh thay vào đó nên được hiểu là một loại khác, chẳng hạn như

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Nếu từ khóa loại được sử dụng với từ khóa mặc định, bộ chuyển đổi loại chỉ được áp dụng nếu mặc định là một chuỗi.

Đối số của

{state: deleted}

{state: deleted}

{state: deleted}

{state: deleted}

Các loại và chức năng tích hợp phổ biến có thể được sử dụng làm bộ chuyển đổi loại:

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Các chức năng do người dùng xác định cũng có thể được sử dụng:

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Hàm

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Nói chung, từ khóa

{state: deleted}

Ví dụ, chuyển đổi JSON hoặc YAML có các trường hợp lỗi phức tạp yêu cầu báo cáo tốt hơn so với từ khóa

{state: deleted}

{state: deleted}

{state: deleted}

Ngay cả

{state: deleted}

{state: deleted}

Đối với trình kiểm tra loại chỉ cần kiểm tra đối với một tập hợp các giá trị cố định, hãy xem xét sử dụng từ khóa lựa chọn thay thế.

Lựa chọn lor

Một số đối số dòng lệnh nên được chọn từ một tập hợp các giá trị bị hạn chế. Chúng có thể được xử lý bằng cách chuyển một đối tượng container làm đối số từ khóa lựa chọn cho

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Lưu ý rằng việc đưa vào thùng chứa lựa chọn được kiểm tra sau khi bất kỳ chuyển đổi loại nào đã được thực hiện, do đó, loại đối tượng trong thùng chứa lựa chọn phải khớp với loại được chỉ định:

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Bất kỳ container nào cũng có thể được truyền dưới dạng giá trị lựa chọn, do đó, các đối tượng

{state: deleted}

{state: deleted}

Việc sử dụng

{state: deleted}

Các lựa chọn được định dạng ghi đè Metavar mặc định thường có nguồn gốc từ Dest. Đây thường là những gì bạn muốn vì người dùng không bao giờ nhìn thấy tham số Dests. Nếu màn hình này không phải là mong muốn (có lẽ vì có nhiều lựa chọn), chỉ cần chỉ định một Metavar rõ ràng.

yêu cầu¶

Nói chung, mô -đun

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Như ví dụ cho thấy, nếu một tùy chọn được đánh dấu là

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Ghi chú

Các tùy chọn cần thiết thường được coi là hình thức xấu vì người dùng mong đợi các tùy chọn là tùy chọn và do đó chúng nên tránh khi có thể.

Cứu giúp¶

Giá trị

{state: deleted}

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

{state: deleted}

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Các chuỗi

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

{state: deleted}

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Khi chuỗi trợ giúp hỗ trợ %-formatting, nếu bạn muốn một

{state: deleted}

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

{state: deleted}

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Metavar¶

Khi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

Một tên thay thế có thể được chỉ định với

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Lưu ý rằng

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Các giá trị khác nhau của

{state: deleted}

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

định mệnh

Hầu hết các hành động

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Đối với các hành động đối số tùy chọn, giá trị của

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Các lớp hành động

Các lớp hành động thực hiện API hành động, một cuộc gọi có thể gọi được trả về một cuộc gọi có thể gọi được xử lý các đối số từ dòng lệnh. Bất kỳ đối tượng nào theo API này có thể được truyền dưới dạng tham số

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Các đối tượng hành động được sử dụng bởi một archarchParser để thể hiện thông tin cần thiết để phân tích một đối số duy nhất từ ​​một hoặc nhiều chuỗi từ dòng lệnh. Lớp hành động phải chấp nhận hai đối số vị trí cộng với bất kỳ đối số từ khóa nào được chuyển đến

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Các phiên bản hành động (hoặc giá trị trả về của bất kỳ cuộc gọi nào có thể gọi được cho tham số

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

Các trường hợp hành động phải được gọi, vì vậy các lớp con phải ghi đè phương thức

{state: deleted}

• parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  30 - Đối tượng ArgentParSer có chứa hành động này.

• parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  31 - Đối tượng

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  66 sẽ được trả về bởi

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  55. Hầu hết các hành động thêm một thuộc tính cho đối tượng này bằng cách sử dụng

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  34.

• parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  35 - Các đối số dòng lệnh liên quan, với bất kỳ chuyển đổi loại nào được áp dụng. Chuyển đổi loại được chỉ định với đối số từ khóa loại thành

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  53.

• parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  37 - Chuỗi tùy chọn được sử dụng để gọi hành động này. Đối số

  parser = argparse.ArgumentParser(
                      prog = 'ProgramName',
                      description = 'What the program does',
                      epilog = 'Text at the bottom of help')
  

  37 là tùy chọn và sẽ vắng mặt nếu hành động được liên kết với một đối số vị trí.

Phương thức

{state: deleted}

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

Các lớp con hành động có thể xác định phương thức

{state: deleted}

Giá trị tùy chọn Cú pháp

Phương thức

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Đối với các tùy chọn dài (các tùy chọn có tên dài hơn một ký tự), tùy chọn và giá trị cũng có thể được truyền dưới dạng đối số dòng lệnh duy nhất, sử dụng

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Đối với các tùy chọn ngắn (các tùy chọn chỉ dài một ký tự), tùy chọn và giá trị của nó có thể được nối:

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Một số tùy chọn ngắn có thể được kết hợp với nhau, chỉ sử dụng một tiền tố

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Đối số không hợp lệ¶

Trong khi phân tích dòng lệnh,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

Đối số chứa ________ 217¶

Phương pháp

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Nếu bạn có các đối số vị trí phải bắt đầu với

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Các chữ viết tắt đối số (khớp tiền tố) ¶

Phương pháp

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Một lỗi được tạo ra cho các đối số có thể tạo ra nhiều tùy chọn. Tính năng này có thể được vô hiệu hóa bằng cách đặt allow_abbrev thành

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Ngoài ________ 119¶

Đôi khi có thể hữu ích khi có một đối số phân tích phân tích khác với các đối số của

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Đối tượng không gian tên

Lớp đơn giản được sử dụng theo mặc định bởi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Lớp này có chủ ý đơn giản, chỉ là một lớp con

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Cũng có thể hữu ích khi có một gán

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Chỉ huy phụ công

Nhiều chương trình chia chức năng của chúng thành một số lệnh phụ, ví dụ, chương trình

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Mô tả các tham số:

• Tiêu đề - Tiêu đề cho nhóm phân tích phụ trong đầu ra trợ giúp; Theo mặc định, các tiểu ban, "nếu mô tả được cung cấp, nếu không thì sử dụng tiêu đề cho các đối số vị trí

• Mô tả - Mô tả cho nhóm phân tích con trong đầu ra trợ giúp, theo mặc định

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37

• Prog - Thông tin sử dụng sẽ được hiển thị với Trợ giúp phụ, theo mặc định, tên của chương trình và bất kỳ đối số vị trí nào trước đối số phụ

• Parser_Class - Lớp sẽ được sử dụng để tạo các phiên bản phân tích phụ, theo mặc định, lớp của trình phân tích cú pháp hiện tại (ví dụ: ArgumentParSer)

• Hành động - Loại hành động cơ bản sẽ được thực hiện khi gặp đối số này ở dòng lệnh

• Dest - Tên của thuộc tính theo đó tên phụ sẽ được lưu trữ; theo mặc định

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37 và không có giá trị nào được lưu trữ

• Yêu cầu - Có hay không một tiểu ban phải được cung cấp, theo mặc định

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  44 (được thêm vào trong 3.7)

• Trợ giúp - Trợ giúp cho nhóm phân tích phụ trong đầu ra trợ giúp, theo mặc định

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37

• Metavar - Chuỗi trình bày các lệnh phụ có sẵn trong trợ giúp; Theo mặc định, đó là

  with open("file_to_edit.yaml", 'w') as f:
      f.write(yaml.safe_dump(doc))
  

  37 và trình bày các lệnh phụ ở dạng {cmd1, cmd2, ..}

Một số ví dụ sử dụng:

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Lưu ý rằng đối tượng được trả về bởi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

Tương tự, khi một tin nhắn trợ giúp được yêu cầu từ trình con, chỉ có sự trợ giúp cho trình phân tích cú pháp cụ thể đó mới được in. Thông điệp trợ giúp sẽ không bao gồm trình phân tích cú pháp phụ huynh hoặc trình phân tích cú pháp anh chị em. .

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Phương pháp

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Hơn nữa,

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

options:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)

Một cách đặc biệt hiệu quả để xử lý các lệnh phụ là kết hợp việc sử dụng phương thức

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Bằng cách này, bạn có thể để

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Thay đổi trong phiên bản 3.7: Đối số từ khóa bắt buộc mới.New required keyword argument.

Đối tượng Filetype

Nhà máy

{state: deleted}

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

{state: deleted}

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Các đối tượng FileType hiểu đối số giả

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

{state: deleted}

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

{state: deleted}

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Mới trong phiên bản 3.4: Các đối số từ khóa mã hóa và lỗi.The encodings and errors keyword arguments.

Nhóm tranh luận

Theo mặc định,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Phương thức

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Lưu ý rằng bất kỳ đối số nào không có trong các nhóm do người dùng định nghĩa sẽ kết thúc trong các phần đối số vị trí thông thường của các phần và các đối số tùy chọn.

Đã thay đổi trong phiên bản 3.11: Gọi

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Loại trừ lẫn nhau¶

Tạo một nhóm loại trừ lẫn nhau.

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Phương pháp

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Lưu ý rằng các nhóm đối số loại trừ hiện tại không hỗ trợ tiêu đề và các đối số mô tả của

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Đã thay đổi trong phiên bản 3.11: Gọi

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Người phân tích cú pháp Defaults¶

Hầu hết thời gian, các thuộc tính của đối tượng được trả về bởi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Lưu ý rằng các mặc định cấp độ phân tích cú pháp luôn ghi đè mặc định cấp đối số:

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

Mặc định cấp độ phân tích cú pháp có thể đặc biệt hữu ích khi làm việc với nhiều trình phân tích cú pháp. Xem phương thức

parser = argparse.ArgumentParser(
                    prog = 'ProgramName',
                    description = 'What the program does',
                    epilog = 'Text at the bottom of help')

Nhận giá trị mặc định cho thuộc tính không gian tên, như được đặt bởi

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

In ấn trợ giúp

Trong hầu hết các ứng dụng điển hình,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

In một mô tả ngắn gọn về cách

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

In một thông báo trợ giúp, bao gồm việc sử dụng chương trình và thông tin về các đối số được đăng ký với

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Ngoài ra còn có các biến thể của các phương thức này chỉ cần trả về một chuỗi thay vì in nó:

Trả về một chuỗi chứa một mô tả ngắn gọn về cách

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Trả về một chuỗi chứa thông báo trợ giúp, bao gồm việc sử dụng chương trình và thông tin về các đối số được đăng ký với

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Phân tích cú pháp một phần

Đôi khi một tập lệnh chỉ có thể phân tích một vài đối số dòng lệnh, chuyển các đối số còn lại cho tập lệnh hoặc chương trình khác. Trong những trường hợp này, phương pháp

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Cảnh báo

Các quy tắc khớp tiền tố áp dụng cho

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Tùy chỉnh tệp phân tích cú pháp tệp

Các đối số được đọc từ một tệp (xem đối số từ khóa từfile_prefix_chars đến hàm tạo

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

Phương thức này lấy một đối số arg_line là một chuỗi được đọc từ tệp đối số. Nó trả về một danh sách các đối số được phân tích cú pháp từ chuỗi này. Phương thức được gọi là một lần trên mỗi dòng đọc từ tệp đối số, theo thứ tự.

Một sự ghi đè hữu ích của phương pháp này là một loại coi từng từ được phân tách không gian như một đối số. Ví dụ sau đây cho thấy cách làm điều này:

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Phương pháp thoát

Phương thức này chấm dứt chương trình, thoát với trạng thái được chỉ định và, nếu được đưa ra, nó sẽ in một thông báo trước đó. Người dùng có thể ghi đè phương thức này để xử lý các bước này khác nhau:

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Phương pháp này in một thông báo sử dụng bao gồm thông báo đến lỗi tiêu chuẩn và chấm dứt chương trình bằng mã trạng thái là 2.

Phân tích cú pháp xen kẽ

Một số lệnh UNIX cho phép người dùng xen kẽ các đối số tùy chọn với các đối số vị trí. Các phương pháp

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Các trình phân tích cú pháp này không hỗ trợ tất cả các tính năng của Argparse và sẽ tăng các ngoại lệ nếu các tính năng không được hỗ trợ được sử dụng. Cụ thể, các nhóm phụ,

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

Ví dụ sau đây cho thấy sự khác biệt giữa

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag

Mới trong phiên bản 3.7.