使用 open 函数去读取文件,似乎是所有 python 工程师的共识。

今天明哥要给大家推荐一个比 open 更好用、更优雅的读取文件方法 -- 使用 fileinput

fileinput 是 Python 的内置模块,但我相信,不少人对它都是陌生的。今天我把 fileinput 的所有的用法、功能进行详细的讲解,并列举了一些非常实用的案例,对于理解和使用它可以说完全没有问题。

1. 从标准输入中读取

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

# demo.pyimport fileinputfor line in fileinput.input:print(line)

效果如下,不管你输入什么,程序会自动读取并再打印一次,像个复读机似的。

$ python demo.py hellohellopythonpython

2. 单独打开一个文件

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

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

其中 a.txt的内容如下

helloworld

执行后就会输出如下

$ python demo.pya.txt 第1行: helloa.txt 第2行: world

需要说明的一点是,fileinput.input默认使用mode='r'的模式读取文件,如果你的文件是二进制的,可以使用mode='rb'模式。fileinput 有且仅有这两种读取模式。

3. 批量打开多个文件

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

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

a.txtb.txt的内容分别是

$ cat a.txthelloworld$ cat b.txthellopython

运行后输出结果如下,由于 a.txtb.txt的内容被整合成一个文件对象file,因此fileinput.lineno只有在读取一个文件时,才是原文件中真实的行号。

$ python demo.pya.txt 第1行: helloa.txt 第2行: worldb.txt 第3行: hellob.txt 第4行: python

如果想要在读取多个文件的时候,也能读取原文件的真实行号,可以使用 fileinput.filelineno方法

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

运行后,输出如下

$ python demo.pya.txt 第1行: helloa.txt 第2行: worldb.txt 第1行: hellob.txt 第2行: python

这个用法和 glob 模块简直是绝配

import fileinputimport globfor 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: HELLO2: PYTHON-------------------- Reading a.txt... --------------------3: HELLO4: WORLD

4. 读取的同时备份文件

fileinput.input有一个 backup 参数,你可以指定备份的后缀名,比如.bak

import fileinputwith 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.pya.txt 第1行: helloa.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 fileinputwith 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.txthelloworld$ python demo.py[INFO] task is started...[INFO] task is closed...$ cat a.txta.txt 第1行: helloa.txt 第2行: world

利用这个机制,可以很容易的实现文本替换。

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

附:如何实现 DOS 和 UNIX 格式互换以供程序测试,使用 vim 输入如下指令即可

DOS转UNIX::setfileformat=unixUNIX转DOS::setfileformat=dos

6. 不得不介绍的方法

如果只是想要 fileinput当做是替代 open 读取文件的工具,那么以上的内容足以满足你的要求。

但若要想基于 fileinput 来做一些更加复杂的逻辑,也许你会需要用到如下这几个方法

7. 进阶一点的玩法

fileinput.input中有一个openhook的参数,它支持用户传入自定义的对象读取方法。

若你没有传入任何的勾子,fileinput 默认使用的是 open 函数。

openfiler读取文件速度(没想到吧这货比)(1)

fileinput为我们内置了两种勾子供你使用

  1. fileinput.hook_compressed(*filename*, *mode*)

    使用 gzipbz2模块透明地打开 gzip 和 bzip2 压缩的文件(通过扩展名'.gz''.bz2'来识别)。如果文件扩展名不是'.gz''.bz2',文件会以正常方式打开(即使用open()并且不带任何解压操作)。使用示例:fi = fileinput.FileInput(openhook=fileinput.hook_compressed)

  2. fileinput.hook_encoded(*encoding*, *errors=None*)

    返回一个通过 open打开每个文件的钩子,使用给定的encodingerrors来读取文件。使用示例:fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))

如果你自己的场景比较特殊,以上的三种勾子都不能满足你的要求,你也可以自定义。

这边我举个例子来抛砖引玉下

假如我想要使用 fileinput 来读取网络上的文件,可以这样定义勾子。

  1. 先使用 requests 下载文件到本地

  2. 再使用 open 去读取它

def online_open(url, mode):import requestsr = requests.get(url)filename = url.split("/")[-1]with open(filename,'w') as f1:f1.write(r.content.decode("utf-8"))f2 = open(filename,'r')return f2

直接将这个函数传给 openhook 即可

import fileinputfile_url = 'https://www.csdn.net/robots.txt'with fileinput.input(files=(file_url,), openhook=online_open) as file:for line in file:print(line, end="")

运行后按预期一样将 CSDN 的 robots 的文件打印了出来

User-agent: * Disallow: /scriptsDisallow: /publicDisallow: /css/Disallow: /images/Disallow: /content/Disallow: /ui/Disallow: /js/Disallow: /scripts/Disallow: /article_preview.html*Disallow: /tag/Disallow: /*?*Disallow: /link/Sitemap: https://www.csdn.net/sitemap-aggpage-index.xmlSitemap: https://www.csdn.net/article/sitemap.txt

8. 列举一些实用案例

案例一:读取一个文件所有行

import fileinputfor line in fileinput.input('data.txt'):print(line, end="")

案例二:读取多个文件所有行

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

案例三:利用fileinput将CRLF文件转为LF

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

案例四:配合 re 做日志分析:取所有含日期的行

#--样本文件--:error.logaaa1970-01-01 13:45:30 Error: **** Due to System Disk spacke not enough...bbb1970-01-02 10:20:30 Error: **** Due to System Out of Memory...ccc#---测试脚本---import reimport fileinputimport syspattern = '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'for line in fileinput.input('error.log',backup='.bak',inplace=1):if re.search(pattern,line):sys.stdout.write("=> ")sys.stdout.write(line)#---测试结果---=> 1970-01-01 13:45:30 Error: **** Due to System Disk spacke not enough...=> 1970-01-02 10:20:30 Error: **** Due to System Out of Memory...

案例五:利用fileinput实现类似于grep的功能

import sysimport reimport fileinputpattern= re.compile(sys.argv[1])for line in fileinput.input(sys.argv[2]):if pattern.match(line):print(fileinput.filename, fileinput.filelineno, line)$ ./demo.py import.*re *.py#查找所有py文件中,含import re字样的addressBook.py 2 import readdressBook1.py 10 import readdressBook2.py 18 import retest.py 238 import re

9. 写在最后

fileinput 是对 open 函数的再次封装,在仅需读取数据的场景中, fileinput 显然比 open 做得更专业、更人性,当然在其他有写操作的复杂场景中,fileinput 就无能为力啦,本身从 fileinput 的命名上就知道这个模块只专注于输入(读)而不是输出(写)。

微软于年初推出了自己的Python教程,我们将其汉化提供给大家,欢迎大家收藏关注哦~(已经汉化完成的20集,我们日更1集,未完成部分我们尽快更新)

,