Question

用于解析Python命令行参数的最简单，最简洁和大多数灵活方法或库是什么？

Answer 1

其他答案确实提到argparse是新Python的方法，但不提供用法示例。为了完整起见，这里有一个如何使用argparse的简短摘要：

1）初始化

import argparse

# Instantiate the parser
parser = argparse.ArgumentParser(description='Optional app description')

2）添加参数

# Required positional argument
parser.add_argument('pos_arg', type=int,
                    help='A required integer positional argument')

# Optional positional argument
parser.add_argument('opt_pos_arg', type=int, nargs='?',
                    help='An optional integer positional argument')

# Optional argument
parser.add_argument('--opt_arg', type=int,
                    help='An optional integer argument')

# Switch
parser.add_argument('--switch', action='store_true',
                    help='A boolean switch')

3）解析

args = parser.parse_args()

4）访问

print("Argument values:")
print(args.pos_arg)
print(args.opt_pos_arg)
print(args.opt_arg)
print(args.switch)

5）检查值

if args.pos_arg > 10:
    parser.error("pos_arg cannot be larger than 10")

用法

正确使用：

$ ./app 1 2 --opt_arg 3 --switch

Argument values:
1
2
3
True

参数不正确：

$ ./app foo 2 --opt_arg 3 --switch
usage: convert [-h] [--opt_arg OPT_ARG] [--switch] pos_arg [opt_pos_arg]
app: error: argument pos_arg: invalid int value: 'foo'

$ ./app 11 2 --opt_arg 3
Argument values:
11
2
3
False
usage: app [-h] [--opt_arg OPT_ARG] [--switch] pos_arg [opt_pos_arg]
convert: error: pos_arg cannot be larger than 10

完全帮助：

$ ./app -h

usage: app [-h] [--opt_arg OPT_ARG] [--switch] pos_arg [opt_pos_arg]

Optional app description

positional arguments:
  pos_arg            A required integer positional argument
  opt_pos_arg        An optional integer positional argument

optional arguments:
  -h, --help         show this help message and exit
  --opt_arg OPT_ARG  An optional integer argument
  --switch           A boolean switch

Answer 2

这个答案表明optparse适用于较旧的Python版本。对于Python 2.7及更高版本，argparse替换optparse。有关详细信息，请参阅this answer。

正如其他人所指出的那样，你最好使用optparse而不是getopt。 getopt几乎是标准getopt（3）C库函数的一对一映射，并不是很容易使用。

optparse虽然有点冗长，但结构更好，后期更容易扩展。

以下是向解析器添加选项的典型行：

parser.add_option('-q', '--query',
            action="store", dest="query",
            help="query string", default="spam")

它几乎说明了自己;在处理时，它将接受-q或--query作为选项，将参数存储在名为query的属性中，如果不指定它，则具有默认值。它也是自我记录的，你可以使用选项声明help参数（在使用-h / - help运行时使用）。

通常用以下方法解析你的参数：

options, args = parser.parse_args()

默认情况下，这将解析传递给脚本的标准参数（sys.argv [1：]）

然后将

options.query设置为您传递给脚本的值。

只需执行

即可创建解析器

parser = optparse.OptionParser()

这些都是您需要的基础知识。这是一个完整的Python脚本，显示了这一点：

import optparse

parser = optparse.OptionParser()

parser.add_option('-q', '--query',
    action="store", dest="query",
    help="query string", default="spam")

options, args = parser.parse_args()

print 'Query string:', options.query

5行python，向您展示基础知识。

将其保存在sample.py中，然后使用

运行一次

python sample.py

和

一次

python sample.py --query myquery

除此之外，你会发现optparse非常容易扩展。在我的一个项目中，我创建了一个Command类，它允许您轻松地在命令树中嵌套子命令。它大量使用optparse将命令链接在一起。这不是我可以在几行中轻松解释的内容，但对主要课程browse around in my repository以及a class that uses it and the option parser

感到自由{{3}}

Answer 3

使用docopt

