Làm thế nào để đọc / xử lý các đối số dòng lệnh?

Tôi ban đầu là một lập trình viên C. Tôi đã thấy nhiều thủ thuật và "hack" để đọc nhiều lập luận khác nhau.

Một số trong những cách lập trình viên Python có thể làm điều này là gì?

Liên quan

• Cách tốt nhất để lấy / phân tích các đối số dòng lệnh được truyền cho tập lệnh Python là gì?
• Thực hiện một lệnh [lệnh] [hành động] [tham số] Giao diện dòng lệnh kiểu phong cách?
• Làm thế nào tôi có thể xử lý các đối số dòng lệnh trong Python?
• Làm cách nào để định dạng trợ giúp đối số vị trí bằng cách sử dụng optparse của Python?

Giải pháp chính tắc trong thư viện chuẩn là argparse( docs ):

Đây là một ví dụ:

from argparse import ArgumentParser

parser = ArgumentParser()
parser.add_argument("-f", "--file", dest="filename",
                    help="write report to FILE", metavar="FILE")
parser.add_argument("-q", "--quiet",
                    action="store_false", dest="verbose", default=True,
                    help="don't print status messages to stdout")

args = parser.parse_args()

argparse hỗ trợ (trong số những thứ khác):

• Nhiều lựa chọn theo thứ tự bất kỳ.
• Tùy chọn ngắn và dài.
• Giá trị mặc định.
• Tạo một thông báo trợ giúp sử dụng.

import sys

print("\n".join(sys.argv))

sys.argv là một danh sách chứa tất cả các đối số được truyền cho tập lệnh trên dòng lệnh.

Về cơ bản,

import sys
print(sys.argv[1:])

Chỉ cần đi xung quanh việc truyền giáo cho argparse , điều này tốt hơn cho những lý do này .. về cơ bản:

(được sao chép từ liên kết)

• mô-đun argparse có thể xử lý các đối số tùy chọn và vị trí, trong khi optparse chỉ có thể xử lý các đối số tùy chọn

• argparse không giáo điều về giao diện dòng lệnh của bạn sẽ trông như thế nào - các tùy chọn như -file hoặc / file được hỗ trợ, như các tùy chọn bắt buộc. Optparse từ chối hỗ trợ các tính năng này, ưu tiên độ tinh khiết hơn tính thực tế

• argparse tạo ra nhiều thông báo sử dụng thông tin hơn, bao gồm cả việc sử dụng dòng lệnh được xác định từ các đối số của bạn và thông báo trợ giúp cho cả đối số vị trí và tùy chọn. Mô-đun optparse yêu cầu bạn viết chuỗi sử dụng của riêng bạn và không có cách nào để hiển thị trợ giúp cho các đối số vị trí.

• argparse hỗ trợ hành động tiêu thụ một số lượng lớn các đối số dòng lệnh, trong khi optparse yêu cầu phải biết trước số lượng chính xác của các đối số (ví dụ 1, 2 hoặc 3)

• argparse hỗ trợ các trình phân tích cú pháp gửi đến các lệnh phụ, trong khi optparse yêu cầu thiết lập allow_interspersed_argsvà thực hiện việc gửi trình phân tích cú pháp theo cách thủ công

Và sở thích cá nhân của tôi:

• argparse cho phép các tham số loại và hành động add_argument() được chỉ định bằng các hàm gọi đơn giản, trong khi optparse yêu cầu hack các thuộc tính lớp như STORE_ACTIONShoặc CHECK_METHODSđể kiểm tra đối số thích hợp

Ngoài ra còn có argparsemô-đun stdlib (một "sự thay đổi" trên optparsemô-đun của stdlib ). Ví dụ từ phần giới thiệu về argparse :

# script.py
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument(
        'integers', metavar='int', type=int, choices=range(10),
         nargs='+', help='an integer in the range 0..9')
    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))

Sử dụng:

$ script.py 1 2 3 4
4

$ script.py --sum 1 2 3 4
10

Một cách để làm điều đó là sử dụng sys.argv. Điều này sẽ in tên tập lệnh làm đối số đầu tiên và tất cả các tham số khác mà bạn truyền cho nó.

import sys

for arg in sys.argv:
    print arg

Các docopt thư viện thực sự là slick. Nó xây dựng một đối số dict từ chuỗi sử dụng cho ứng dụng của bạn.

Ví dụ: từ docopt readme:

"""Naval Fate.

Usage:
  naval_fate.py ship new <name>...
  naval_fate.py ship <name> move <x> <y> [--speed=<kn>]
  naval_fate.py ship shoot <x> <y>
  naval_fate.py mine (set|remove) <x> <y> [--moored | --drifting]
  naval_fate.py (-h | --help)
  naval_fate.py --version

Options:
  -h --help     Show this screen.
  --version     Show version.
  --speed=<kn>  Speed in knots [default: 10].
  --moored      Moored (anchored) mine.
  --drifting    Drifting mine.

"""
from docopt import docopt


