指定输入参数argparse python的格式


111

我有一个需要一些命令行输入的python脚本,并且我正在使用argparse进行解析。我发现文档有点混乱,找不到在输入参数中检查格式的方法。这个示例脚本解释了我检查格式的意思:

parser.add_argument('-s', "--startdate", help="The Start Date - format YYYY-MM-DD ", required=True)
parser.add_argument('-e', "--enddate", help="The End Date format YYYY-MM-DD (Inclusive)", required=True)
parser.add_argument('-a', "--accountid", type=int, help='Account ID for the account for which data is required (Default: 570)')
parser.add_argument('-o', "--outputpath", help='Directory where output needs to be stored (Default: ' + os.path.dirname(os.path.abspath(__file__)))

我需要检查选项,-s并且-e用户输入的格式为YYYY-MM-DD。我不知道argparse中有一个选项可以完成此任务。

Answers:


235

根据文档

type关键字参数add_argument()允许执行任何必要的类型检查和类型转换... type=可以接受带有单个字符串参数并返回转换后值的任何可调用对象

您可以执行以下操作:

def valid_date(s):
    try:
        return datetime.strptime(s, "%Y-%m-%d")
    except ValueError:
        msg = "Not a valid date: '{0}'.".format(s)
        raise argparse.ArgumentTypeError(msg)

然后将其用作type

parser.add_argument("-s", 
                    "--startdate", 
                    help="The Start Date - format YYYY-MM-DD", 
                    required=True, 
                    type=valid_date)

关于您删除的另一个问题,您能指出我的文档(如果有)吗?
Sohaib

是否valid_date()假设给定的参数是字符串?
Stevoisiak

1
@StevenVascellaro是的,但这就是API定义的;根据文档中的引号“采用单个字符串参数”
jonrsharpe

71

只是为了补充上面的答案,如果您想将lambda函数保持为单一格式,则可以使用该函数。例如:

parser.add_argument('--date', type=lambda d: datetime.strptime(d, '%Y%m%d'))

旧线程,但问题至少仍然与我有关!


6
这是一个很好的技巧,尽管如果您传递无效的东西,错误消息将只是invalid <lambda> value
Brad Solomon

38

对于其他通过搜索引擎实现此目标的人:在Python 3.7中,您可以使用标准的.fromisoformatclass方法,而不是为ISO-8601兼容日期重新发明轮子,例如:

parser.add_argument('-s', "--startdate",
    help="The Start Date - format YYYY-MM-DD",
    required=True,
    type=datetime.date.fromisoformat)
parser.add_argument('-e', "--enddate",
    help="The End Date format YYYY-MM-DD (Inclusive)",
    required=True,
    type=datetime.date.fromisoformat)

5
此外,dateutil ISO解析器还包含许多仍符合ISO 8601-2004标准的fmts。您可以使用import dateutil.parser-> type=dateutil.parser.isoparsetype=dateutil.parser.parse
Brad Solomon '18

@BradSolomon确实是一个不错的建议(因此我的+1),但这dateutil是第三方软件包。必须相对于额外安装它的(小)麻烦来判断它的好处。YMMV。
Laryx Decidua
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.