文件作为argparse的命令行参数 - 如果参数无效,则出现错误消息

时间:2012-07-18 11:59:59

标签: python argparse

我目前正在使用argparse:

import argparse
from argparse import ArgumentParser

parser = ArgumentParser(description="ikjMatrix multiplication")
parser.add_argument("-i", dest="filename", required=True,
    help="input file with two matrices", metavar="FILE")
args = parser.parse_args()

A, B = read(args.filename)
C = ikjMatrixProduct(A, B)
printMatrix(C)

现在我想指出,-i的参数应该是一个可读文件。我怎么能这样做?

我尝试添加type=opentype=argparse.FileType('r')并且它们有效,但如果文件无效,我想收到错误消息。我怎么能这样做?

3 个答案:

答案 0 :(得分:74)

实际上很容易。您只需编写一个函数来检查文件是否有效,否则写入错误。将该函数与type选项一起使用。请注意,您可以通过继承argparse.Action来获得更多花哨并创建自定义操作,但我认为这不是必需的。在我的示例中,我返回一个打开的文件句柄(见下文):

#!/usr/bin/env python

from argparse import ArgumentParser
import os.path


def is_valid_file(parser, arg):
    if not os.path.exists(arg):
        parser.error("The file %s does not exist!" % arg)
    else:
        return open(arg, 'r')  # return an open file handle


parser = ArgumentParser(description="ikjMatrix multiplication")
parser.add_argument("-i", dest="filename", required=True,
                    help="input file with two matrices", metavar="FILE",
                    type=lambda x: is_valid_file(parser, x))
args = parser.parse_args()

A, B = read(args.filename)
C = ikjMatrixProduct(A, B)
printMatrix(C)

答案 1 :(得分:27)

在Python 3.4中执行此操作的方法是使用argparse.FileType类。确保在完成后关闭输入流。这也很有用,因为您可以将伪参数'-'用于STDIN / STDOUT。来自文档:

  

FileType对象理解伪参数'-'并自动将其转换为sys.stdin表示可读FileType个对象,sys.stdout表示可写FileType个对象

示例:

#!/usr/bin/env python3

import argparse

if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  parser.add_argument('--infile', type=argparse.FileType('r', encoding='UTF-8'), 
                      required=True)
  args = parser.parse_args()
  print(args)
  args.infile.close()

然后跑了......

  • 没有参数:

    $ ./stack_overflow.py
    usage: stack_overflow.py [-h] --infile INFILE
    stack_overflow.py: error: the following arguments are required: --infile
    
  • 使用不存在的文件:

    $ ./stack_overflow.py --infile notme
    usage: stack_overflow.py [-h] --infile INFILE
    stack_overflow.py: error: argument --infile: can't open 'notme': [Errno 2] No such file or directory: 'notme'
    
  • 使用现有文件:

    $ ./stack_overflow.py --infile ./stack_overflow.py
    Namespace(infile=<_io.TextIOWrapper name='./stack_overflow.py' mode='r' encoding='UTF-8'>)
    
  • '-'用于STDIN:

    $ echo 'hello' | ./stack_overflow.py --infile -
    Namespace(infile=<_io.TextIOWrapper name='<stdin>' mode='r' encoding='UTF-8'>)
    

答案 2 :(得分:16)

我刚刚找到了这个:

def extant_file(x):
    """
    'Type' for argparse - checks that file exists but does not open.
    """
    if not os.path.exists(x):
        # Argparse uses the ArgumentTypeError to give a rejection message like:
        # error: argument input: x does not exist
        raise argparse.ArgumentTypeError("{0} does not exist".format(x))
    return x

if __name__ == "__main__":
    import argparse, sys, os
    from argparse import ArgumentParser

    parser = ArgumentParser(description="ikjMatrix multiplication")
    parser.add_argument("-i", "--input",
        dest="filename", required=True, type=extant_file,
        help="input file with two matrices", metavar="FILE")
    args = parser.parse_args()

    A, B = read(args.filename)
    C = ikjMatrixProduct(A, B)
    printMatrix(C, args.output)

来源:fhcrc.github.com