if __name__ == '__main__':
    arguments = docopt(__doc__, version='Naval Fate 2.0')
    print(arguments)

Nếu bạn cần một cái gì đó nhanh chóng và không linh hoạt

chính:

import sys

first_name = sys.argv[1]
last_name = sys.argv[2]
print("Hello " + first_name + " " + last_name)

Sau đó chạy python main.py James Smith

để tạo ra đầu ra sau:

Xin chào James Smith

#set default args as -h , if no args:
if len(sys.argv) == 1: sys.argv[1:] = ["-h"]

Tôi sử dụng optparse cho mình, nhưng thực sự thích hướng mà Simon Willison đang thực hiện với thư viện optfunc được giới thiệu gần đây của anh ấy . Nó hoạt động bằng cách:

"hướng nội một định nghĩa hàm (bao gồm các đối số và giá trị mặc định của chúng) và sử dụng nó để xây dựng trình phân tích cú pháp đối số dòng lệnh."

Vì vậy, ví dụ, định nghĩa hàm này:

def geocode(s, api_key='', geocoder='google', list_geocoders=False):

được chuyển thành văn bản trợ giúp optparse này:

    Options:
      -h, --help            show this help message and exit
      -l, --list-geocoders
      -a API_KEY, --api-key=API_KEY
      -g GEOCODER, --geocoder=GEOCODER

Tôi thích getopt từ stdlib, vd:

try:
    opts, args = getopt.getopt(sys.argv[1:], 'h', ['help'])
except getopt.GetoptError, err: 
    usage(err)

for opt, arg in opts:
    if opt in ('-h', '--help'): 
        usage()

if len(args) != 1:
    usage("specify thing...")

Gần đây tôi đã gói một cái gì đó tương tự như thế này để làm cho mọi thứ bớt dài dòng hơn (ví dụ: làm cho "-h" ẩn).

Nhấp chuột của Pocoo trực quan hơn, yêu cầu ít nồi hơi hơn và ít nhất là mạnh mẽ như argparse.

Điểm yếu duy nhất tôi gặp phải cho đến nay là bạn không thể thực hiện nhiều tùy chỉnh để trợ giúp các trang, nhưng đó thường không phải là một yêu cầu và docopt có vẻ như là sự lựa chọn rõ ràng khi có.

Như bạn có thể thấy optparse "Mô-đun optparse không được dùng nữa và sẽ không được phát triển thêm nữa, sự phát triển sẽ tiếp tục với mô-đun argparse ."

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))

Assuming the Python code above is saved into a file called prog.py
$ python prog.py -h

Ref-link: https://docs.python.org/3.3/library/argparse.html

Bạn có thể quan tâm đến một mô-đun Python nhỏ mà tôi đã viết để giúp xử lý các đối số dòng lệnh dễ dàng hơn (nguồn mở và miễn phí sử dụng) - Commando

Tôi khuyên bạn nên nhìn vào docopt như một sự thay thế đơn giản cho những người khác.

docopt là một dự án mới hoạt động bằng cách phân tích thông điệp sử dụng - trợ giúp của bạn thay vì yêu cầu bạn tự thực hiện mọi thứ. Bạn chỉ cần đặt thông điệp sử dụng của bạn ở định dạng POSIX.

Một lựa chọn khác là argh . Nó được xây dựng trên argparse và cho phép bạn viết những thứ như:

import argh

# declaring:

def echo(text):
    "Returns given word as is."
    return text

def greet(name, greeting='Hello'):
    "Greets the user with given name. The greeting is customizable."
    return greeting + ', ' + name

# assembling:

parser = argh.ArghParser()
parser.add_commands([echo, greet])

# dispatching:

if __name__ == '__main__':
    parser.dispatch()

Nó sẽ tự động tạo trợ giúp, v.v. và bạn có thể sử dụng các trình trang trí để cung cấp hướng dẫn thêm về cách hoạt động của phân tích cú pháp.

Giải pháp của tôi là entrypoint2 . Thí dụ:

from entrypoint2 import entrypoint
@entrypoint
def add(file, quiet=True): 
    ''' This function writes report.

    :param file: write report to FILE
    :param quiet: don't print status messages to stdout
    '''
    print file,quiet

văn bản trợ giúp:

usage: report.py [-h] [-q] [--debug] file

This function writes report.

positional arguments:
  file         write report to FILE

optional arguments:
  -h, --help   show this help message and exit
  -q, --quiet  don't print status messages to stdout
  --debug      set logging level to DEBUG