自2012年以来，Python有一个非常简单，功能强大且非常酷的模块，用于参数解析，称为docopt。它适用于Python 2.6到3.5，无需安装（只需复制）。以下是从其文档中获取的示例：

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

所以就是这样：2行代码加上必需的doc字符串，你可以在arguments对象中解析并提供你的参数。我告诉你这很酷，不是我; - ）

使用python-fire

自2017年以来，python-fire还有另一个很酷的模块，它可以为您的代码提供CLI接口，同时进行零参数解析。这是文档中的一个简单示例（这个小程序将函数double暴露给命令行）：

import fire

class Calculator(object):

  def double(self, number):
    return 2 * number

if __name__ == '__main__':
  fire.Fire(Calculator)

从命令行，您可以运行：

> calculator.py double 10
20
> calculator.py double --number=15
30

真棒不是吗？

Answer 4

由于these原因，新的髋关节方式为argparse。 argparse＆gt; optparse＆gt; getopt的

更新：从py2.7开始，argparse是标准库的一部分，optparse已被弃用。

Answer 5

我更喜欢Click。它抽象了管理选项，并允许“（...）以可组合的方式创建漂亮的命令行界面，只需要尽可能少的代码”。

以下是示例用法：

import click

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo('Hello %s!' % name)

if __name__ == '__main__':
    hello()

它还会自动生成格式良好的帮助页面：

$ python hello.py --help
Usage: hello.py [OPTIONS]

  Simple program that greets NAME for a total of COUNT times.

Options:
  --count INTEGER  Number of greetings.
  --name TEXT      The person to greet.
  --help           Show this message and exit.

Answer 6

几乎每个人都在使用getopt

以下是doc的示例代码：

import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError:
        # print help information and exit:
        usage()
        sys.exit(2)
    output = None
    verbose = False
    for o, a in opts:
        if o == "-v":
            verbose = True
        if o in ("-h", "--help"):
            usage()
            sys.exit()
        if o in ("-o", "--output"):
            output = a

总之，这就是它的工作原理。

您有两种选择。那些正在接受争论的人和那些正在接受争论的人就像开关一样。

sys.argv几乎就是你在C.中的char** argv。就像在C中一样，你跳过第一个元素，它是程序的名称，只解析参数：sys.argv[1:]

Getopt.getopt将根据您在参数中给出的规则对其进行解析。

"ho:v"这里描述了简短的论点：-ONELETTER。 :表示-o接受一个参数。

最后["help", "output="]描述了长参数（--MORETHANONELETTER）。输出后的=再次表示输出接受一个参数。

结果是一对夫妇（选项，参数）

的列表

如果某个选项不接受任何参数（例如此处为--help），则arg部分为空字符串。然后，您通常希望循环此列表并测试选项名称，如示例中所示。

我希望这对你有所帮助。

Answer 7

使用标准库附带的optparse。例如：

#!/usr/bin/env python
import optparse

def main():
  p = optparse.OptionParser()
  p.add_option('--person', '-p', default="world")
  options, arguments = p.parse_args()
  print 'Hello %s' % options.person

if __name__ == '__main__':
  main()

来源：Using Python to create UNIX command line tools

但是，不推荐使用Python 2.7 optparse，请参阅：Why use argparse rather than optparse?

Answer 8

万一你可能需要，如果你需要在Win32（2K，XP等）上抓取 unicode参数，这可能会有所帮助：


from ctypes import *

def wmain(argc, argv):
    print argc
    for i in argv:
        print i
    return 0

def startup():
    size = c_int()
    ptr = windll.shell32.CommandLineToArgvW(windll.kernel32.GetCommandLineW(), byref(size))
    ref = c_wchar_p * size.value
    raw = ref.from_address(ptr)
    args = [arg for arg in raw]
    windll.kernel32.LocalFree(ptr)
    exit(wmain(len(args), args))
startup()

Answer 9

轻量级命令行参数默认

尽管argparse非常好，并且是完全记录的命令行开关和高级功能的正确答案，但您可以使用函数参数默认值来非常简单地处理直接的位置参数。

