python处理命令行参数
时间：2010-07-18 来源：lane0012
Python 有两个内建的模块用于处理命令行参数，一个是getopt，《Deep inpython》一书中也有提到，只能简单处理命令行参数；另一个是 optparse，它功能强大，而且易于使用，可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。
下面是一个使用 optparse 的简单示例：
from optparse import OptionParser
[...]
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose", default=True, help="don't print status messages to stdout")
(options, args) = parser.parse_args() 现在，妳就可以在命令行下输入： <yourscript> --file=outfile -q
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile 上面这些命令是相同效果的。除此之外， optparse 还为我们自动生成命令行的帮助信息： <yourscript> -h
<yourscript> --help 输出： usage: <yourscript> [options]
options:
-h, --help show this help message and exit
-f FILE, --file=FILE write report to FILE
-q, --quiet don't print status messages to stdout 简单流程 首先，必须 import OptionParser 类，创建一个 OptionParser 对象： from optparse import OptionParser
[...]
parser = OptionParser() 然后，使用 add_option 来定义命令行参数： parser.add_option(opt_str, ...,
attr=value, ...) 每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名： parser.add_option("-f", "--file", ...) 注： 你也可以传递一个命令行参数列表到 parse_args()；否则，默认使用 sys.argv[:1]。 parse_args() 返回的两个值： options，它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 file，就可以访问其对应的值： options.file 。
args，它是一个由 positional arguments 组成的列表。 Actions action 是 parse_args() 方法的参数之一，它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择，默认是’store‘，表示将命令行参数值保存在 options 对象里。 示例 parser.add_option("-f", "--file",
action="store", type="string", dest="filename")
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
print options.filename 最后将会打印出 “foo.txt”。 当 optparse 解析到’-f’，会继续解析后面的’foo.txt’，然后将’foo.txt’保存到 options.filename 里。当调用 parser.args() 后，options.filename 的值就为’foo.txt’。 你也可以指定 add_option() 方法中 type 参数为其它值，如 int 或者 float 等等： parser.add_option("-n", type="int", dest="num") 默认地，type 为’string’。也正如上面所示，长参数名也是可选的。其实，dest 参数也是可选的。如果没有指定 dest 参数，将用命令行的参数名来对 options 对象的值进行存取。 store 也有其它的两种形式： store_true 和 store_false，用于处理带命令行参数后面不带值的情况。如 -v,-q 等命令行参数： parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose") 这样的话，当解析到 ‘-v’，options.verbose 将被赋予 True 值，反之，解析到 ‘-q’，会被赋予 False 值。 其它的 actions 值还有： store_const、append、count、callback。 默认值 parse_args() 方法提供了一个 default 参数用于设置默认值。如： parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")parser.add_option("-v", action="store_true", dest="verbose", default=True) 又或者使用 set_defaults()： parser.set_defaults(filename="foo.txt",verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args() 生成程序帮助 optparse 另一个方便的功能是自动生成程序的帮助信息。你只需要为 add_option() 方法的 help 参数指定帮助信息文本： usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
action="store_true", dest="verbose", default=True, help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose",
help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
metavar="FILE", help="write output to FILE"),
parser.add_option("-m", "--mode", default="intermediate",
help="interaction mode: novice, intermediate, " "or expert [default: %default]") 当 optparse 解析到 -h 或者 –help 命令行参数时，会调用 parser.print_help() 打印程序的帮助信息： usage: <yourscript> [options] arg1 arg2
options:
-h, --help show this help message and exit
-v, --verbose make lots of noise [default]
-q, --quiet be vewwy quiet (I'm hunting wabbits)
-f FILE, --filename=FILE
write output to FILE
-m MODE, --mode=MODE
interaction mode: novice, intermediate, or expert [default: intermediate] 注意： 打印出帮助信息后，optparse 将会退出，不再解析其它的命令行参数。 以上面的例子来一步步解释如何生成帮助信息： 自定义的程序使用方法信息（usage message）： usage = "usage: %prog [options] arg1 arg2" 这行信息会优先打印在程序的选项信息前。当中的 %prog，optparse 会以当前程序名的字符串来替代：如 os.path.basename.(sys.argv[0])。 如果用户没有提供自定义的使用方法信息，optparse 会默认使用： “usage: %prog [options]”。 用户在定义命令行参数的帮助信息时，不用担心换行带来的问题，optparse 会处理好这一切。 设置 add_option 方法中的 metavar 参数，有助于提醒用户，该命令行参数所期待的参数，如 metavar=“mode”： -m MODE, --mode=MODE 注意： metavar 参数中的字符串会自动变为大写。 在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。 如果程序有很多的命令行参数，你可能想为他们进行分组，这时可以使用 OptonGroup： group = OptionGroup(parser, ``Dangerous Options'',
``Caution: use these options at your own risk. ``
``It is believed that some of them bite.'')
group.add_option(``-g'', action=''store_true'', help=''Group option.'')parser.add_option_group(group) 下面是将会打印出来的帮助信息： usage: [options] arg1 arg2
options:
-h, --help show this help message and exit
-v, --verbose make lots of noise [default]
-q, --quiet be vewwy quiet (I'm hunting wabbits)
-fFILE, --file=FILE write output to FILE
-mMODE, --mode=MODE interaction mode: one of 'novice', 'intermediate'
[default], 'expert'
Dangerous Options:
Caution: use of these options is at your own risk. It is believed that
some of them bite.
-g Group option.
[...]
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose", default=True, help="don't print status messages to stdout")
(options, args) = parser.parse_args() 现在，妳就可以在命令行下输入： <yourscript> --file=outfile -q
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile 上面这些命令是相同效果的。除此之外， optparse 还为我们自动生成命令行的帮助信息： <yourscript> -h
<yourscript> --help 输出： usage: <yourscript> [options]
options:
-h, --help show this help message and exit
-f FILE, --file=FILE write report to FILE
-q, --quiet don't print status messages to stdout 简单流程 首先，必须 import OptionParser 类，创建一个 OptionParser 对象： from optparse import OptionParser
[...]
parser = OptionParser() 然后，使用 add_option 来定义命令行参数： parser.add_option(opt_str, ...,
attr=value, ...) 每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名： parser.add_option("-f", "--file", ...) 注： 你也可以传递一个命令行参数列表到 parse_args()；否则，默认使用 sys.argv[:1]。 parse_args() 返回的两个值： options，它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 file，就可以访问其对应的值： options.file 。
args，它是一个由 positional arguments 组成的列表。 Actions action 是 parse_args() 方法的参数之一，它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择，默认是’store‘，表示将命令行参数值保存在 options 对象里。 示例 parser.add_option("-f", "--file",
action="store", type="string", dest="filename")
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
print options.filename 最后将会打印出 “foo.txt”。 当 optparse 解析到’-f’，会继续解析后面的’foo.txt’，然后将’foo.txt’保存到 options.filename 里。当调用 parser.args() 后，options.filename 的值就为’foo.txt’。 你也可以指定 add_option() 方法中 type 参数为其它值，如 int 或者 float 等等： parser.add_option("-n", type="int", dest="num") 默认地，type 为’string’。也正如上面所示，长参数名也是可选的。其实，dest 参数也是可选的。如果没有指定 dest 参数，将用命令行的参数名来对 options 对象的值进行存取。 store 也有其它的两种形式： store_true 和 store_false，用于处理带命令行参数后面不带值的情况。如 -v,-q 等命令行参数： parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose") 这样的话，当解析到 ‘-v’，options.verbose 将被赋予 True 值，反之，解析到 ‘-q’，会被赋予 False 值。 其它的 actions 值还有： store_const、append、count、callback。 默认值 parse_args() 方法提供了一个 default 参数用于设置默认值。如： parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")parser.add_option("-v", action="store_true", dest="verbose", default=True) 又或者使用 set_defaults()： parser.set_defaults(filename="foo.txt",verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args() 生成程序帮助 optparse 另一个方便的功能是自动生成程序的帮助信息。你只需要为 add_option() 方法的 help 参数指定帮助信息文本： usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
action="store_true", dest="verbose", default=True, help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose",
help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
metavar="FILE", help="write output to FILE"),
parser.add_option("-m", "--mode", default="intermediate",
help="interaction mode: novice, intermediate, " "or expert [default: %default]") 当 optparse 解析到 -h 或者 –help 命令行参数时，会调用 parser.print_help() 打印程序的帮助信息： usage: <yourscript> [options] arg1 arg2
options:
-h, --help show this help message and exit
-v, --verbose make lots of noise [default]
-q, --quiet be vewwy quiet (I'm hunting wabbits)
-f FILE, --filename=FILE
write output to FILE
-m MODE, --mode=MODE
interaction mode: novice, intermediate, or expert [default: intermediate] 注意： 打印出帮助信息后，optparse 将会退出，不再解析其它的命令行参数。 以上面的例子来一步步解释如何生成帮助信息： 自定义的程序使用方法信息（usage message）： usage = "usage: %prog [options] arg1 arg2" 这行信息会优先打印在程序的选项信息前。当中的 %prog，optparse 会以当前程序名的字符串来替代：如 os.path.basename.(sys.argv[0])。 如果用户没有提供自定义的使用方法信息，optparse 会默认使用： “usage: %prog [options]”。 用户在定义命令行参数的帮助信息时，不用担心换行带来的问题，optparse 会处理好这一切。 设置 add_option 方法中的 metavar 参数，有助于提醒用户，该命令行参数所期待的参数，如 metavar=“mode”： -m MODE, --mode=MODE 注意： metavar 参数中的字符串会自动变为大写。 在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。 如果程序有很多的命令行参数，你可能想为他们进行分组，这时可以使用 OptonGroup： group = OptionGroup(parser, ``Dangerous Options'',
``Caution: use these options at your own risk. ``
``It is believed that some of them bite.'')
group.add_option(``-g'', action=''store_true'', help=''Group option.'')parser.add_option_group(group) 下面是将会打印出来的帮助信息： usage: [options] arg1 arg2
options:
-h, --help show this help message and exit
-v, --verbose make lots of noise [default]
-q, --quiet be vewwy quiet (I'm hunting wabbits)
-fFILE, --file=FILE write output to FILE
-mMODE, --mode=MODE interaction mode: one of 'novice', 'intermediate'
[default], 'expert'
Dangerous Options:
Caution: use of these options is at your own risk. It is believed that
some of them bite.
-g Group option.
相关阅读 更多 +
