Як читати / обробляти аргументи командного рядка?

Я спочатку програміст C. Я бачив численні хитрощі та "хаки", щоб прочитати багато різних аргументів.

Назвіть декілька способів, як це можуть зробити програмісти Python?

Пов'язані

• Який найкращий спосіб схопити / проаналізувати аргументи командного рядка, передані сценарію Python?
• Реалізація інтерфейсів командного рядка стилю «[команда] [дія] [параметр]»?
• Як я можу обробити аргументи командного рядка в Python?
• Як я можу відформатувати позиційну аргументацію за допомогою optparse Python?

Канонічне рішення в стандартній бібліотеці: argparse( docs ):

Ось приклад:

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 підтримує (серед іншого):

• Кілька варіантів у будь-якому порядку.
• Короткі та довгі варіанти.
• Значення за замовчуванням.
• Генерування довідкового повідомлення про використання.

import sys

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

sys.argv це список, який містить усі аргументи, передані скрипту в командному рядку.

В основному,

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

Просто обхід євангелізації для аргументації, що краще з цих причин .. По суті:

(скопійовано із посилання)

• Модуль argparse може обробляти позиційні та необов'язкові аргументи, тоді як optparse може обробляти лише необов'язкові аргументи

• argparse не є догматичним щодо того, як повинен виглядати інтерфейс вашого командного рядка - такі параметри, як -file або / file, підтримуються, як і потрібні параметри. Optparse відмовляється підтримувати ці функції, віддаючи перевагу чистоті перед практичністю

• argparse створює більш інформативні повідомлення про використання, включаючи використання командного рядка, визначені з ваших аргументів, та довідкові повідомлення як для позиційних, так і для необов'язкових аргументів. Модуль optparse вимагає, щоб ви написали власний рядок використання, і не має можливості відображати довідку щодо позиційних аргументів.

• argparse підтримує дії, що споживають змінну кількість аргументів командного рядка, тоді як optparse вимагає заздалегідь знати точну кількість аргументів (наприклад, 1, 2 або 3)

• argparse підтримує парсери, які відправляють підкоманди, тоді як optparse вимагає налаштування allow_interspersed_argsта виконання розбору парсера вручну

І мій особистий фаворит:

• argparse дозволяє add_argument() визначати параметри типу та дії простими дзвінками, тоді як optparse вимагає атрибутів класів злому, як-от STORE_ACTIONSабо CHECK_METHODSдля правильної перевірки аргументів

Існує також argparseмодуль stdlib ("імпровізація" на optparseмодулі stdlib ). Приклад із вступу до 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))

Використання:

$ script.py 1 2 3 4
4

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

Один із способів зробити це - використання sys.argv. Це надрукує ім'я скрипта як перший аргумент та всі інші параметри, які ви передаєте до нього.

import sys

for arg in sys.argv:
    print arg

Бібліотека 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)

Якщо вам потрібно щось швидко і не дуже гнучко

main.py:

import sys

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

Потім бігайте python main.py James Smith

отримати наступний вихід:

Привіт, Джеймс Сміт

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

Я використовую optparse сам, але мені дуже подобається напрямок, яким займається Саймон Віллісон із його нещодавно представленою бібліотекою optfunc . Це працює:

"введення визначення визначення функції (включаючи його аргументи та їх значення за замовчуванням) та використання цього для побудови аналізатора аргументів командного рядка."

Так, наприклад, це визначення функції:

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

перетворюється на цей довідковий текст optparse:

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

Мені подобається getopt з stdlib, наприклад:

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

Останнім часом я загортаю щось подібне до цього, щоб зробити речі менш багатослівними (наприклад, робити "-h" неявними).

Pocoo в натисканні більш інтуїтивний, вимагає менше шаблонного, і, по крайней мере , як потужні , як argparse.

Єдиною слабкістю, з якою я стикався до цих пір, є те, що ви не можете зробити багато налаштувань для надання довідкових сторінок, але це, як правило, не є вимогою, і docopt здається чітким вибором, коли він є.

Як ви бачите optparse "Модуль optparse застарілий і не буде розвиватися далі; розробка триватиме з модулем 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

Можливо, вас зацікавить маленький модуль Python, який я написав, щоб зробити обробку аргументів командного рядка ще простішим (відкритий і безкоштовний у використанні) - Commando

Я рекомендую розглянути docopt як просту альтернативу цим іншим.

docopt - це новий проект, який працює, аналізуючи повідомлення про використання --help, а не вимагаючи від вас все реалізовувати самостійно. Вам просто потрібно розмістити повідомлення про використання у форматі POSIX.

Ще один варіант - argh . Він ґрунтується на аргументації та дозволяє писати такі речі:

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

Він автоматично генерує довідку тощо. Ви можете використовувати декоратори, щоб отримати додаткові вказівки щодо того, як повинен працювати аргумент.

Моє рішення - entrypoint2 . Приклад:

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

довідковий текст:

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