import sys

def get_args(name='default', first='a', second=2):
    return first, int(second)

first, second = get_args(*sys.argv)
print first, second

＆＃39;名称＆＃39;参数捕获脚本名称，不使用。测试输出如下所示：

> ./test.py
a 2
> ./test.py A
A 2
> ./test.py A 20
A 20

对于我只想要一些默认值的简单脚本，我发现这已经足够了。您可能还希望在返回值中包含一些类型强制，或者命令行值都将是字符串。

Answer 10

我认为大型项目的最佳方式是optparse，但如果您正在寻找一种简单的方法，那么http://werkzeug.pocoo.org/documentation/script可能适合您。

from werkzeug import script

# actions go here
def action_foo(name=""):
    """action foo does foo"""
    pass

def action_bar(id=0, title="default title"):
    """action bar does bar"""
    pass

if __name__ == '__main__':
    script.run()

所以基本上每个函数action_ *都暴露在命令行中并且很好帮助消息是免费生成的。

python foo.py 
usage: foo.py <action> [<options>]
       foo.py --help

actions:
  bar:
    action bar does bar

    --id                          integer   0
    --title                       string    default title

  foo:
    action foo does foo

    --name                        string

Answer 11

我更喜欢optparse到getopt。这是非常具有说服力的：你告诉它选项的名称和它们应该具有的效果（例如，设置一个布尔字段），并且它会根据你的规范提供给你的字典。

http://docs.python.org/lib/module-optparse.html

Answer 12

consoleargs值得在此提及。这是非常容易使用。看看：

from consoleargs import command

@command
def main(url, name=None):
  """
  :param url: Remote URL 
  :param name: File name
  """
  print """Downloading url '%r' into file '%r'""" % (url, name)

if __name__ == '__main__':
  main()

现在在控制台中：

% python demo.py --help
Usage: demo.py URL [OPTIONS]

URL:    Remote URL 

Options:
    --name -n   File name

% python demo.py http://www.google.com/
Downloading url ''http://www.google.com/'' into file 'None'

% python demo.py http://www.google.com/ --name=index.html
Downloading url ''http://www.google.com/'' into file ''index.html''

Answer 13

Argparse代码可能比实际的实现代码长！

我发现最流行的参数解析选项存在一个问题，就是如果您的参数仅适中，那么记录它们的代码就变得不成比例地增大了它们提供的好处。

自变量解析场景（我认为）相对较新，是plac。

它与argparse进行了一些公认的权衡，但是使用了内联文档，并且只包装了main()类型的函数：

def main(excel_file_path: "Path to input training file.",
     excel_sheet_name:"Name of the excel sheet containing training data including columns 'Label' and 'Description'.",
     existing_model_path: "Path to an existing model to refine."=None,
     batch_size_start: "The smallest size of any minibatch."=10.,
     batch_size_stop:  "The largest size of any minibatch."=250.,
     batch_size_step:  "The step for increase in minibatch size."=1.002,
     batch_test_steps: "Flag.  If True, show minibatch steps."=False):
"Train a Spacy (http://spacy.io/) text classification model with gold document and label data until the model nears convergence (LOSS < 0.5)."

    pass # Implementation code goes here!

if __name__ == '__main__':
    import plac; plac.call(main)

Answer 14

这是一个方法，而不是一个库，它似乎对我有用。

这里的目标是简洁，每个参数由一行解析，args排列为可读性，代码很简单，不依赖于任何特殊模块（只有os + sys），警告缺少或优雅的未知参数，使用简单的for / range（）循环，并在python 2.x和3.x

中工作

显示了两个切换标志（-d，-v），以及两个由参数控制的值（-i xxx和-o xxx）。

import os,sys

def HelpAndExit():
    print("<<your help output goes here>>")
    sys.exit(1)

def Fatal(msg):
    sys.stderr.write("%s: %s\n" % (os.path.basename(sys.argv[0]), msg))
    sys.exit(1)

