使用optparse将stdin和stdout重定向到python中的文件的一致方法

Question

我有十几个可以通过stdin或选项接受输入的程序，我想以类似的方式为输出实现相同的功能。

optparse代码如下所示：

parser.add_option('-f', '--file',
       default='-',
       help='Specifies the input file.  The default is stdin.')
parser.add_option('-o', '--output',
       default='-',
       help='Specifies the output file.  The default is stdout.')

其余适用的代码如下所示：

if opts.filename == '-':
    infile = sys.stdin
else:
    infile = open(opts.filename, "r")

if opts.output == '-':
    outfile = sys.stdout
else:
    outfile = open(opts.output, "w")

这段代码运行正常，我喜欢它的简单性 - 但是我无法找到任何使用默认值' - '表示stdout的人的引用。 这是一个很好的一致解决方案还是我忽略了更好或更期望的事情？

Answer 1

对于输入文件，您可以使用fileinput模块。 它遵循输入文件的通用约定：如果没有给定文件或文件名是' - '，它将读取stdin，否则它将从命令行给出的文件中读取。

-f和--file选项不需要。 如果您的程序总是需要输入文件，那么它不是一个选项。

-o和--output用于指定各种程序中的输出文件名 。

optparse

#!/usr/bin/env python
import fileinput
import sys
from optparse import OptionParser

parser = OptionParser()
parser.add_option('-o', '--output',
    help='Specifies the output file.  The default is stdout.')
options, files = parser.parse_args()
if options.output and options.output != '-':
   sys.stdout = open(options.output, 'w')

for line in fileinput.input(files):
    process(line)

argparse

argparse模块允许您将文件显式指定为参数：

#!/usr/bin/env python
import fileinput
import sys
from argparse import ArgumentParser

parser = ArgumentParser()
parser.add_argument('files', nargs='*', help='specify input files')
group = parser.add_mutually_exclusive_group()
group.add_argument('-o', '--output', 
    help='specify the output file.  The default is stdout')
group.add_argument('-i', '--inplace', action='store_true',
    help='modify files inplace')
args = parser.parse_args()

if args.output and args.output != '-':
   sys.stdout = open(args.output, 'w')

for line in fileinput.input(args.files, inplace=args.inplace):
    process(line)

注意：我在第二个示例中添加了--inplace选项：

$ python util-argparse.py --help
usage: util-argparse.py [-h] [-o OUTPUT | -i] [files [files ...]]

positional arguments:
  files                 specify input files

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        specify the output file. The default is stdout
  -i, --inplace         modify files inplace

Answer 2

如果你可以使用argparse （即Python 2.7+），它内置了对你想要的支持：直接来自argparse doc

FileType工厂创建可以传递给ArgumentParser.add_argument()的type参数的对象。 将FileType对象作为其类型的参数将打开命令行参数[...] FileType对象理解伪参数' - '并自动将其转换为sys.stdin以获取可读的FileType对象，并将sys.stdout为可写的FileType对象。

所以我的建议是简单地使用

import sys
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('file', type=argparse.FileType('r'),
    help="Specifies the input file")
parser.add_argument('output', type=argparse.FileType('w'),
    help="Specifies the output file")
args = parser.parse_args(sys.argv[1:])

# Here you can use your files
text = args.file.read()
args.output.write(text)
# … and so on

那你可以做

> python spam.py file output 

从file和输出读取到output ，或

> echo "Ni!" | python spam.py - output  

读"Ni!" 并输出到output ，或

> python spam.py file -

...

这很好，因为使用-对于相关流是许多程序使用的约定 。 如果要指出它，请将其添加到help字符串中。

  parser.add_argument('file', type=argparse.FileType('r'),
    help="Specifies the input file, '-' for standard input")

作为参考，使用消息将是

> python spam.py -h
usage: [-h] file output

positional arguments:
  file        Specifies the input file, '-' for standard input
  output      Specifies the output file, '-' for standard output

optional arguments:
  -h, --help  show this help message and exit