Hướng dẫn list as argument python argparse - liệt kê dưới dạng đối số python argparse
CÂU TRẢ LỜI NGẮNSử dụng tùy chọn 05 hoặc cài đặt 06 của tùy chọn 07 (tùy thuộc vào cách bạn muốn giao diện người dùng hoạt động). Show
nargs
08 mất 1 hoặc nhiều đối số, 09 không có hoặc nhiều hơn.nối
Với 10, bạn cung cấp tùy chọn nhiều lần để xây dựng danh sách.Đừng sử dụng ________ 111 !!! - Có lẽ không có tình huống nào bạn muốn sử dụng 11 with 13. Ever.CÂU TRẢ LỜI DÀIChúng ta hãy xem chi tiết hơn theo một số cách khác nhau mà người ta có thể cố gắng làm điều này và kết quả cuối cùng.
Đây là đầu ra bạn có thể mong đợi:
Takeaways:
1: Tôi không có nghĩa là nói chung .. Ý tôi là sử dụng báo giá để chuyển danh sách cho 13 không phải là điều bạn muốn. Mới trong phiên bản 3.2. Mã nguồn: lib/argparse.py Lib/argparse.py Mô-đun 33 giúp dễ dàng viết các giao diện dòng lệnh thân thiện với người dùng. Chương trình xác định những đối số mà nó yêu cầu và 33 sẽ tìm ra cách phân tích các đối số của 35. Mô -đun 33 cũng tự động tạo thông báo trợ giúp và sử dụng. Mô -đun cũng sẽ phát hành lỗi khi người dùng đưa ra các đối số không hợp lệ.Chức năng cốt lõi¶Mô-đun 33 hỗ trợ cho các giao diện dòng lệnh được xây dựng xung quanh một thể hiện là 38. Nó là một thùng chứa cho các thông số kỹ thuật đối số và có các tùy chọn áp dụng toàn bộ trình phân tích cú pháp:parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help') Phương thức 39 đính kèm các thông số kỹ thuật đối số riêng lẻ vào trình phân tích cú pháp. Nó hỗ trợ các đối số vị trí, các tùy chọn chấp nhận các giá trị và cờ bật/tắt: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 Phương thức 40 chạy trình phân tích cú pháp và đặt dữ liệu được trích xuất vào đối tượng 41:args = parser.parse_args() print(args.filename, args.count, args.verbose) Liên kết nhanh cho add_argument ()
Thí dụ¶Mã sau đây là một chương trình Python lấy một danh sách các số nguyên và tạo ra tổng hoặc tối đa: 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)) Giả sử mã Python ở trên được lưu vào một tệp có tên 64, nó có thể được chạy ở dòng lệnh và nó cung cấp các thông báo trợ giúp hữu ích:$ 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) Khi chạy với các đối số thích hợp, nó in tổng hoặc tối đa của số nguyên dòng lệnh: $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 10 Nếu các đối số không hợp lệ được truyền vào, một lỗi sẽ được hiển thị: 0Các phần sau đây hướng dẫn bạn qua ví dụ này. Tạo trình phân tích cú phápBước đầu tiên trong việc sử dụng 33 là tạo đối tượng 66: 1Đối tượng 66 sẽ giữ tất cả thông tin cần thiết để phân tích dòng lệnh vào các loại dữ liệu Python.Thêm đối sốViệc điền vào 66 với thông tin về các đối số chương trình được thực hiện bằng cách thực hiện các cuộc gọi đến phương thức 69. Nói chung, các cuộc gọi này cho biết 66 làm thế nào để lấy các chuỗi trên dòng lệnh và biến chúng thành các đối tượng. Thông tin này được lưu trữ và sử dụng khi 71 được gọi. Ví dụ: 2Sau đó, gọi 71 sẽ trả về một đối tượng với hai thuộc tính, 73 và 74. Thuộc tính 73 sẽ là danh sách một hoặc nhiều số nguyên và thuộc tính 74 sẽ là hàm 77, nếu 78 được chỉ định tại dòng lệnh hoặc hàm 79 nếu không.Phân tích đối số 66 Phân tích đối số thông qua phương thức 71. Điều này sẽ kiểm tra dòng lệnh, chuyển đổi từng đối số thành loại thích hợp và sau đó gọi hành động thích hợp. Trong hầu hết các trường hợp, điều này có nghĩa là một đối tượng 82 đơn giản sẽ được xây dựng từ các thuộc tính được phân tích từ dòng lệnh: 3Trong một tập lệnh, 71 thường sẽ được gọi mà không có đối số và 66 sẽ tự động xác định các đối số dòng lệnh từ 35.Đối tượng ArbutionParserclassArgParse.ArgumentParser (prog = none, use = none, description = none, epilog = none, cha mẹ = [], formatter_class = argparse.helpformatter, prefix_chars = '-', fromfile_prefix_chars , add_help = true, allow_abbrev = true, exit_on_error = true) ¶ argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)¶Tạo một đối tượng 66 mới. Tất cả các tham số nên được truyền làm đối số từ khóa. Mỗi tham số có mô tả chi tiết hơn dưới đây, nhưng tóm lại chúng là:
Đã thay đổi trong phiên bản 3.5: Tham số allow_abbrev đã được thêm vào.allow_abbrev parameter was added. Đã thay đổi trong phiên bản 3.8: Trong các phiên bản trước, allow_abbrev cũng vô hiệu hóa nhóm các cờ ngắn như 95 to mean 96.Đã thay đổi trong phiên bản 3.9: tham số EXIT_ON_ERROR đã được thêm vào.exit_on_error parameter was added. Các phần sau đây mô tả cách mỗi trong số này được sử dụng. ăn xin¶Theo mặc định, các đối tượng 66 sử dụng 98 để xác định cách hiển thị tên của chương trình trong các thông báo trợ giúp. Mặc định này hầu như luôn luôn mong muốn vì nó sẽ làm cho các thông báo trợ giúp khớp với cách chương trình được gọi trên dòng lệnh. Ví dụ: hãy xem xét một tệp có tên 99 với mã sau: 4Sự trợ giúp cho chương trình này sẽ hiển thị 99 dưới dạng tên chương trình (bất kể chương trình được gọi từ đâu): 5Để 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ố 01 thành 66: 6Lưu ý rằng tên chương trình, cho dù được xác định từ 98 hoặc từ đối số 01, có sẵn để giúp các thông báo bằng cách sử dụng trình xác định định dạng 05. 7cách sử dụng¶Theo mặc định, 66 tính toán thông báo sử dụng từ các đối số mà nó chứa: 8Thông báo mặc định có thể được ghi đè với đối số từ khóa 07: 9Trình xác định định dạng 05 có sẵn để điền tên chương trình trong thông báo sử dụng của bạn.sự mô tả¶Hầu hết các cuộc gọi đến trình xây dựng 66 sẽ sử dụng đối số từ khóa 10. Lập luận này đưa ra một mô tả ngắn gọn về những gì chương trình làm và cách thức hoạt động. Trong các thông báo trợ giúp, mô tả được hiển thị giữa chuỗi sử dụng dòng lệnh và các thông báo trợ giúp cho các đối số khác nhau: 0Theo 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. EpilognMộ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ố 11 thành 66: 1Như với đối số mô tả, văn bản 11 được bọc theo mặc định, nhưng hành vi này có thể được điều chỉnh bằng đối số formatter_ class thành 66.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ố 15 cho 66. Đối số 15 lấy một danh sách các đối tượng 66, thu thập tất cả các hành động vị trí và tùy chọn từ chúng và thêm các hành động này vào đối tượng 66 được xây dựng: 2Lưu ý rằng hầu hết các trình phân tích cú pháp cha sẽ chỉ định 20. Mặt khác, 66 sẽ thấy hai tùy chọn 91 (một trong cha mẹ và một trong trẻ) và gây ra lỗi.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 15. Nếu bạn thay đổi trình phân tích cú pháp cha mẹ sau khi trình phân tích cú pháp con, những thay đổi đó sẽ không được phản ánh ở trẻ.
formatter_ class¶¶ 66 Các đối tượng cho phép định dạng trợ giúp được tùy chỉnh bằng cách chỉ định một lớp định dạng thay thế. Hiện tại, có bốn lớp như vậy:
classargparse.rawdescriphelpformatterr classargparse.rawtexthelpformatter¶ classargparse.argumentdefaultshelpformatterrargparse.RawDescriptionHelpFormatter¶ class
argparse.RawTextHelpFormatter¶ class
argparse.ArgumentDefaultsHelpFormatter¶ class
argparse.MetavarTypeHelpFormatter¶ 25 và 26 cung cấp nhiều quyền kiểm soát hơn về cách hiển thị mô tả văn bản. Theo mặc định, 66 Đối tượng đã bao bọc dòng mô tả và văn bản Epilog trong các thông báo trợ giúp dòng lệnh: 3Vượt qua 25 như 29 chỉ ra rằng mô tả và epilog đã được định dạng chính xác và không nên được bọc dòng: 4 26 duy trì khoảng trắng cho tất cả các loại văn bản trợ giúp, bao gồm các mô tả đối số. Tuy nhiên, nhiều dòng mới được thay thế bằng một. Nếu bạn muốn bảo quản nhiều dòng trống, hãy thêm khoảng trống giữa các dòng mới. 31 Tự động thêm thông tin về các giá trị mặc định vào từng thông báo trợ giúp đối số: 5 32 sử dụng tên của đối số loại cho mỗi đối số làm tên hiển thị cho các giá trị của nó (thay vì sử dụng định mệnh như định dạng thông thường): 6prefix_chars¶Hầu hết các tùy chọn dòng lệnh sẽ sử dụng 33 làm tiền tố, ví dụ: 34. Các trình phân tích cú pháp cần hỗ trợ các ký tự tiền tố khác nhau hoặc bổ sung, ví dụ: Đối với các tùy chọn như 35 hoặc 36, có thể chỉ định chúng bằng đối số 37 cho Trình xây dựng ArmparParser:
7Đối số 37 mặc định là 39. Cung cấp một tập hợp các ký tự không bao gồm 33 sẽ khiến các tùy chọn 34 không được phép.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ố 42 được đưa ra cho hàm tạo 66, thì các đối số bắt đầu với bất kỳ ký tự được chỉ định nào sẽ được coi là tệp và sẽ được thay thế bằng các đối số mà chúng chứa. Ví dụ: 8Cá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 44) và được xử lý như thể chúng ở cùng một nơi với đối số tham chiếu tệp gốc trên dòng lệnh. Vì vậy, trong ví dụ trên, biểu thức 45 được coi là tương đương với biểu thức 46.Đối số 42 mặc định là 53, có nghĩa là các đối số sẽ không bao giờ được coi là tham chiếu tệp.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 69 hoặc bằng cách gọi các phương thức 50 với một tập hợp các cặp giá trị tên cụ thể. Tuy nhiên, đôi khi, có thể hữu ích khi chỉ định một mặc định toàn trình phân tích cú pháp cho các đối số. Điều này có thể được thực hiện bằng cách chuyển đối số từ khóa 51 cho 66. Ví dụ: để triệt tiêu toàn cầu tạo thuộc tính trên các cuộc gọi 71, chúng tôi cung cấp 54: 9cho phép_abbrev¶Thông thường, khi bạn chuyển một danh sách đối số cho phương thức 71 của 66, nó sẽ nhận ra chữ viết tắt của các tùy chọn dài.recognizes abbreviations of long options.Tính năng này có thể bị tắt bằng cách đặt 57 thành 60: 0Mới trong phiên bản 3.5. xung đột_handler¶ 66 Các đối tượng không cho phép hai hành động có cùng chuỗi tùy chọn. Theo mặc định, các đối tượng 66 nêu ra một ngoại lệ nếu một nỗ lực được thực hiện để tạo đối số với một chuỗi tùy chọn đã được sử dụng: 1Đô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ị 61 có thể được cung cấp cho đối số 62 của 66: 2Lưu ý rằng các đối tượng 66 chỉ xóa một hành động nếu tất cả các chuỗi tùy chọn của nó bị ghi đè. Vì vậy, trong ví dụ trên, hành động 34 cũ được giữ lại dưới dạng hành động 66, bởi vì chỉ chuỗi tùy chọn 67 đã được ghi đè.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 99 chứa mã sau: 4Nếu 69 hoặc 70 được cung cấp tại dòng lệnh, Trợ giúp của ArbutionParser sẽ được in: 4Đô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 60 dưới dạng đối số 72 cho 66: 5Tùy chọn trợ giúp thường là 91. Ngoại lệ cho điều này là nếu 37 được chỉ định và không bao gồm 33, trong trường hợp đó 69 và 70 không phải là các tùy chọn hợp lệ. Trong trường hợp này, ký tự đầu tiên trong 79 được sử dụng để tiền tố các tùy chọn trợ giúp: 6exit_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 71 của 66, nó sẽ thoát với thông tin lỗi.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 82 thành 60: 7Mới trong phiên bản 3.9. Phương thức add_argument ()ArcharchParser.add_argument (nameorflags ... [, hành động] [, nargs] [, const] [, mặc định] [, loại] [, lựa chọn] [, yêu cầu] [, trợ giúp]add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])¶Xác định cách một đối số dòng lệnh duy nhất nên được phân tích cú pháp. Mỗi tham số có mô tả chi tiết hơn dưới đây, nhưng tóm lại chúng là:
Các phần sau đây mô tả cách mỗi trong số này được sử dụng. Tên hoặc CờPhương pháp 69 phải biết liệu một đối số tùy chọn, như 66 hay 67 hay đối số vị trí, như một danh sách các tên tệp, được dự kiến. Do đó, các đối số đầu tiên được chuyển cho 69 phải là một loạt các cờ hoặc một tên đối số đơn giản.Ví dụ, một đối số tùy chọn có thể được tạo như: 8Trong khi một đối số vị trí có thể được tạo như: 9Khi 71 được gọi, các đối số tùy chọn sẽ được xác định bởi tiền tố 33 và các đối số còn lại sẽ được coi là vị trí:parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')0 hoạt động¶ 66 Đối tượng liên kết các đối số dòng lệnh với các hành động. Những hành động này có thể thực hiện bất cứ điều gì với các đối số dòng lệnh được liên kết với chúng, mặc dù hầu hết các hành động chỉ cần thêm một thuộc tính vào đối tượng được trả về bởi 71. Đối số từ khóa 95 Chỉ định cách xử lý các đối số dòng lệnh. Các hành động được cung cấp là:
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. 19 có sẵn trong 33 và thêm hỗ trợ cho các hành động Boolean như 67 và 22:parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')9 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 23, ghi đè phương thức 24 và tùy chọn các phương thức 25 và 26.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 flag0 Để biết thêm chi tiết, xem 23.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 28 liên kết một số lượng đối số dòng lệnh khác nhau với một hành động duy nhất. Các giá trị được hỗ trợ là:
Nếu đối số từ khóa 28 không được cung cấp, số lượng đối số được tiêu thụ được xác định bởi hành động. Nói chung, điều này có nghĩa là một đối số dòng lệnh duy nhất sẽ được tiêu thụ và một mục duy nhất (không phải danh sách) sẽ được tạo ra.hăng sô¶Đối số 40 của 69 được sử dụng để giữ các giá trị không đổi không được đọc từ dòng lệnh nhưng được yêu cầu cho các hành động 66 khác nhau. Hai cách sử dụng phổ biến nhất của nó là:
Đã thay đổi trong phiên bản 3.11: 57 by default, including when 45 or 44.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 60 của 69, có giá trị mặc định là 53, chỉ định giá trị nào nên được sử dụng nếu không có đối số dòng lệnh. Đối với các đối số tùy chọn, giá trị 60 được sử dụng khi chuỗi tùy chọn không có ở dòng lệ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 flag6 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 flag7 Nếu giá trị 60 là một chuỗi, trình phân tích cú pháp phân tích giá trị như thể nó là đối số dòng lệnh. Cụ thể, trình phân tích cú pháp áp dụng bất kỳ đối số chuyển đổi loại nào, nếu được cung cấp, trước khi đặt thuộc tính trên giá trị trả về 82. Mặt khác, trình phân tích cú pháp sử dụng giá trị như là: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 flag8 Đối với các đối số vị trí với NARG bằng 66 hoặc 67, giá trị 60 được sử dụng khi không có đối số dòng lệnh nào: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 flag9 Cung cấp 69 khiến không có thuộc tính nào được thêm vào nếu đối số dòng lệnh không có mặt:args = parser.parse_args() print(args.filename, args.count, args.verbose)0 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 thì 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ư 62 hoặc 54. Từ khóa 72 cho 69 cho phép thực hiện mọi chuyển đổi kiểm tra loại và kiểm tra loại cần thiết.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 72 có thể là bất kỳ cuộc gọi nào có thể gọi được chấp nhận một chuỗi. Nếu hàm tăng 75, 76 hoặc 77, ngoại lệ sẽ bị bắt và thông báo lỗi được định dạng độc đáo được hiển thị. Không có loại ngoại lệ khác được xử lý.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)1 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)2 Hàm 78 không được khuyến nghị làm bộ chuyển đổi loại. Tất cả những gì nó làm là chuyển đổi các chuỗi trống thành 60 và các chuỗi không trống thành 59. Đây thường không phải là những gì mong muốn.Nói chung, từ khóa 72 là một sự tiện lợi chỉ nên được sử dụng cho các chuyển đổi đơn giản chỉ có thể tăng một trong ba ngoại lệ được hỗ trợ. Bất cứ điều gì có xử lý lỗi hoặc quản lý tài nguyên thú vị hơn nên được thực hiện ở hạ lưu sau khi các đối số được phân tích cú pháp.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 72. Một 83 sẽ không được định dạng tốt và ngoại lệ 84 sẽ không được xử lý.Ngay cả 85 cũng có những hạn chế để sử dụng với từ khóa 72. Nếu một đối số sử dụng FileType và sau đó một đối số tiếp theo không thành công, một lỗi được báo cáo nhưng tệp không được tự động đóng. Trong trường hợp này, sẽ tốt hơn để đợi cho đến khi trình phân tích cú pháp đã chạy và sau đó sử dụng ________ 387-statement để quản lý các tệp.Đố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 lorMộ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 69. Khi dòng lệnh được phân tích cú pháp, các giá trị đối số sẽ được kiểm tra và thông báo lỗi sẽ được hiển thị nếu đối số không phải là một trong những giá trị chấp nhận được:args = parser.parse_args() print(args.filename, args.count, args.verbose)3 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)4 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 89, đối tượng 90 và các thùng chứa tùy chỉnh đều được hỗ trợ.Việc sử dụng 91 không được khuyến nghị vì rất khó kiểm soát sự xuất hiện của nó trong việc sử dụng, trợ giúp và thông báo lỗi.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 33 giả định rằng các cờ như 66 và 94 chỉ ra các đối số tùy chọn, luôn có thể được bỏ qua ở dòng lệnh. Để thực hiện một tùy chọn yêu cầu, 59 có thể được chỉ định cho đối số từ khóa 96 thành 69:args = parser.parse_args() print(args.filename, args.count, args.verbose)5 Như ví dụ cho thấy, nếu một tùy chọn được đánh dấu là 98, 71 sẽ báo cáo lỗi nếu tùy chọn đó không có ở dòng lệnh.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ị parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')00 là một chuỗi chứa một mô tả ngắn gọn về đối số. Khi người dùng yêu cầu trợ giúp (thường là bằng cách sử dụng 69 hoặc 70 tại dòng lệnh), các mô tả parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')00 này sẽ được hiển thị với mỗi đối số: args = parser.parse_args() print(args.filename, args.count, args.verbose)6 Các chuỗi parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')00 có thể bao gồm các định dạng định dạng khác nhau để tránh lặp lại những thứ như tên chương trình hoặc mặc định đối số. Các nhà xác định có sẵn bao gồm tên chương trình, 05 và hầu hết các đối số từ khóa đến 69, ví dụ: parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')07, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')08, vv .: args = parser.parse_args() print(args.filename, args.count, args.verbose)7 Khi chuỗi trợ giúp hỗ trợ %-formatting, nếu bạn muốn một parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')09 theo nghĩa đen xuất hiện trong chuỗi trợ giúp, bạn phải thoát nó dưới dạng parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')10. 33 Hỗ trợ làm im lặng mục trợ giúp cho một số tùy chọn nhất định, bằng cách đặt giá trị parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')00 thành parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')13: args = parser.parse_args() print(args.filename, args.count, args.verbose)8 Metavar¶Khi 66 tạo tin nhắn trợ giúp, nó cần một số cách để đề cập đến từng đối số dự kiến. Theo mặc định, các đối tượng ArgentParSer sử dụng giá trị định mệnh làm tên tên của mỗi đối tượng. Theo mặc định, đối với các hành động đối số vị trí, giá trị định mệnh được sử dụng trực tiếp và đối với các hành động đối số tùy chọn, giá trị định mệnh được sử dụng trên đường. Vì vậy, một đối số vị trí duy nhất với parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')15 sẽ được gọi là parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')16. Một đối số tùy chọn duy nhất 67 nên được theo sau bởi một đối số dòng lệnh duy nhất sẽ được gọi là parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')18. Một ví dụ: args = parser.parse_args() print(args.filename, args.count, args.verbose)9 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')19: 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))0 Lưu ý rằng parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')19 chỉ thay đổi tên được hiển thị - tên của thuộc tính trên đối tượng 71 vẫn được xác định bởi giá trị định mệnh.Các giá trị khác nhau của 28 có thể khiến metavar được sử dụng nhiều lần. Cung cấp một tuple cho parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')19 Chỉ định một màn hình khác nhau cho mỗi đối số: 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))1 định mệnhHầu hết các hành động 66 Thêm một số giá trị dưới dạng thuộc tính của đối tượng được trả về bởi 71. Tên của thuộc tính này được xác định bởi đối số từ khóa parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 của 69. Đối với các hành động đối số vị trí, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 thường được cung cấp như là đối số đầu tiên cho 69: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))2 Đố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')26 thường được suy ra từ các chuỗi tùy chọn. 66 tạo ra giá trị của parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 bằng cách lấy chuỗi tùy chọn dài đầu tiên và loại bỏ chuỗi parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')33 ban đầu. Nếu không có chuỗi tùy chọn dài nào được cung cấp, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 sẽ được lấy từ chuỗi tùy chọn ngắn đầu tiên bằng cách tước ký tự 33 ban đầu. Bất kỳ ký tự 33 nào sẽ được chuyển đổi thành các ký tự parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')37 để đảm bảo chuỗi là tên thuộc tính hợp lệ. Các ví dụ dưới đây minh họa hành vi này: 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))3 parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 cho phép một tên thuộc tính tùy chỉnh được cung cấp: 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))4 Các lớp hành độngCá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ố 95 đến 69. classargparse.action (tùy chọn_strings, dest, nargs = none, const = none, mặc định = không, loại = không, lựa chọn = none, bắt buộc = falseargparse.Action(option_strings, dest,
nargs=None, const=None, default=None, type=None, choices=None,
required=False, help=None, metavar=None)¶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 39 ngoại trừ chính 95.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ố 95) nên có các thuộc tính của Dest Dest, Tùy chọn_Strings Cách dễ nhất để đảm bảo các thuộc tính này được xác định là gọi parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')44. 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 24, sẽ chấp nhận bốn tham số:
Phương thức 24 có thể thực hiện các hành động tùy ý, nhưng thường sẽ đặt các thuộc tính trên parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')47 dựa trên parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 và parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')51. Các lớp con hành động có thể xác định phương thức 26 không có đối số và trả về một chuỗi sẽ được sử dụng khi in cách sử dụng chương trình. Nếu phương thức đó không được cung cấp, một mặc định hợp lý sẽ được sử dụng.Phương thức parse_args ()ArcharchParser.parse_args (args = none, không gian tên = none) ¶parse_args(args=None, namespace=None)¶Chuyển đổi chuỗi đối số thành các đối tượng và gán chúng là thuộc tính của không gian tên. Trả lại không gian tên đông dân. Các cuộc gọi trước đây đến 69 Xác định chính xác những đối tượng nào được tạo và cách chúng được gán. Xem tài liệu cho 69 để biết chi tiết.
Giá trị tùy chọn Cú phápPhương thức 71 hỗ trợ một số cách chỉ định giá trị của một tùy chọn (nếu nó có một). Trong trường hợp đơn giản nhất, tùy chọn và giá trị của nó được truyền dưới dạng hai đối số riêng biệt: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))5 Đố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')65 để tách chúng ra: 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))6 Đố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))7 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ố 33 duy nhất, miễn là chỉ có tùy chọn cuối cùng (hoặc không ai trong số chúng) yêu cầu một giá trị: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))8 Đối số không hợp lệ¶Trong khi phân tích các dòng lệnh, 71 kiểm tra nhiều lỗi khác nhau, bao gồm các tùy chọn mơ hồ, các loại không hợp lệ, các tùy chọn không hợp lệ, số lượng đối số vị trí sai, v.v. :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))9 Đối số chứa ________ 233¶Phương pháp 71 cố gắng đưa ra lỗi bất cứ khi nào người dùng rõ ràng đã phạm sai lầm, nhưng một số tình huống vốn đã mơ hồ. Ví dụ: đối số dòng lệnh parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')70 có thể là một nỗ lực để chỉ định một tùy chọn hoặc cố gắng cung cấp một đối số vị trí. Phương pháp 71 rất thận trọng ở đây: Các đối số vị trí chỉ có thể bắt đầu bằng 33 nếu chúng trông giống như số âm và không có tùy chọn nào trong trình phân tích cú pháp trông giống như số âm:$ 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)0 Nếu bạn có các đối số vị trí phải bắt đầu bằng 33 và don lồng trông giống như các số âm, bạn có thể chèn các đối số giả parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')74 cho biết 71 rằng mọi thứ sau đó là một đối số vị trí:$ 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)1 Các chữ viết tắt đối số (khớp tiền tố) ¶Phương pháp 71 theo mặc định cho phép các tùy chọn dài được viết tắt là tiền tố, nếu viết tắt không rõ ràng (tiền tố phù hợp với tùy chọn duy nhất):by default allows long options to be abbreviated to a prefix, if the abbreviation is unambiguous (the prefix matches a unique option):$ 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)2 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 cài đặt allow_abbrev thành 60.allow_abbrev to 60.Ngoài ________ 135¶Đô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 35. Điều này có thể được thực hiện bằng cách chuyển một danh sách các chuỗi cho 71. Điều này rất hữu ích để kiểm tra tại dấu nhắc tương tác:$ 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)3 Đối tượng không gian tênclassargparse.namespace¶argparse.Namespace¶Lớp đơn giản được sử dụng theo mặc định bởi 71 để tạo các thuộc tính giữ đối tượng và trả về nó.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')82 với một biểu diễn chuỗi có thể đọc được. Nếu bạn thích có chế độ xem giống như các thuộc tính, bạn có thể sử dụng thành ngữ Python tiêu chuẩn, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')83: $ 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)4 Cũng có thể hữu ích khi có một gán 66 gán cho một đối tượng đã có, thay vì một đối tượng 82 mới. Điều này có thể đạt được bằng cách chỉ định đối số từ khóa parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')86: $ 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)5 Các tiện ích khácChỉ huy phụ côngArcharchParser.add_subparsers ([Tiêu đề] [, Mô tả] [, Prog] [, Parser_Class] [, Action] [, Tùy chọn_Strings] [, Dest] [, Yêu cầu] [, Help] [, Metavar]) ¶add_subparsers([title][, description][, prog][, parser_class][, action][, option_strings][, dest][, required][, help][, metavar])¶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')87 có thể gọi các lệnh phụ như parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')88, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')89 và parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')90. Chia tách chức năng theo cách này có thể là một ý tưởng đặc biệt tốt khi một chương trình thực hiện một số chức năng khác nhau yêu cầu các loại đối số dòng lệnh khác nhau. 66 hỗ trợ việc tạo ra các lệnh phụ như vậy bằng phương pháp parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')92. Phương thức parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')92 thường được gọi là không có đối số và trả về một đối tượng hành động đặc biệt. Đối tượng này có một phương thức duy nhất, parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')94, lấy tên lệnh và bất kỳ đối số trình xây dựng 66 nào và trả về một đối tượng 66 có thể được sửa đổi như bình thường.Mô tả các tham số:
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)6 Lưu ý rằng đối tượng được trả về bởi 71 sẽ chỉ chứa các thuộc tính cho trình phân tích cú pháp chính và trình con được chọn bởi dòng lệnh (chứ không phải bất kỳ trình nào khác). Vì vậy, trong ví dụ trên, khi lệ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 flag03 được chỉ định, chỉ có các thuộc tính 84 và parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')16 và khi lệ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 flag06 được chỉ định, chỉ có các thuộc tính 84 và 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 flag08. 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)7 Phương pháp parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')92 cũng hỗ trợ các đối số từ khó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 flag12 và 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 flag13. Khi có mặt, các lệnh Subparser sẽ xuất hiện trong nhóm của riêng họ trong đầu ra trợ giúp. Ví dụ: $ 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)8 Hơn nữ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 flag14 hỗ trợ một đối số 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 flag15 bổ sung, cho phép nhiều chuỗi tham khảo cùng một trình tự phụ. Ví dụ này, như parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')87, bí danh 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 flag17 như một tốc ký 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 flag18: $ 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)9 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')92 với các cuộc gọi đến 50 để mỗi người con biết chức năng Python nào nên thực hiện. Ví dụ:$ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 100 Bằng cách này, bạn có thể để 71 thực hiện công việc gọi chức năng thích hợp sau khi phân tích đối số hoàn tất. Liên kết các chức năng với các hành động như thế này thường là cách dễ nhất để xử lý các hành động khác nhau cho mỗi người phụ của bạn. Tuy nhiên, nếu cần phải kiểm tra tên của trình con được gọi, đối số từ khóa parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')26 cho cuộc gọi parser = argparse.ArgumentParser( prog = 'ProgramName', description = 'What the program does', epilog = 'Text at the bottom of help')92 sẽ hoạt động: $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 101 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 Filetypeclassargparse.filetype (mode = 'r', bufsize = -1, expoding = none, error = none) ¶ argparse.FileType(mode='r', bufsize=- 1, encoding=None, errors=None)¶Nhà máy 85 tạo ra các đối tượng có thể được chuyển đến đối số loại 39. Các đối số có các đối tượng 85 là loại của chúng sẽ mở các đối số dòng lệnh dưới dạng các tệp với các chế độ được yêu cầu, kích thước bộ đệm, mã hóa và xử lý lỗi (xem hàm 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 flag27 để biết thêm chi tiết): $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 102 Các đối tượng FileType hiểu đối số giả 39 và tự động chuyển đổi nó thà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 flag29 cho các đối tượng 85 có thể đọc được và 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 flag31 cho các đối tượng 85 có thể ghi:$ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 103 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ậnArcharchParser.add_argument_group (title = none, description = none) ¶add_argument_group(title=None, description=None)¶Theo mặc định, 66 Các đối số dòng lệnh của các nhóm thành các đối số vị trí của Cameron và các đối số tùy chọn, khi hiển thị các thông báo trợ giúp. Khi có một nhóm đối số khái niệm tốt hơn so với mặc định này, các nhóm thích hợp có thể được tạo bằng 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 flag34: $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 104 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 flag34 trả về một đối tượng nhóm đối số có phương thức 69 giống như 66 thông thường. Khi một đối số được thêm vào nhóm, trình phân tích cú pháp đối xử với nó giống như một đối số bình thường, nhưng hiển thị đối số trong một nhóm riêng cho các tin nhắn trợ giúp. 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 flag34 chấp nhận các đối số tiêu đề và mô tả có thể được sử dụng để tùy chỉnh màn hình này: $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 105 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 flag34 on an argument group is deprecated. This feature was never supported and does not always work correctly. The function exists on the API by accident through inheritance and will be removed in the future. Loại trừ lẫn nhau¶ArcharchParser.add_mutally_exclusive_group (bắt buộc = false) ¶add_mutually_exclusive_group(required=False)¶Tạo một nhóm loại trừ lẫn nhau. 33 sẽ đảm bảo rằng chỉ có một trong các đối số trong nhóm loại trừ lẫn nhau có mặt trên dòng lệnh:$ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 106 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 flag41 cũng chấp nhận một đối số cần thiết, để chỉ ra rằng ít nhất một trong các đối số loại trừ lẫn nhau là bắt buộc: $ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 107 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 flag34. Đã 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 flag34 or 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 flag41 on a mutually exclusive group is deprecated. These features were never supported and do not always work correctly. The functions exist on the API by accident through inheritance and will be removed in the future. Người phân tích cú pháp Defaults¶ArcharchParser.set_defaults (** kwargs) ¶set_defaults(**kwargs)¶Hầu hết thời gian, các thuộc tính của đối tượng được trả về bởi 71 sẽ được xác định đầy đủ bằng cách kiểm tra các đối số dòng lệnh và các hành động đối số. 50 cho phép một số thuộc tính bổ sung được xác định mà không cần thêm bất kỳ sự kiểm tra nào của dòng lệnh:$ python prog.py 1 2 3 4 4 $ python prog.py 1 2 3 4 --sum 108 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 109 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')92 để biết ví dụ về loại này. Archarchparparser.get_default (Dest) ¶get_default(dest)¶ Nhận giá trị mặc định cho thuộc tính không gian tên, như được đặt bởi 69 hoặc bằng 50: 00In ấn trợ giúpTrong hầu hết các ứng dụng điển hình, 71 sẽ chăm sóc định dạng và in bất kỳ thông báo sử dụng hoặc lỗi nào. Tuy nhiên, một số phương thức định dạng có sẵn: ArcharchParser.print_usage (file = none) ¶print_usage(file=None)¶In một mô tả ngắn gọn về cách 66 nên được gọi trên dòng lệnh. Nếu tệp là 53, 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 flag31 được giả định. ArcharchParser.print_help (file = none) ¶print_help(file=None)¶ In tin nhắn trợ giúp, bao gồm sử dụng chương trình và thông tin về các đối số được đăng ký với 66. Nếu tệp là 53, 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 flag31 được giả định. 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ó: ArcharchParser.format_usage () ¶format_usage()¶Trả về một chuỗi chứa một mô tả ngắn gọn về cách 66 nên được gọi trên dòng lệnh. ArcharchParser.format_help () ¶format_help()¶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 66.Phân tích cú pháp một phầnArcharchParser.parse_known_args (args = none, không gian tên = none) ¶parse_known_args(args=None, namespace=None)¶Đô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 flag59 có thể hữu ích. Nó hoạt động giống như 71 ngoại trừ việc nó không tạo ra lỗi khi có các đối số bổ sung. Thay vào đó, nó trả về một tuple hai mục chứa không gian tên dân cư và danh sách các chuỗi đối số còn lại. 01Cả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 flag59. The parser may consume an option even if it’s just a prefix of one of its known options, instead of leaving it in the remaining arguments list. Tùy chỉnh tệp phân tích cú pháp tệpArmentParser.convert_arg_line_to_args (arg_line) ¶convert_arg_line_to_args(arg_line)¶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 66) được đọc một đối số trên mỗi dòng. 44 có thể được ghi đè cho việc đọc fancier.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: 02Phương pháp thoátArcharchParser.exit (status = 0, message = none) ¶exit(status=0, message=None)¶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: 03
ArcharchParser.Error (tin nhắn) ¶error(message)¶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ẽArcharchParser.parse_intermixed_args (args = none, không gian tên = không)parse_intermixed_args(args=None, namespace=None)¶ ArgumentParser.parse_known_intermixed_args(args=None, namespace=None)¶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 flag64 và 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 flag65 hỗ trợ phong cách phân tích cú pháp này. 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ụ, 58 và các nhóm loại trừ lẫn nhau bao gồm cả hai tùy chọn và vị trí không được hỗ trợ.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 flag59 và 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 flag64: cái trước trả về 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 flag69 là các đối số không được phân biệt, trong khi cái sau thu thập tất cả các vị trí vào 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 flag70. 04parser.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 flag65 trả về một bộ hai mục chứa không gian tên dân cư và danh sách các chuỗi đối số còn lạ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 flag64 gây ra lỗi nếu có bất kỳ chuỗi đối số không được phân bổ còn lại. Mới trong phiên bản 3.7. Nâng cấp mã OPTPAREBan đầu, mô -đun 33 đã cố gắng duy trì khả năng tương thích vớ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 flag74. Tuy nhiê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 flag74 rất khó để mở rộng một cách minh bạch, đặc biệt là với những thay đổi cần thiết để hỗ trợ các nhà xác đị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 flag76 mới và thông báo sử dụng tốt hơn. Khi hầu hết mọi thứ trong 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 flag74 đã được sao chép hoặc được gắn khỉ, nó dường như không còn thực tế khi cố gắng duy trì khả năng tương thích ngược. Mô -đun 33 được cải thiện trên mô -đun thư viện tiêu chuẩ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 flag74 theo một số cách bao gồm:
Đường dẫn nâng cấp một phần từ 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 flag74 lên 33:
Làm thế nào để Argparse vượt qua các đối số dòng lệnh trong Python?Sử dụng thư viện Python Argparse có bốn bước:.. Nhập thư viện Python Argparse .. Tạo trình phân tích cú pháp .. Thêm đối số tùy chọn và vị trí cho trình phân tích cú pháp .. Hành hình . parse_args (). Store_True trong Python là gì?Tùy chọn Store_True tự động tạo giá trị mặc định là sai.Tương tự như vậy, Store_False sẽ mặc định là đúng khi đối số dòng lệnh không có mặt.Nguồn cho hành vi này là cô đọng và rõ ràng: http://hg.python.org/cpython/file/2.7/lib/argparse.py#l861.automatically creates a default value of False. Likewise, store_false will default to True when the command-line argument is not present. The source for this behavior is succinct and clear: http://hg.python.org/cpython/file/2.7/Lib/argparse.py#l861.
Metavar là gì?Metavar là tên cho đối số trong các thông báo sử dụng.Dest là tên của thuộc tính sẽ được thêm vào đối tượng.Đối tượng này được trả về bởi parse_args.the name for the argument in usage messages. dest is the name of the attribute to be added to the object. This object is returned by parse_args .
Parse_args trở lại là gì?parse_args () Trả về hai giá trị: Tùy chọn, một đối tượng chứa các giá trị cho tất cả các tùy chọn của bạn, ví dụ:Nếu "--file" lấy một đối số chuỗi duy nhất, thì các tùy chọn.Tệp sẽ là tên tệp do người dùng cung cấp hoặc không có nếu người dùng không cung cấp tùy chọn đó.options, an object containing values for all of your options— e.g. if "--file" takes a single string argument, then options. file will be the filename supplied by the user, or None if the user did not supply that option. |