处理文件是我们几乎每天都躲不开的任务之一。Python中含有几个用于执行文件操作的内置模块,例如读取文件,移动文件,获取文件属性等。本文总结了许多值得了解的函数,这些函数可用于进行一些Python中最常见的文件操作,可以极大地提高我们处理文件的效率。
(1)文件的打开与关闭
读取或写入文件前,首先要做的就是打开文件,Python的内置函数open可以打开文件并返回文件对象。文件对象的类型取决于打开文件的模式,可以是文本文件对象,也可以是原始二进制文件,或是缓冲二进制文件对象。每个文件对象都有诸如 read()和write()之类的方法。
file = open("test_file.txt","w+")
file.read()
file.write("a new line")
Python文档列出了所有可能的文件模式,其中最常见的模式可见下表。但要注意一个重要规则,即:如果某一文件存在,那么任何与w相关的模式都会截断该文件,并再创建一个新文件。如果你不想覆盖原文件,请谨慎使用此模式,或尽量使用追加模式 a。
- r 打开以供阅读(这是默认的打开方式)
- r+ 为读取和写入打开(文件指针位于文件的开头)
- w 打开进行写入(如果存在则截断文件)
- w+ 可以同时进行读写(如果存在则截断文件)
- a 打开写入(如果存在则会追加到文件的末尾,并且此时文件指针位于文件末尾)
上一个代码块中的问题是打开文件后未关闭。在处理文件后关闭文件很重要,因为打开的文件对象可能会出现诸如资源泄漏等不可预测的风险,以下两种方式可以确保正确关闭文件。
使用close()
try:
file =open("test_file.txt","w+")
file.write("a new line")
exception Exception as e:
logging.exception(e)
finally:
file.close()
使用上下文管理器with open() as f
with open("test_file","w+") as file:
file.write("a new line")
两种方法哪个更优?这要看你使用的场景。以下示例实现了将50000条记录写入文件的3种不同方式。从输出中可见,use_context_manager_2()函数与其他函数相比性能极低。这是因为with语句在一个单独函数中,基本上会为每条记录打开和关闭文件,这种繁琐的I / O操作会极大地影响性能。
def_write_to_file(file, line):
with open(file, "a") as f:
f.write(line)
def _valid_records():
for i inrange(100000):
if i %2==0:
yield i
def use_context_manager_2(file):
for line in_valid_records():
_write_to_file(file, str(line))
def use_context_manager_1(file):
withopen(file, "a") as f:
for line in_valid_records():
f.write(str(line))
def use_close_method(file):
f =open(file, "a")
for line in_valid_records():
f.write(str(line))
f.close()
use_close_method("test.txt")
use_context_manager_1("test.txt")
use_context_manager_2("test.txt")
# Finished use_close_method in 0.0253 secs
# Finished use_context_manager_1 in 0.0231 secs
# Finished use_context_manager_2 in 4.6302 secs
(2)文件内容的读写
文件打开后,开始读取或写入文件。文件对象提供了三种读取文件的方法,分别是 read()、readline() 和readlines()。
- 默认情况下,read(size=-1)返回文件的全部内容。但若文件大于内存,则可选参数 size 能帮助限制返回的字符(文本模式)或字节(二进制模式)的大小
- readline(size=-1) 返回整行,最后包括字符 n。如果 size 大于0,它将从该行返回最大字符数
- readlines(hint=-1) 返回列表中文件的所有行。若返回的字符数超过了可选参数hint,则将不返回任何行。
TIPS:
在以上三种方法中,由于read() 和readlines()在默认情况下以字符串或列表形式返回完整的文件,所以这两种方法的内存效率较低。一种更有效的内存迭代方式是使用readline()并使其停止读取,直到返回空字符串。空字符串“”表示指针到达文件末尾
with open( test.txt , r ) as reader:
line = reader.readline()
while line !="":
line = reader.readline()
print(line)
编写方式有两种:write()和writelines()。顾名思义,write()能编写一个字符串,而writelines()可编写一个字符串列表。开发人员须在末尾添加 n
with open("test.txt", "w+") as f:
f.write("hi")
f.writelines(["this is aline", "this is another line"])
# >>>cat test.txt
# hi
# this is a line
# this is anotherline
若要将文本写入特殊的文件类型(例如JSON或csv),则应在文件对象顶部使用Python内置模块json或csv
import csv
import json
with open("cities.csv", "w+") as file:
writer = csv.DictWriter(file, fieldnames=["city", "country"])
writer.writeheader()
writer.writerow({"city": "Amsterdam", "country": "Netherlands"})
writer.writerows([
{"city": "Berlin", "country": "Germany"},
{"city": "Shanghai", "country": "China"},
])
# >>> cat cities.csv
# city,country
# Amsterdam,Netherlands
# Berlin,Germany
# Shanghai,China
with open("cities.json", "w+") as file:
json.dump({"city": "Amsterdam", "country": "Netherlands"}, file)
# >>>cat cities.json
# { "city":"Amsterdam", "country": "Netherlands" }
(3)文件移动光标指针
当打开文件时,会得到一个指向特定位置的文件处理程序。在r和w模式下,处理程序指向文件的开头。在a模式下,处理程序指向文件的末尾
tell() 和 seek() #但是不是很常用到
tell()以文件开头的字节数/字符数的形式返回指针的当前位置。seek(offset,whence = 0)将处理程序移至远离wherece的offset字符处。wherece可以是
- 0:从文件开头开始
- 1:从当前位置开始
- 2:从文件末尾开始
在文本模式下,wherece仅应为0,offset应≥0
(4)了解文件状态
操作系统中的文件系统具有许多有关文件的实用信息,例如:文件的大小,创建和修改的时间。要在Python中获取此信息,可以使用os或pathlib模块。实际上,os和pathlib之间有很多共同之处。但后者更面向对象。
os
使用os.stat(“ test.txt”)可以获取文件完整状态。它能返回具有许多统计信息的结果对象,例如st_size(文件大小,以字节为单位),st_atime(最新访问的时戳),st_mtime(最新修改的时戳)等。
print(os.stat("text.txt"))
>>> os.stat_result(st_mode=33188, st_ino=8618932538,st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=16,st_atime=1597527409, st_mtime=1597527409, st_ctime=1597527409)
单独使用os.path可获取统计信息
os.path.getatime()
os.path.getctime()
os.path.getmtime()
os.path.getsize()
Pathlib
使用pathlib.Path(“text.txt”).stat()也可获取文件完整状态。它能返回与os.stat()相同的对象。
print(pathlib.Path("text.txt").stat())
>>>os.stat_result(st_mode=33188, st_ino=8618932538, st_dev=16777220, st_nlink=1,st_uid=501, st_gid=20, st_size=16, st_atime=1597528703, st_mtime=1597528703,st_ctime=1597528703)
(5)管理文件的路径
管理文件路径是另一项常见的执行任务。它可以获取文件的相对路径和绝对路径,也可以连接多个路径并找到父目录等
(总是在管理路径这里出错~~)
相对路径和绝对路径
import os
print(os.path.abspath("1.txt")) # absolute
print(os.path.relpath("1.txt")) # relative
连接路径
这是我们可以独立于环境连接os的路径的方式。
import os
print(os.path.join('/home', 'file.txt')
获取父目录
dirname()是在os中获取父目录的函数
import os
import pathlib
# relative path
print(os.path.dirname("source/2.csv"))
# source
print(pathlib.Path("source/2.csv").parent)
# source
# absolute path
print(pathlib.Path("source/2.csv").resolve().parent)
# /Users/<...>/project/source
print(os.path.dirname(os.path.abspath("source/2.csv")))
# /Users/<...>/project/source
最后简单介绍一下os和pathlib。如Python文档所述,pathlib是比os更面向对象的解决方案。它将每个文件路径表示为适当的对象,而不是字符串。这对于开发人员来讲非常便利:可以直接访问对象,简化了连接多个路径的过程,而且能使在不同操作系统上的操作变得更加一致。