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

Question

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

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")

该代码运行良好，我喜欢它的简单性 - 但我无法找到对使用默认值“-”进行输出的任何人的引用指示标准输出。这是一个良好的一致解决方案还是我忽略了更好或更期望的东西？

Answer 1

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

不需要 -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文档

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

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

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!" 并输出到输出，或者

> 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