前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python fileinput库

Python fileinput库

原创
作者头像
花落花相惜
发布2021-11-26 13:14:48
2.2K0
发布2021-11-26 13:14:48
举报
文章被收录于专栏:花落的技术专栏

1. 从标准输入中读取

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

代码语言:txt
复制
# demo.py
代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input():
代码语言:txt
复制
    print(line) 

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

代码语言:txt
复制
$ python demo.py 
代码语言:txt
复制
hello
代码语言:txt
复制
hello
代码语言:txt
复制
python
代码语言:txt
复制
python

2. 单独打开一个文件

脚本的内容如下

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=('a.txt',)) as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

其中 a.txt 的内容如下

代码语言:txt
复制
hello
代码语言:txt
复制
world

执行后就会输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

需要说明的一点是,fileinput.input() 默认使用 mode='r'

的模式读取文件,如果你的文件是二进制的,可以使用mode='rb' 模式。fileinput 有且仅有这两种读取模式。

3. 批量打开多个文件

从上面的例子也可以看到,我在 fileinput.input 函数中传入了 files

参数,它接收一个包含多个文件名的列表或元组,传入一个就是读取一个文件,传入多件就是读取多个文件。

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

a.txtb.txt 的内容分别是

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ cat b.txt
代码语言:txt
复制
hello
代码语言:txt
复制
python

运行后输出结果如下,由于 a.txtb.txt 的内容被整合成一个文件对象 file ,因此 fileinput.lineno()

只有在读取一个文件时,才是原文件中真实的行号。

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第3行: hello
代码语言:txt
复制
b.txt 第4行: python

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

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

运行后,输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第1行: hello
代码语言:txt
复制
b.txt 第2行: python

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

运行效果如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
-------------------- Reading b.txt... --------------------
代码语言:txt
复制
1: HELLO
代码语言:txt
复制
2: PYTHON
代码语言:txt
复制
-------------------- Reading a.txt... --------------------
代码语言:txt
复制
3: HELLO
代码语言:txt
复制
4: WORLD

4. 读取的同时备份文件

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=("a.txt",), backup=".bak") as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

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

代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
-rw-r--r--  1 MING  staff  42  2 27 10:39 a.txt.bak

5. 标准输出重定向替换

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

请看如下一段测试代码

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

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

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
[INFO] task is started...
代码语言:txt
复制
[INFO] task is closed...
代码语言:txt
复制
$ cat a.txt 
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

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

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

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

代码语言:txt
复制
DOS转UNIX::setfileformat=unix
代码语言:txt
复制
UNIX转DOS::setfileformat=dos

6. 不得不介绍的方法

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

  • fileinput.filenam() 返回当前被读取的文件名。 在第一行被读取之前,返回 None
  • fileinput.fileno() 返回以整数表示的当前文件“文件描述符”。 当未打开文件时(处在第一行和文件之间),返回 -1
  • fileinput.lineno() 返回已被读取的累计行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回该行的行号。
  • fileinput.filelineno() 返回当前文件中的行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回此文件中该行的行号。

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

  • fileinput.isfirstline() 如果刚读取的行是其所在文件的第一行则返回 True,否则返回 False
  • fileinput.isstdin() 如果最后读取的行来自 sys.stdin 则返回 True,否则返回 False
  • fileinput.nextfile() 关闭当前文件以使下次迭代将从下一个文件(如果存在)读取第一行;不是从该文件读取的行将不会被计入累计行数。 直到下一个文件的第一行被读取之后文件名才会改变。 在第一行被读取之前,此函数将不会生效;它不能被用来跳过第一个文件。 在最后一个文件的最后一行被读取之后,此函数将不再生效。
  • fileinput.close() 关闭序列。

7. 进阶一点的玩法

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

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

image

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

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

使用 gzipbz2 模块透明地打开 gzip 和 bzip2 压缩的文件(通过扩展名 '.gz''.bz2' 来识别)。

