使用一些可选的参数运行python脚本

Question

我已经阅读了sys文档,但有些内容仍然不清楚.我在stackoverflow上寻找了一些类似的问题,但我没有找到任何有用的东西(显然任何引用都很感激!).

我想创建一个脚本 - 比如说foo.py- 我希望从3到6个参数传递:

$ python foo.py arg1 arg2 arg3

在任何情况下都必须给出前3个论点; 如果没有传递任何内容,则在具有默认参数值的函数中使用最后3个参数.

问题是我该怎么做？到目前为止,我正在考虑编写类似下面的内容foo.py(这是一个简单的示例集,仅用于具体支持我的问题):

import sys

def example(credit_mom, credit_dad, debt_mom, debt_dad = 1000,
            salary = 2000, bonus = 0):
    total_gain = salary + credit_dad + credit_mom + bonus
    total_loss = debt_dad + debt_mom

    return total_gain - total_loss

if __name__ == '__main__':
    if len(sys.argv) < 4:
        sys.exit('Need at least 3 arguments. The order is as follows:\n\
            1.credit_mom;\n\
            2.credit_dad;\n\
            3.debt_mom;\n\
            4.others')
    else:
        sys.exit(example(sys.argv[1],
                         sys.argv[2],
                         sys.argv[3],
                         sys.argv[4],
                         sys.argv[5],
                         sys.argv[6]))

如果我运行这个脚本,我明显得到一个IndexError例外:

$ python foo.py 110 110 220
Traceback (most recent call last):
  File "foo.py", line 19, in <module>
    sys.argv[4],
IndexError: list index out of range

Answer 1

使用Argparse

我建议你使用argparse(这里是教程).节省您必须手动检查参数的存在.此外,argparse为您提供了--help作为免费赠品的参数,它将读取help=""为每个参数定义的字符串(如果提供).

示例程序

在您的情况下,您有三个强制(位置)参数和三个可选参数.示例argparse代码如下所示:

#!/usr/bin/python
# coding: utf-8

import argparse

def parseArguments():
    # Create argument parser
    parser = argparse.ArgumentParser()

    # Positional mandatory arguments
    parser.add_argument("creditMom", help="Credit mom.", type=float)
    parser.add_argument("creditDad", help="Credit dad.", type=float)
    parser.add_argument("debtMom", help="Debt mom.", type=float)

    # Optional arguments
    parser.add_argument("-dD", "--debtDad", help="Debt dad.", type=float, default=1000.)
    parser.add_argument("-s", "--salary", help="Debt dad.", type=float, default=2000.)
    parser.add_argument("-b", "--bonus", help="Debt dad.", type=float, default=0.)

    # Print version
    parser.add_argument("--version", action="version", version='%(prog)s - Version 1.0')

    # Parse arguments
    args = parser.parse_args()

    return args

def example(credit_mom, credit_dad, debt_mom, debt_dad = 1000, salary = 2000, bonus = 0):
    total_gain = salary + credit_dad + credit_mom + bonus
    total_loss = debt_dad + debt_mom

    return total_gain - total_loss

if __name__ == '__main__':
    # Parse the arguments
    args = parseArguments()

    # Raw print arguments
    print("You are running the script with arguments: ")
    for a in args.__dict__:
        print(str(a) + ": " + str(args.__dict__[a]))

    # Run function
    print(example(args.creditMom, args.creditDad, args.debtMom, args.debtDad, args.salary, args.bonus))

Answer 2

虽然我赞同这种argparse方法，但这里有一个快速而肮脏的方法：

arg1, arg2, arg3 = [None, False, []]
if sys.argv[1:]:   # test if there are atleast 1 argument (beyond [0])
    arg1 = sys.argv[1]
    if sys.argv[2:]:
        arg2 = sys.argv[2]  # careful 'True' is a string, not a boolean
        arg3 = sys.argv[3:]  # rest

大多数情况下，当我开始向脚本添加参数解析时，我会使用它，并且我的参数选择还没有成熟。它更适合“位置”而不是“可选”（使用 argparse 术语）。