def NextArg(i):
    '''Return the next command line argument (if there is one)'''
    if ((i+1) >= len(sys.argv)):
        Fatal("'%s' expected an argument" % sys.argv[i])
    return(1, sys.argv[i+1])

### MAIN
if __name__=='__main__':

    verbose = 0
    debug   = 0
    infile  = "infile"
    outfile = "outfile"

    # Parse command line
    skip = 0
    for i in range(1, len(sys.argv)):
        if not skip:
            if   sys.argv[i][:2] == "-d": debug ^= 1
            elif sys.argv[i][:2] == "-v": verbose ^= 1
            elif sys.argv[i][:2] == "-i": (skip,infile)  = NextArg(i)
            elif sys.argv[i][:2] == "-o": (skip,outfile) = NextArg(i)
            elif sys.argv[i][:2] == "-h": HelpAndExit()
            elif sys.argv[i][:1] == "-":  Fatal("'%s' unknown argument" % sys.argv[i])
            else:                         Fatal("'%s' unexpected" % sys.argv[i])
        else: skip = 0

    print("%d,%d,%s,%s" % (debug,verbose,infile,outfile))

NextArg（）的目标是在检查缺失数据时返回下一个参数，并且当使用NextArg（）时，'skip'跳过循环，保持标记解析为一个衬里。

Answer 15

我扩展了Erco的方法，以允许使用必需的位置参数和可选参数。这些参数应该在-d，-v等参数之前。

可以分别使用PosArg（i）和OptArg（i，默认值）检索位置参数和可选参数。找到可选参数后，搜索选项（例如-i）的开始位置会向前移动1，以避免造成“意外”的致命事故。

import os,sys


def HelpAndExit():
    print("<<your help output goes here>>")
    sys.exit(1)

def Fatal(msg):
    sys.stderr.write("%s: %s\n" % (os.path.basename(sys.argv[0]), msg))
    sys.exit(1)

def NextArg(i):
    '''Return the next command line argument (if there is one)'''
    if ((i+1) >= len(sys.argv)):
        Fatal("'%s' expected an argument" % sys.argv[i])
    return(1, sys.argv[i+1])

def PosArg(i):
    '''Return positional argument'''
    if i >= len(sys.argv):
        Fatal("'%s' expected an argument" % sys.argv[i])
    return sys.argv[i]

def OptArg(i, default):
    '''Return optional argument (if there is one)'''
    if i >= len(sys.argv):
        Fatal("'%s' expected an argument" % sys.argv[i])
    if sys.argv[i][:1] != '-':
        return True, sys.argv[i]
    else:
        return False, default


### MAIN
if __name__=='__main__':

    verbose = 0
    debug   = 0
    infile  = "infile"
    outfile = "outfile"
    options_start = 3

    # --- Parse two positional parameters ---
    n1 = int(PosArg(1))
    n2 = int(PosArg(2))

    # --- Parse an optional parameters ---
    present, a3 = OptArg(3,50)
    n3 = int(a3)
    options_start += int(present)

    # --- Parse rest of command line ---
    skip = 0
    for i in range(options_start, len(sys.argv)):
        if not skip:
            if   sys.argv[i][:2] == "-d": debug ^= 1
            elif sys.argv[i][:2] == "-v": verbose ^= 1
            elif sys.argv[i][:2] == "-i": (skip,infile)  = NextArg(i)
            elif sys.argv[i][:2] == "-o": (skip,outfile) = NextArg(i)
            elif sys.argv[i][:2] == "-h": HelpAndExit()
            elif sys.argv[i][:1] == "-":  Fatal("'%s' unknown argument" % sys.argv[i])
            else:                         Fatal("'%s' unexpected" % sys.argv[i])
        else: skip = 0

    print("Number 1 = %d" % n1)
    print("Number 2 = %d" % n2)
    print("Number 3 = %d" % n3)
    print("Debug    = %d" % debug)
    print("verbose  = %d" % verbose)
    print("infile   = %s" % infile)
    print("outfile  = %s" % outfile)

解析命令行参数的最佳方法是什么？

15 个答案:

用法

使用docopt

使用python-fire