Bagaimana cara membaca / memproses argumen baris perintah?

Saya awalnya seorang programmer C. Saya telah melihat banyak trik dan "retasan" untuk membaca berbagai argumen.

Apa sajakah cara programmer Python dapat melakukan ini?

Terkait

• Apa cara terbaik untuk mengambil / menguraikan argumen baris perintah yang diteruskan ke skrip Python?
• Menerapkan antarmuka baris perintah gaya "[command] [action] [parameter]"?
• Bagaimana saya bisa memproses argumen baris perintah dengan Python?
• Bagaimana cara memformat argumen posisi membantu menggunakan optparse Python?

Solusi kanonik di perpustakaan standar adalah argparse( dokumen ):

Berikut ini sebuah contoh:

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 mendukung (antara lain):

• Banyak pilihan dalam urutan apa pun.
• Opsi pendek dan panjang.
• Nilai dasar.
• Pembuatan pesan bantuan penggunaan.

import sys

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

sys.argv adalah daftar yang berisi semua argumen yang diteruskan ke skrip pada baris perintah.

Pada dasarnya,

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

Hanya berkeliling evangelisasi untuk argparse yang lebih baik karena alasan ini .. pada dasarnya:

(disalin dari tautan)

• modul argparse dapat menangani argumen posisi dan opsional, sementara optparse hanya dapat menangani argumen opsional

• argparse tidak dogmatis tentang tampilan antarmuka baris perintah Anda - opsi seperti -file atau / file didukung, seperti opsi yang diperlukan. Optparse menolak untuk mendukung fitur-fitur ini, lebih memilih kemurnian daripada kepraktisan

• argparse menghasilkan pesan penggunaan yang lebih informatif, termasuk penggunaan baris perintah yang ditentukan dari argumen Anda, dan pesan bantuan untuk argumen posisional dan opsional. Modul optparse mengharuskan Anda untuk menulis string penggunaan Anda sendiri, dan tidak memiliki cara untuk menampilkan bantuan untuk argumen posisi.

• argparse mendukung tindakan yang menggunakan sejumlah variabel argumen baris perintah, sementara optparse mengharuskan jumlah argumen yang tepat (misalnya 1, 2, atau 3) diketahui terlebih dahulu

• argparse mendukung parser yang mengirim ke sub-perintah, sedangkan optparse memerlukan pengaturan allow_interspersed_argsdan melakukan pengiriman parser secara manual

Dan favorit pribadi saya:

• argparse memungkinkan jenis dan parameter tindakan untuk add_argument() ditentukan dengan callable sederhana, sementara optparse membutuhkan atribut kelas peretasan seperti STORE_ACTIONSatau CHECK_METHODSuntuk mendapatkan pemeriksaan argumen

Ada juga argparsemodul stdlib ("perbaikan" pada optparsemodul stdlib ). Contoh dari pengantar 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))

Pemakaian:

$ script.py 1 2 3 4
4

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

Salah satu cara untuk melakukannya adalah menggunakan sys.argv. Ini akan mencetak nama skrip sebagai argumen pertama dan semua parameter lain yang Anda berikan.

import sys

for arg in sys.argv:
    print arg

The docopt perpustakaan benar-benar licin. Itu membangun dict argumen dari string penggunaan untuk aplikasi Anda.

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

Jika Anda membutuhkan sesuatu yang cepat dan tidak terlalu fleksibel

main.py:

import sys

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

Lalu lari python main.py James Smith

untuk menghasilkan output berikut:

Halo James Smith

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

Saya menggunakan optparse sendiri, tetapi sangat suka arah yang diambil Simon Willison dengan perpustakaan optfunc yang baru diperkenalkannya . Ini bekerja dengan:

+ msgstr "mengintrospeksi definisi fungsi (termasuk argumennya dan nilai defaultnya) dan menggunakannya untuk membuat parser argumen baris perintah."

Jadi, misalnya, definisi fungsi ini:

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

diubah menjadi teks bantuan optparse ini:

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

Saya suka getopt dari stdlib, mis:

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

Akhir-akhir ini saya telah membungkus sesuatu yang serupa dengan ini untuk membuat hal-hal yang kurang verbose (misalnya; membuat "-h" tersirat).

Pocoo ini klik lebih intuitif, memerlukan lebih sedikit boilerplate, dan setidaknya sekuat argparse.

Satu-satunya kelemahan yang saya temui sejauh ini adalah bahwa Anda tidak dapat melakukan banyak penyesuaian untuk membantu halaman, tetapi itu biasanya bukan keharusan dan mendiagnosis tampaknya merupakan pilihan yang jelas ketika itu.

Seperti yang Anda lihat di optparse "Modul optparse tidak digunakan lagi dan tidak akan dikembangkan lebih lanjut; pengembangan akan dilanjutkan dengan modul 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

Anda mungkin tertarik pada modul Python kecil yang saya tulis untuk membuat penanganan argumen baris perintah menjadi lebih mudah (open source dan bebas digunakan) - Commando

Saya sarankan melihat docopt sebagai alternatif sederhana untuk yang lain ini.

docopt adalah proyek baru yang bekerja dengan mem-parsing pesan penggunaan --help Anda daripada mengharuskan Anda untuk mengimplementasikan semuanya sendiri. Anda hanya perlu meletakkan pesan penggunaan Anda dalam format POSIX.

Namun pilihan lain adalah argh . Itu dibangun berdasarkan argparse, dan memungkinkan Anda menulis hal-hal seperti:

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

Ini akan secara otomatis menghasilkan bantuan dan sebagainya, dan Anda dapat menggunakan dekorator untuk memberikan panduan tambahan tentang bagaimana arg-parsing seharusnya bekerja.

Solusi saya adalah entrypoint2 . Contoh:

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

teks bantuan:

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