如果文件扩展名不是 '.gz''.bz2',文件会以正常方式打开(即使用

open()(https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.python.org%2Fzh-

cn%2F3%2Flibrary%2Ffunctions.html%23open) 并且不带任何解压操作)。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_compressed)`

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

返回一个通过 open() 打开每个文件的钩子,使用给定的 encodingerrors 来读取文件。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8",

"surrogateescape"))`

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

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

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

  1. 先使用 requests 下载文件到本地
  2. 再使用 open 去读取它
代码语言:txt
复制
def online_open(url, mode):
代码语言:txt
复制
    import requests
代码语言:txt
复制
    r = requests.get(url) 
代码语言:txt
复制
    filename = url.split("/")[-1]
代码语言:txt
复制
    with open(filename,'w') as f1:
代码语言:txt
复制
        f1.write(r.content.decode("utf-8"))
代码语言:txt
复制
    f2 = open(filename,'r')
代码语言:txt
复制
    return f2

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

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

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

代码语言:txt
复制
User-agent: * 
代码语言:txt
复制
Disallow: /scripts 
代码语言:txt
复制
Disallow: /public 
代码语言:txt
复制
Disallow: /css/ 
代码语言:txt
复制
Disallow: /images/ 
代码语言:txt
复制
Disallow: /content/ 
代码语言:txt
复制
Disallow: /ui/ 
代码语言:txt
复制
Disallow: /js/ 
代码语言:txt
复制
Disallow: /scripts/ 
代码语言:txt
复制
Disallow: /article_preview.html* 
代码语言:txt
复制
Disallow: /tag/
代码语言:txt
复制
Disallow: /*?*
代码语言:txt
复制
Disallow: /link/
代码语言:txt
复制
Sitemap: https://www.csdn.net/sitemap-aggpage-index.xml
代码语言:txt
复制
Sitemap: https://www.csdn.net/article/sitemap.txt 

8. 列举一些实用案例

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input('data.txt'):
代码语言:txt
复制
  print(line, end="")

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

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

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

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

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

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

代码语言:txt
复制
import sys
代码语言:txt
复制
import re
代码语言:txt
复制
import fileinput
代码语言:txt
复制
pattern= re.compile(sys.argv[1])
代码语言:txt
复制
for line in fileinput.input(sys.argv[2]):
代码语言:txt
复制
    if pattern.match(line):
代码语言:txt
复制
        print(fileinput.filename(), fileinput.filelineno(), line)
代码语言:txt
复制
$ ./test.py import.*re *.py
代码语言:txt
复制
#查找所有py文件中,含import re字样的
代码语言:txt
复制
addressBook.py  2   import re
代码语言:txt
复制
addressBook1.py 10  import re
代码语言:txt
复制
addressBook2.py 18  import re
代码语言:txt
复制
test.py         238 import re

9. 写在最后

fileinput 是对 open 函数的再次封装,在仅需读取数据的场景中, fileinput 显然比 open

做得更专业、更人性,当然在其他有写操作的复杂场景中,fileinput 就无能为力啦,本身从 fileinput

的命名上就知道这个模块只专注于输入(读)而不是输出(写)。

作者:王一白

原文链接:https://juejin.cn/post/6934914582322348063

#还在用 open 读文件?你out 了,这个库比 open 好用 100 倍!使用 open 函数去读取文件,似乎是所有 Python 工程师的共识。

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

fileinput 是 Python 的内置模块,但我相信,不少人对它都是陌生的。今天我把 fileinput

的所有的用法、功能进行详细的讲解,并列举了一些非常实用的案例,对于理解和使用它可以说完全没有问题。

1. 从标准输入中读取

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

代码语言:txt
复制
# demo.py
代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input():
代码语言:txt
复制
    print(line) 

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

代码语言:txt
复制
$ python demo.py 
代码语言:txt
复制
hello
代码语言:txt
复制
hello
代码语言:txt
复制
python
代码语言:txt
复制
python

2. 单独打开一个文件

脚本的内容如下

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=('a.txt',)) as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

其中 a.txt 的内容如下

代码语言:txt
复制
hello
代码语言:txt
复制
world

执行后就会输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

需要说明的一点是,fileinput.input() 默认使用 mode='r'

的模式读取文件,如果你的文件是二进制的,可以使用mode='rb' 模式。fileinput 有且仅有这两种读取模式。

3. 批量打开多个文件

从上面的例子也可以看到,我在 fileinput.input 函数中传入了 files

参数,它接收一个包含多个文件名的列表或元组,传入一个就是读取一个文件,传入多件就是读取多个文件。

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

a.txtb.txt 的内容分别是

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ cat b.txt
代码语言:txt
复制
hello
代码语言:txt
复制
python

运行后输出结果如下,由于 a.txtb.txt 的内容被整合成一个文件对象 file ,因此 fileinput.lineno()

只有在读取一个文件时,才是原文件中真实的行号。

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第3行: hello
代码语言:txt
复制
b.txt 第4行: python

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

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

运行后,输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第1行: hello
代码语言:txt
复制
b.txt 第2行: python

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

运行效果如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
-------------------- Reading b.txt... --------------------
代码语言:txt
复制
1: HELLO
代码语言:txt
复制
2: PYTHON
代码语言:txt
复制
-------------------- Reading a.txt... --------------------
代码语言:txt
复制
3: HELLO
代码语言:txt
复制
4: WORLD

4. 读取的同时备份文件

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=("a.txt",), backup=".bak") as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

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

代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
-rw-r--r--  1 MING  staff  42  2 27 10:39 a.txt.bak

5. 标准输出重定向替换

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

请看如下一段测试代码

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

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

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
[INFO] task is started...
代码语言:txt
复制
[INFO] task is closed...
代码语言:txt
复制
$ cat a.txt 
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

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

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

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

代码语言:txt
复制
DOS转UNIX::setfileformat=unix
代码语言:txt
复制
UNIX转DOS::setfileformat=dos

6. 不得不介绍的方法

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

  • fileinput.filenam() 返回当前被读取的文件名。 在第一行被读取之前,返回 None
  • fileinput.fileno() 返回以整数表示的当前文件“文件描述符”。 当未打开文件时(处在第一行和文件之间),返回 -1
  • fileinput.lineno() 返回已被读取的累计行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回该行的行号。
  • fileinput.filelineno() 返回当前文件中的行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回此文件中该行的行号。

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

  • fileinput.isfirstline() 如果刚读取的行是其所在文件的第一行则返回 True,否则返回 False
  • fileinput.isstdin() 如果最后读取的行来自 sys.stdin 则返回 True,否则返回 False
  • fileinput.nextfile() 关闭当前文件以使下次迭代将从下一个文件(如果存在)读取第一行;不是从该文件读取的行将不会被计入累计行数。 直到下一个文件的第一行被读取之后文件名才会改变。 在第一行被读取之前,此函数将不会生效;它不能被用来跳过第一个文件。 在最后一个文件的最后一行被读取之后,此函数将不再生效。
  • fileinput.close() 关闭序列。

7. 进阶一点的玩法

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

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

image

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

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

使用 gzipbz2 模块透明地打开 gzip 和 bzip2 压缩的文件(通过扩展名 '.gz''.bz2' 来识别)。

如果文件扩展名不是 '.gz''.bz2',文件会以正常方式打开(即使用

open()(https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.python.org%2Fzh-

cn%2F3%2Flibrary%2Ffunctions.html%23open) 并且不带任何解压操作)。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_compressed)`

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

返回一个通过 open() 打开每个文件的钩子,使用给定的 encodingerrors 来读取文件。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8",

"surrogateescape"))`

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

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

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

  1. 先使用 requests 下载文件到本地
  2. 再使用 open 去读取它
代码语言:txt
复制
def online_open(url, mode):
代码语言:txt
复制
    import requests
代码语言:txt
复制
    r = requests.get(url) 
代码语言:txt
复制
    filename = url.split("/")[-1]
代码语言:txt
复制
    with open(filename,'w') as f1:
代码语言:txt
复制
        f1.write(r.content.decode("utf-8"))
代码语言:txt
复制
    f2 = open(filename,'r')
代码语言:txt
复制
    return f2

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

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

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

代码语言:txt
复制
User-agent: * 
代码语言:txt
复制
Disallow: /scripts 
代码语言:txt
复制
Disallow: /public 
代码语言:txt
复制
Disallow: /css/ 
代码语言:txt
复制
Disallow: /images/ 
代码语言:txt
复制
Disallow: /content/ 
代码语言:txt
复制
Disallow: /ui/ 
代码语言:txt
复制
Disallow: /js/ 
代码语言:txt
复制
Disallow: /scripts/ 
代码语言:txt
复制
Disallow: /article_preview.html* 
代码语言:txt
复制
Disallow: /tag/
代码语言:txt
复制
Disallow: /*?*
代码语言:txt
复制
Disallow: /link/
代码语言:txt
复制
Sitemap: https://www.csdn.net/sitemap-aggpage-index.xml
代码语言:txt
复制
Sitemap: https://www.csdn.net/article/sitemap.txt 

8. 列举一些实用案例

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input('data.txt'):
代码语言:txt
复制
  print(line, end="")

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

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

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

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

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

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

代码语言:txt
复制
import sys
代码语言:txt
复制
import re
代码语言:txt
复制
import fileinput
代码语言:txt
复制
pattern= re.compile(sys.argv[1])
代码语言:txt
复制
for line in fileinput.input(sys.argv[2]):
代码语言:txt
复制
    if pattern.match(line):
代码语言:txt
复制
        print(fileinput.filename(), fileinput.filelineno(), line)
代码语言:txt
复制
$ ./test.py import.*re *.py
代码语言:txt
复制
#查找所有py文件中,含import re字样的
代码语言:txt
复制
addressBook.py  2   import re
代码语言:txt
复制
addressBook1.py 10  import re
代码语言:txt
复制
addressBook2.py 18  import re
代码语言:txt
复制
test.py         238 import re

9. 写在最后

fileinput 是对 open 函数的再次封装,在仅需读取数据的场景中, fileinput 显然比 open

做得更专业、更人性,当然在其他有写操作的复杂场景中,fileinput 就无能为力啦,本身从 fileinput

的命名上就知道这个模块只专注于输入(读)而不是输出(写)。

作者:王一白

原文链接:https://juejin.cn/post/6934914582322348063

#还在用 open 读文件?你out 了,这个库比 open 好用 100 倍!使用 open 函数去读取文件,似乎是所有 Python 工程师的共识。

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

fileinput 是 Python 的内置模块,但我相信,不少人对它都是陌生的。今天我把 fileinput

的所有的用法、功能进行详细的讲解,并列举了一些非常实用的案例,对于理解和使用它可以说完全没有问题。

1. 从标准输入中读取

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

代码语言:txt
复制
# demo.py
代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input():
代码语言:txt
复制
    print(line) 

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

代码语言:txt
复制
$ python demo.py 
代码语言:txt
复制
hello
代码语言:txt
复制
hello
代码语言:txt
复制
python
代码语言:txt
复制
python

2. 单独打开一个文件

脚本的内容如下

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=('a.txt',)) as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

其中 a.txt 的内容如下

代码语言:txt
复制
hello
代码语言:txt
复制
world

执行后就会输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

需要说明的一点是,fileinput.input() 默认使用 mode='r'

的模式读取文件,如果你的文件是二进制的,可以使用mode='rb' 模式。fileinput 有且仅有这两种读取模式。

3. 批量打开多个文件

从上面的例子也可以看到,我在 fileinput.input 函数中传入了 files

参数,它接收一个包含多个文件名的列表或元组,传入一个就是读取一个文件,传入多件就是读取多个文件。

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

a.txtb.txt 的内容分别是

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ cat b.txt
代码语言:txt
复制
hello
代码语言:txt
复制
python

运行后输出结果如下,由于 a.txtb.txt 的内容被整合成一个文件对象 file ,因此 fileinput.lineno()

只有在读取一个文件时,才是原文件中真实的行号。

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第3行: hello
代码语言:txt
复制
b.txt 第4行: python

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

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

运行后,输出如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
b.txt 第1行: hello
代码语言:txt
复制
b.txt 第2行: python

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

运行效果如下

代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
-------------------- Reading b.txt... --------------------
代码语言:txt
复制
1: HELLO
代码语言:txt
复制
2: PYTHON
代码语言:txt
复制
-------------------- Reading a.txt... --------------------
代码语言:txt
复制
3: HELLO
代码语言:txt
复制
4: WORLD

4. 读取的同时备份文件

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
with fileinput.input(files=("a.txt",), backup=".bak") as file:
代码语言:txt
复制
    for line in file:
代码语言:txt
复制
        print(f'{fileinput.filename()} 第{fileinput.lineno()}行: {line}', end='') 

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

代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world
代码语言:txt
复制
$ ls -l a.txt*
代码语言:txt
复制
-rw-r--r--  1 MING  staff  12  2 27 10:43 a.txt
代码语言:txt
复制
-rw-r--r--  1 MING  staff  42  2 27 10:39 a.txt.bak

5. 标准输出重定向替换

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

请看如下一段测试代码

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

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

代码语言:txt
复制
$ cat a.txt
代码语言:txt
复制
hello
代码语言:txt
复制
world
代码语言:txt
复制
$ python demo.py
代码语言:txt
复制
[INFO] task is started...
代码语言:txt
复制
[INFO] task is closed...
代码语言:txt
复制
$ cat a.txt 
代码语言:txt
复制
a.txt 第1行: hello
代码语言:txt
复制
a.txt 第2行: world

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

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

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

代码语言:txt
复制
DOS转UNIX::setfileformat=unix
代码语言:txt
复制
UNIX转DOS::setfileformat=dos

6. 不得不介绍的方法

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

  • fileinput.filenam() 返回当前被读取的文件名。 在第一行被读取之前,返回 None
  • fileinput.fileno() 返回以整数表示的当前文件“文件描述符”。 当未打开文件时(处在第一行和文件之间),返回 -1
  • fileinput.lineno() 返回已被读取的累计行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回该行的行号。
  • fileinput.filelineno() 返回当前文件中的行号。 在第一行被读取之前,返回 0。 在最后一个文件的最后一行被读取之后,返回此文件中该行的行号。

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

  • fileinput.isfirstline() 如果刚读取的行是其所在文件的第一行则返回 True,否则返回 False
  • fileinput.isstdin() 如果最后读取的行来自 sys.stdin 则返回 True,否则返回 False
  • fileinput.nextfile() 关闭当前文件以使下次迭代将从下一个文件(如果存在)读取第一行;不是从该文件读取的行将不会被计入累计行数。 直到下一个文件的第一行被读取之后文件名才会改变。 在第一行被读取之前,此函数将不会生效;它不能被用来跳过第一个文件。 在最后一个文件的最后一行被读取之后,此函数将不再生效。
  • fileinput.close() 关闭序列。

7. 进阶一点的玩法

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

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

image

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

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

使用 gzipbz2 模块透明地打开 gzip 和 bzip2 压缩的文件(通过扩展名 '.gz''.bz2' 来识别)。

如果文件扩展名不是 '.gz''.bz2',文件会以正常方式打开(即使用

open()(https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.python.org%2Fzh-

cn%2F3%2Flibrary%2Ffunctions.html%23open) 并且不带任何解压操作)。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_compressed)`

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

返回一个通过 open() 打开每个文件的钩子,使用给定的 encodingerrors 来读取文件。使用示例: `fi =

fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8",

"surrogateescape"))`

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

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

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

  1. 先使用 requests 下载文件到本地
  2. 再使用 open 去读取它
代码语言:txt
复制
def online_open(url, mode):
代码语言:txt
复制
    import requests
代码语言:txt
复制
    r = requests.get(url) 
代码语言:txt
复制
    filename = url.split("/")[-1]
代码语言:txt
复制
    with open(filename,'w') as f1:
代码语言:txt
复制
        f1.write(r.content.decode("utf-8"))
代码语言:txt
复制
    f2 = open(filename,'r')
代码语言:txt
复制
    return f2

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

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

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

代码语言:txt
复制
User-agent: * 
代码语言:txt
复制
Disallow: /scripts 
代码语言:txt
复制
Disallow: /public 
代码语言:txt
复制
Disallow: /css/ 
代码语言:txt
复制
Disallow: /images/ 
代码语言:txt
复制
Disallow: /content/ 
代码语言:txt
复制
Disallow: /ui/ 
代码语言:txt
复制
Disallow: /js/ 
代码语言:txt
复制
Disallow: /scripts/ 
代码语言:txt
复制
Disallow: /article_preview.html* 
代码语言:txt
复制
Disallow: /tag/
代码语言:txt
复制
Disallow: /*?*
代码语言:txt
复制
Disallow: /link/
代码语言:txt
复制
Sitemap: https://www.csdn.net/sitemap-aggpage-index.xml
代码语言:txt
复制
Sitemap: https://www.csdn.net/article/sitemap.txt 

8. 列举一些实用案例

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
for line in fileinput.input('data.txt'):
代码语言:txt
复制
  print(line, end="")

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

代码语言:txt
复制
import fileinput
代码语言:txt
复制
import glob
代码语言:txt
复制
for line in fileinput.input(glob.glob("*.txt")):
代码语言:txt
复制
    if fileinput.isfirstline():
代码语言:txt
复制
        print('-'*20, f'Reading {fileinput.filename()}...', '-'*20)
代码语言:txt
复制
    print(str(fileinput.lineno()) + ': ' + line.upper(), end="")

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

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

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

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

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

代码语言:txt
复制
import sys
代码语言:txt
复制
import re
代码语言:txt
复制
import fileinput
代码语言:txt
复制
pattern= re.compile(sys.argv[1])
代码语言:txt
复制
for line in fileinput.input(sys.argv[2]):
代码语言:txt
复制
    if pattern.match(line):
代码语言:txt
复制
        print(fileinput.filename(), fileinput.filelineno(), line)
代码语言:txt
复制
$ ./test.py import.*re *.py
代码语言:txt
复制
#查找所有py文件中,含import re字样的
代码语言:txt
复制
addressBook.py  2   import re
代码语言:txt
复制
addressBook1.py 10  import re
代码语言:txt
复制
addressBook2.py 18  import re
代码语言:txt
复制
test.py         238 import re

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1. 从标准输入中读取
  • 2. 单独打开一个文件
  • 3. 批量打开多个文件
  • 4. 读取的同时备份文件
  • 5. 标准输出重定向替换
  • 6. 不得不介绍的方法
  • 7. 进阶一点的玩法
  • 8. 列举一些实用案例
  • 9. 写在最后
  • 1. 从标准输入中读取
  • 2. 单独打开一个文件
  • 3. 批量打开多个文件
  • 4. 读取的同时备份文件
  • 5. 标准输出重定向替换
  • 6. 不得不介绍的方法
  • 7. 进阶一点的玩法
  • 8. 列举一些实用案例
  • 9. 写在最后
  • 1. 从标准输入中读取
  • 2. 单独打开一个文件
  • 3. 批量打开多个文件
  • 4. 读取的同时备份文件
  • 5. 标准输出重定向替换
  • 6. 不得不介绍的方法
  • 7. 进阶一点的玩法
  • 8. 列举一些实用案例
相关产品与服务
Elasticsearch Service
腾讯云 Elasticsearch Service(ES)是云端全托管海量数据检索分析服务,拥有高性能自研内核,集成X-Pack。ES 支持通过自治索引、存算分离、集群巡检等特性轻松管理集群,也支持免运维、自动弹性、按需使用的 Serverless 模式。使用 ES 您可以高效构建信息检索、日志分析、运维监控等服务,它独特的向量检索还可助您构建基于语义、图像的AI深度应用。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档