Komut satırı argümanları nasıl okunur / işlenir?

Aslen bir C programcısıyım. Birçok farklı argüman okumak için çok sayıda hile ve "hack" gördüm.

Python programcılarının bunu yapmasının bazı yolları nelerdir?

İlişkili

• Python betiğine geçirilen komut satırı bağımsız değişkenlerini yakalamanın / ayrıştırmanın en iyi yolu nedir?
• “[Komut] [eylem] [parametre]” tarzı komut satırı arabirimleri mi uyguluyorsunuz?
• Python'da komut satırı bağımsız değişkenlerini nasıl işleyebilirim?
• Konum bağımsız değişken yardımını Python'un tercihini kullanarak nasıl biçimlendiririm?

Standart kütüphanedeki standart çözüm argparse( dokümanlar ):

İşte bir örnek:

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 destekler (diğer şeylerin yanı sıra):

• Herhangi bir sırayla çoklu seçenekler.
• Kısa ve uzun seçenekler.
• Varsayılan değerler.
• Bir kullanım yardım mesajı oluşturulması.

import sys

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

sys.argv komut satırında komut dosyasına iletilen tüm bağımsız değişkenleri içeren bir listedir.

Temel olarak,

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

Sadece bu nedenlerle daha iyi olan argparse için evangelize etmek.

(bağlantıdan kopyalandı)

• argparse modülü konumsal ve isteğe bağlı bağımsız değişkenleri işlerken optparse yalnızca isteğe bağlı bağımsız değişkenleri işleyebilir

• argparse, komut satırı arayüzünüzün nasıl görünmesi gerektiği konusunda dogmatik değildir - gerekli seçenekler gibi -file veya / file gibi seçenekler desteklenir. Optparse, pratiklik yerine saflığı tercih ederek bu özellikleri desteklemeyi reddediyor

• argparse, bağımsız değişkenlerinizden belirlenen komut satırı kullanımı ve hem konumsal hem de isteğe bağlı bağımsız değişkenler için yardım iletileri de dahil olmak üzere daha bilgilendirici kullanım iletileri üretir. Optparse modülü, kendi kullanım dizenizi yazmanızı gerektirir ve konumsal bağımsız değişkenler için yardımı görüntülemenin bir yolu yoktur.

• argparse, değişken sayıda komut satırı argümanı tüketen eylemi destekler, optparse ise tam bağımsız değişken sayısının (örn. 1, 2 veya 3) önceden bilinmesini gerektirir

• argparse, alt komutlara gönderilen ayrıştırıcıları destekler; optparse allow_interspersed_argsise ayrıştırıcı dağıtımını manuel olarak ayarlamayı ve yapmayı gerektirir

Ve benim kişisel favorim:

• argparse, tür ve eylem parametrelerinin add_argument() basit callables ile belirtilmesine izin verirken, optparse gibi sınıf özniteliklerini hacklemek STORE_ACTIONSveya CHECK_METHODSuygun bağımsız değişken denetimi almak için

Ayrıca argparsestdlib modülü de vardır ( stdlib modülünde bir "gelişme" optparse). Örnek giriş argparse için :

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

Kullanımı:

$ script.py 1 2 3 4
4

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

Bunu yapmanın bir yolu kullanmaktır sys.argv. Bu, komut dosyası adını ilk bağımsız değişken ve ona ilettiğiniz tüm diğer parametreler olarak yazdırır.

import sys

for arg in sys.argv:
    print arg

Docopt kütüphanesi gerçekten kaygan. Uygulamanızın kullanım dizesinden bir bağımsız değişken diktesi oluşturur.

Örneğin, docopt benioku dosyasından:

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

Hızlı ve çok esnek olmayan bir şeye ihtiyacınız varsa

main.py:

import sys

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

O zaman koş python main.py James Smith

Aşağıdaki çıktıyı üretmek için:

Merhaba James Smith

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

Kendimi optparse kullanıyorum, ama Simon Willison'un yakın zamanda tanıttığı optfunc kütüphanesinde izlediği yön gibi . Şununla çalışır:

"bir işlev tanımının (argümanları ve varsayılan değerleri dahil) introspeksiyon ve bunu komut satırı bağımsız değişken ayrıştırıcısı oluşturmak için kullanma."

Örneğin, bu işlev tanımı:

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

bu optparse yardım metnine dönüştürülür:

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

Ben stdlib gelen getopt gibi, örneğin:

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

Son zamanlarda, işleri daha az ayrıntılı yapmak için buna benzer bir şey sarıyorum (örneğin, "-h" örtük yapmak).

Pocoo'nun tıklaması daha sezgisel, daha az kaynatma plakası gerektiriyor ve en azından argparse kadar güçlü.

Şimdiye kadar karşılaştığım tek zayıf nokta, sayfalara yardım etmek için fazla özelleştirme yapamamanız, ancak bu genellikle bir gereklilik değildir ve docopt , açık bir seçim gibi görünüyor.

Gördüğünüz gibi optparse "Optparse modülü kullanımdan kaldırılmıştır ve daha fazla geliştirilmeyecektir; geliştirme, argparse modülüyle devam edecektir ."

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

Komut satırı argümanlarının işlenmesini daha da kolaylaştırmak için yazdığım küçük bir Python modülüyle ilgilenebilirsiniz (açık kaynak ve kullanımı ücretsiz) - Commando

Ben bakmanızı öneririz docopt bu başkalarına basit bir alternatif olarak.

docopt, her şeyi kendiniz uygulamanızı gerektirmek yerine --help kullanım mesajınızı ayrıştırarak çalışan yeni bir projedir. Kullanım mesajınızı POSIX biçiminde koymanız yeterlidir.

Yine başka bir seçenek argh . Argparse üzerine kuruludur ve aşağıdaki gibi şeyler yazmanıza izin verir:

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

Otomatik olarak yardım vb. Üretecektir ve arg-ayrıştırma işleminin nasıl çalışması gerektiği konusunda ek rehberlik sağlamak için dekoratörleri kullanabilirsiniz.

Benim çözümüm giriş noktası2 . Misal:

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

Yardım Metni:

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