Python中的参数解析(必需与可选)

时间:2014-07-18 20:13:01

标签: python parsing optparse

我目前正在开发一个能够获取多个标志的脚本。我想要它,以便无论最后一个参数应该是'start | stop | status'。

#!/usr/bin/env python

from argparse import ArgumentParser


def argument_analysis():
    """
This will analyze arguments, and return the region as a string, the filter as a dictionary, and the command as a string.
    :return: region,filters,command
    """
    parser_options = ArgumentParser()
    parser_options.add_argument("-r", "--region", dest='region',
                                help="Filter by region.")
    parser_options.add_argument("-n", "--name", dest='name',
                                help="Filter by hostname.")
    parser_options.add_argument("-P", "--project", dest='project',
                                help="Filter by Project tag.")
    parser_options.add_argument("-U", "--usage", dest='usage',
                                help="Filter by Usage tag.")
    parser_options.add_argument("-i", "--instance_id", dest='instance_id',
                                help="Filter by instance_id.")
    parser_options.add_argument("-t", "--type", dest='type',
                                help="Filter by instance_size.")
    parser_options.add_argument("-p", "--ip", dest='internal_ip',
                                help="Filter by internal_ip")
    parser_options.add_argument("-c", "--command", dest='command',
                                help="stop/start, or check the status of instances.")
    parser_options.add_argument("-a", "--all", dest='all', default=False, action='store_true',
                                help="No filter, display status of all servers.")
    arguments = vars(parser_options.parse_args())
    return arguments


if __name__ == '__main__':
    print argument_analysis()

我想要它,以便./argument_analysis_script.py最后需要'stop | start | status'。我没有太多运气获得ARgumentParser()的帮助。如果有人有任何建议,那将非常有帮助。

提前感谢您的时间。

注意:如果没有输入[stop | start | restart | status],我希望脚本停止,并说明需要[stop | start | restart | status]。

**更新** **更新** **更新**

在进行了一些挖掘之后,为了能够分析/使用命令行选项和参数,我偶然发现了OptionParser,我避免了docs.python.org声明它是deprecated。无论如何,因为这是我能找到的唯一能给我我想要的东西,这里是我所得到的更新:

#!/usr/bin/env python

from optparse import OptionParser


def argument_analysis():
    """
This will analyze arguments, and return the region as a string, the filter as a dictionary, and the command as a string.
    :return: region,filters,command
    """
    parser = OptionParser()
    parser.add_option("-r", "--region", dest='region',
                      help="Filter by region.")
    parser.add_option("-n", "--name", dest='name',
                      help="Filter by hostname.")
    parser.add_option("-P", "--project", dest='project',
                      help="Filter by Project tag.")
    parser.add_option("-U", "--usage", dest='usage',
                      help="Filter by Usage tag.")
    parser.add_option("-i", "--instance_id", dest='instance_id',
                      help="Filter by instance_id.")
    parser.add_option("-t", "--type", dest='type',
                      help="Filter by instance_size.")
    parser.add_option("-p", "--ip", dest='internal_ip',
                      help="Filter by internal_ip")
    parser.add_option("-c", "--command", dest='command',
                      help="stop/start, or check the status of instances.")
    parser.add_option("-a", "--all", dest='all', default=False, action='store_true',
                      help="No filter, display status of all servers.")
    (options, args) = parser.parse_args()  # Grab Options specifed from above, as well as actual Arguments.

    options = vars(options)  # Convert 'options' into dictionary: key=dest_name, value=dest_value

    # Getting variables for dictionary below.
    region_filter = options['region']
    name_filter = options['name']
    project_filter = options['project']
    usage_filter = options['usage']
    instance_filter = options['instance_id']
    type_filter = options['type']
    ip_filter = options['internal_ip']
    all_filter = options['all']

    region = region_filter if region_filter else 'us-east-1' # Return 'us-east-1' region is not specified.

    filters = {'tag:Name': name_filter, 'tag:Project': project_filter, 'tag:Usage': usage_filter,
               'instance-id': instance_filter, 'instance_type': type_filter, 'private-ip-address': ip_filter,
               'all': all_filter}

    command = 'No commands.' if not args else args  #Return "No commands" if no command is specified.

    return region, filters, command


if __name__ == '__main__':
    opts_and_args = argument_analysis()
    print "Region: " + str(opts_and_args[0])
    print "Filters: " + str(opts_and_args[1])
    print "Command: " + str(opts_and_args[2])

如您所见,您可以根据返回的对象或定义应用您想要的任何逻辑。感谢大家对此的帮助。

3 个答案:

答案 0 :(得分:3)

也许您可以使用argparse执行此操作,但另一种选择是使用sys模块

import sys
print sys.argv # prints command line arguments

sys.argv在列表中有命令行参数,因此您可以检查最后一个:

if sys.argv[-1] != 'start':
    print "Error, expected <something>"
    // quit

答案 1 :(得分:1)

与Ben的答案部分相同,但使用regex扩展以避免为每个案例声明if语句,例如: startstop

import sys
import re

a = sys.argv[-1]

if not re.search(r"^(start|stop|restart|status)$", a):
    raise Exception("start, stop, restart or status should be passed to this script instead of: \""+a+"\"")

答案 2 :(得分:0)

我建议您查看docopt。它不在标准库中,但它绝对更强大和直观。例如,在您的情况下,您可以这样做:

docstring='''My Program.

Usage: my_prog [options] (flag1|flag2|flag3) (start|stop|restart|status)

Options:
  -a  stuff about this
  -b  more stuff
  -c  yet more stuff
  -d  finally stuff'''

from docopt import docopt
parsed = docopt(docstring)