文件在comsurrogate-(文件在comsurrogate中打开)

今天明哥要给大家推荐比较 open 更好、更优雅地阅读文件 -- 使用fileinput

fileinput 是 Python 内置模块，但我相信很多人都不熟悉。今天我把 fileinput 详细说明了所有的用法和功能，并列出了一些非常实用的案例，可以说理解和使用完全没有问题。

当你的 Python 当脚本没有传入任何参数时，fileinput 默认会以 stdin 作为输入源

# demo.py
import fileinput

for line in fileinput.input():
print(line)


无论输入什么，效果如下，程序会像复读机一样自动读取和打印。

$ python demo.py
hello
hello

python
python
2. 单独打开文件

单独打开文件，只需要在 files 输入一个文件名即可

import fileinput

with fileinput.input(files=('a.txt',)) as file:
for line in file:
print(f'{fileinput.filename()}第{fileinput.lineno()}行:{line}', end='')


其中a.txt的内容如下

hello
world


执行后，输出如下

$ python demo.py
a.txt 第1行: hello
a.txt 第2行: world


需要注意的是，fileinput.input()默认使用mode='r'如果您的文件是二进制的，可以使用该模式读取文件mode='rb'模式。fileinput 只有这两种阅读模式。fileinput 只有这两种阅读模式。

从上面的例子也可以看出，我在fileinput.input进入函数files参数，它收到一个包含多个文件名的列表或元组，一个是读取一个文件，多个是读取多个文件。

import fileinput

with fileinput.input(files=('a.txt', 'b.txt')) as file:
for line in file:
print(f'{fileinput.filename()}第{fileinput.lineno()}行:{line}', end='')


a.txt和b.txt内容分别是

$ cat a.txt
hello
world
$ cat b.txt
hello
python


运行后输出结果如下，由于a.txt和b.txt内容被整合成文件对象file，因此fileinput.lineno()读取文件时，才是原文件中的真实行号。

$ python demo.py
a.txt 第1行: hello
a.txt 第2行: world
b.txt 第3行: hello
b.txt 第4行: python


若要读取多个文件，还可读取原文件的真实行号，可以使用fileinput.filelineno()方法

import fileinput

with fileinput.input(files=('a.txt', 'b.txt')) as file:
for line in file:
print(f'{fileinput.filename()}第{fileinput.filelineno()}行:{line}', end='')


运行后，输出如下

$ python demo.py
a.txt 第1行: hello
a.txt 第2行: world
b.txt 第1行: hello
b.txt 第2行: python


这个用法和 glob 模块是绝配

import fileinput
import glob

for line in fileinput.input(glob.glob(\\"*.txt\\")):
if fileinput.isfirstline():
print('-'*20, f'Reading{fileinput.filename()}...', '-'*20)
print(str(fileinput.lineno()) ': ' line.upper(), end=\\"\\")


操作效果如下

$ python demo.py
-------------------- Reading b.txt... --------------------
1: HELLO
2: PYTHON
-------------------- Reading a.txt... --------------------
3: HELLO
4: WORLD
4. 同时备份文件

fileinput.input有一个 backup 参数，您可以指定备份后缀名，如.bak

import fileinput


with fileinput.input(files=(\\"a.txt\\",), backup=\\".bak\\") as file:
for line in file:
print(f'{fileinput.filename()}第{fileinput.lineno()}行:{line}', end='')


运行结果如下，会多出一个a.txt.bak文件

$ ls -l a.txt*
-rw-r--r-- 1 MING staff 12 2 27 10:43 a.txt

$ python demo.py
a.txt 第1行: hello
a.txt 第2行: world

$ ls -l a.txt*
-rw-r--r-- 1 MING staff 12 2 27 10:43 a.txt
-rw-r--r-- 1 MING staff 42 2 27 10:39 a.txt.bak
5. 重定向替换标准输出

fileinput.input有一个 inplace 参数，表示是否将标准输出的结果写回文件，默认不替代

请参见下一段测试代码

import fileinput

with fileinput.input(files=(\\"a.txt\\",), inplace=True) as file:
print(\\"[INFO]task is started...\\")
for line in file:
print(f'{fileinput.filename()}第{fileinput.lineno()}行:{line}', end='')
print(\\"[INFO]task is closed...\\")


运行后会发现 for 循环体内的 print 内容会写回原文件。而在 for 循环体外的 print 没有变化。

$ cat a.txt
hello
world

$ python demo.py
[INFO]task is started...
[INFO]task is closed...

$ cat a.txt
a.txt 第1行: hello
a.txt 第2行: world


利用这一机制，文本替换很容易实现。

import sys
import fileinput

for line in fileinput.input(files=('a.txt', ), inplace=True):
#将Windows/DOS格式下的文本文件转换为Linux的文件
if line[-2:]== \\"\\r\ \\":
line = line \\"\ \\"
sys.stdout.write(line)


附：如何实现 DOS 和 UNIX 程序测试采用格式交换，使用 vim 输入以下指令

DOS转UNIX：:setfileformat=unix
UNIX转DOS：:setfileformat=dos
6. 必须介绍的方法

假如只是想要fileinput当做是替代 open 读取文件的工具，以上内容足以满足您的要求。

fileinput.filenam()
返回当前读取的文件名。

返回当前读取的文件名。在读取第一行之前，返回None
。

返回以整数表示的当前文件文件描述符。未打开文件时(在第一行和文件之间)返回-1
。

返回已读取的累计行号。在第一行被读取之前返回0
。读取最后一份文件的最后一行后，返回银行的行号。

0。读取最后一份文件的最后一行后，返回该行的行号。
但如果要基于的话 fileinput 做一些更复杂的逻辑，也许你需要使用以下方法fileinput.isfirstline()

True，否则返回False
。fileinput.isstdin()如果最终读取的行来自sys.stdin

True，否则返回False
。

fileinput.nextfile()
关闭当前文件，以便下次迭代将从下一个文件（如果存在）读取第一行；不读该文件的行将不计入累计行数。文件名称直到下一个文件的第一行被读取才会改变。该函数在第一行读取前不会生效；它不能用来跳过第一个文件。读取最后一个文件的最后一行后，函数将不再生效。

{x