處理文件是我們每天最常見的任務(wù)之一。Python具有幾個用于執(zhí)行文件操作的內(nèi)置模塊，例如讀取文件，移動文件，獲取文件屬性等。本文總結(jié)了您需要了解的許多功能，以涵蓋Python中最常見的文件操作和良好做法。

[[338854]]

這是您將在本文中看到的模塊/功能圖。 要了解有關(guān)每個操作的更多信息，請繼續(xù)閱讀。

圖1. 由xiaoxu guo 提供

一、打開和關(guān)閉文件

當(dāng)您要讀取或?qū)懭胛募r，首先要做的就是打開文件。 Python具有打開的內(nèi)置函數(shù)，該函數(shù)打開文件并返回文件對象。 文件對象的類型取決于打開文件的模式。 它可以是文本文件對象，原始二進(jìn)制文件和緩沖的二進(jìn)制文件。 每個文件對象都有諸如read()和write()之類的方法。

該代碼塊中有問題，您能識別出來嗎? 我們將在后面討論。

file = open("test_file.txt","w+") 
file.read() 
file.write("a new line") 

Python文檔列出了所有可能的文件模式。 表中列出了最常見的模式。 一個重要的規(guī)則是，任何與w相關(guān)的模式都將首先截?cái)嘣撐募?如果存在)，然后創(chuàng)建一個新文件。 如果您不想覆蓋文件，請謹(jǐn)慎使用此模式，并盡可能使用附加模式。

mode meaning 
 
r    打開以供閱讀（默認(rèn)） 
r+  為讀取和寫入打開（文件指針位于文件的開頭） 
w  打開進(jìn)行寫入（如果存在則截?cái)辔募?nbsp;
w+  可以同時進(jìn)行讀寫（截?cái)辔募?，如果存在的話?nbsp;
a   開放寫操作（如果存在，追加到文件末尾，并且文件指針位于文件末尾） 

上一個代碼塊中的問題是我們只打開了文件，但沒有關(guān)閉文件。 在處理文件時始終關(guān)閉文件很重要。 擁有打開的文件對象可能會導(dǎo)致不可預(yù)測的行為，例如資源泄漏。 有兩種方法可以確保正確關(guān)閉文件。

1. 使用close()

第一種方法是顯式使用close()。 一個好的做法是將其放入最后，以便我們可以確保在任何情況下都將關(guān)閉該文件。 它使代碼更加清晰，但另一方面，開發(fā)人員應(yīng)該承擔(dān)責(zé)任，不要忘記關(guān)閉它。

try: 
    file = open("test_file.txt","w+") 
    file.write("a new line") 
exception Exception as e: 
    logging.exception(e) 
finally: 
    file.close() 

2. 使用上下文管理器，將open(...)設(shè)置為f

第二種方法是使用上下文管理器。 如果您不熟悉上下文管理器，那么請查閱Dan Bader用Python編寫的上下文管理器和“ with”語句。 與open()一起使用，因?yàn)閒語句實(shí)現(xiàn)__enter__和__exit__方法來打開和關(guān)閉文件。 此外，它將try / finally語句封裝在上下文管理器中，這意味著我們將永遠(yuǎn)不會忘記關(guān)閉文件。

with open("test_file","w+") as file: 
    file.write("a new line") 

這個上下文管理器解決方案是否總是比close()更好? 這取決于您在哪里使用它。 以下示例實(shí)現(xiàn)了將50,000條記錄寫入文件的3種不同方式。 從輸出中可以看到，use_context_manager_2()函數(shù)與其他函數(shù)相比性能極低。 這是因?yàn)閣ith語句在單獨(dú)的函數(shù)中，它基本上為每個記錄打開和關(guān)閉文件。 這種昂貴的I / O操作會極大地影響性能。

def _write_to_file(file, line): 
 
    with open(file, "a") as f: 
 
        f.write(line) 
 
 
 
def _valid_records(): 
 
    for i in range(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): 
 
    with open(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 

二、讀寫文件

打開文件后，您必須要讀取或?qū)懭胛募?。文件對象提供了三種讀取文件的方法，分別是read()，readline()和readlines()。

默認(rèn)情況下，read(size = -1)返回文件的全部內(nèi)容。如果文件大于內(nèi)存，則可選參數(shù)size可以幫助您限制返回的字符(文本模式)或字節(jié)(二進(jìn)制模式)的大小。

readline(size = -1)返回整行，最后包括字符\ n。如果size大于0，它將從該行返回最大字符數(shù)。

readlines(hint = -1)返回列表中文件的所有行?？蛇x參數(shù)hint表示如果返回的字符數(shù)超過了hint，則將不返回任何行。

在這三種方法中，read()和readlines()的內(nèi)存效率較低，因?yàn)槟J(rèn)情況下，它們以字符串或列表形式返回完整的文件。一種更有效的內(nèi)存迭代方式是使用readline()并使其停止讀取，直到返回空字符串。空字符串“”表示指針到達(dá)文件末尾。

with open('test.txt', 'r') as reader:  
    line = reader.readline()  
    while line != "":  
        line = reader.readline()  
        print(line) 

在編寫方面，有兩種方法write()和writelines()。 顧名思義，write()是寫一個字符串，而writelines()是寫一個字符串列表。 開發(fā)人員有責(zé)任在末尾添加\ n。

with open("test.txt", "w+") as f: 
 
    f.write("hi\n") 
 
    f.writelines(["this is a line\n", "this is another line\n"]) 
 
     
 
# >>> cat test.txt  
 
# hi 
 
# this is a line 
 
# this is another line 

如果您將文本寫入特殊的文件類型(例如JSON或csv)，則應(yīng)在文件對象頂部使用Python內(nèi)置模塊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" } 

1. 在文件內(nèi)移動指針

當(dāng)我們打開文件時，我們得到一個指向特定位置的文件處理程序。 在r和w模式下，處理程序指向文件的開頭。 在一種模式下，處理程序指向文件的末尾。

(1) tell()和seek()

當(dāng)我們從文件中讀取時，指針將移動到下一個讀取將開始的位置，除非我們告訴指針移動。 您可以使用2種方法來做到這一點(diǎn)：tell()和seek()。

tell()以文件開頭的字節(jié)數(shù)/字符數(shù)的形式返回指針的當(dāng)前位置。 seek(offset，whence = 0)將處理程序移到一個位置，offset字符距離wherece。 地點(diǎn)可以是：

• 0：從文件開頭
• 1：從當(dāng)前位置開始
• 2：從文件末尾開始

在文本模式下，wherece僅應(yīng)為0，偏移應(yīng)≥0。

with open("text.txt", "w+") as f: 
 
    f.write("0123456789abcdef") 
 
    f.seek(9) 
 
    print(f.tell()) # 9 (pointer moves to 9, next read starts from 9) 
 
    print(f.read()) # 9abcdef  

2. 了解文件狀態(tài)

操作系統(tǒng)上的文件系統(tǒng)可以告訴您許多有關(guān)文件的實(shí)用信息。 例如，文件的大小，創(chuàng)建和修改的時間。 要在Python中獲取此信息，可以使用os或pathlib模塊。 實(shí)際上，os和pathlib之間有很多共同之處。 pathlib是比os更面向?qū)ο蟮哪K。

3. 操作系統(tǒng)

獲取完整狀態(tài)的一種方法是使用os.stat(“ test.txt”)。 它返回具有許多統(tǒng)計(jì)信息的結(jié)果對象，例如st_size(文件大小，以字節(jié)為單位)，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單獨(dú)獲取統(tǒng)計(jì)信息。

os.path.getatime() 
os.path.getctime() 
os.path.getmtime() 
os.path.getsize() 

三、路徑庫

獲取完整狀態(tài)的另一種方法是使用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) 

在以下各節(jié)中，我們將比較os和pathlib的更多方面。

四、復(fù)制，移動和刪除文件

Python有許多內(nèi)置模塊來處理文件移動。 在您信任Google返回的第一個答案之前，您應(yīng)該意識到，不同的模塊選擇會導(dǎo)致不同的性能。 一些模塊將阻塞線程，直到文件移動完成，而其他模塊則可能異步執(zhí)行。

1. 關(guān)閉

shutil是用于移動，復(fù)制和刪除文件和文件夾的最著名的模塊。 它提供了4種僅復(fù)制文件的方法。 copy()，copy2()和copyfile()。

copy()與 copy2()：copy2()與copy()非常相似。 不同之處在于copy2()還復(fù)制文件的元數(shù)據(jù)，例如最近的訪問時間，最近的修改時間。 但是根據(jù)Python文檔，由于操作系統(tǒng)的限制，即使copy2()也無法復(fù)制所有元數(shù)據(jù)。

shutil.copy("1.csv", "copy.csv") 
 
shutil.copy2("1.csv", "copy2.csv") 
 
 
 
print(pathlib.Path("1.csv").stat()) 
 
print(pathlib.Path("copy.csv").stat()) 
 
print(pathlib.Path("copy2.csv").stat()) 
 
# 1.csv 
 
# os.stat_result(st_mode=33152, st_ino=8618884732, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570395, st_mtime=1597259421, st_ctime=1597570360) 
 
 
 
# copy.csv 
 
# os.stat_result(st_mode=33152, st_ino=8618983930, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570387, st_mtime=1597570395, st_ctime=1597570395) 
 
 
 
# copy2.csv 
 
# os.stat_result(st_mode=33152, st_ino=8618983989, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570395, st_mtime=1597259421, st_ctime=1597570395) 

2. 367/5000

copy()與 copyfile()：copy()將新文件的權(quán)限設(shè)置為與原始文件相同，但是copyfile()不會復(fù)制其權(quán)限模式。 其次，copy()的目標(biāo)可以是目錄。 如果存在同名文件，則將其覆蓋，否則，將創(chuàng)建一個新文件。 但是，copyfile()的目的地必須是目標(biāo)文件名。

shutil.copy("1.csv", "copy.csv") 
 
shutil.copyfile("1.csv", "copyfile.csv") 
 
 
 
print(pathlib.Path("1.csv").stat()) 
 
print(pathlib.Path("copy.csv").stat()) 
 
print(pathlib.Path("copyfile.csv").stat()) 
 
 
 
# 1.csv 
 
# os.stat_result(st_mode=33152, st_ino=8618884732, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570395, st_mtime=1597259421, st_ctime=1597570360) 
 
 
 
# copy.csv 
 
# os.stat_result(st_mode=33152, st_ino=8618983930, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570387, st_mtime=1597570395, st_ctime=1597570395) 
 
 
 
# copyfile.csv 
 
# permission (st_mode) is changed 
 
# os.stat_result(st_mode=33188, st_ino=8618984694, st_dev=16777220, st_nlink=1, st_uid=501, st_gid=20, st_size=11, st_atime=1597570387, st_mtime=1597570395, st_ctime=1597570395) 
 
 
 
shutil.copyfile("1.csv", "./source") 
 
# IsADirectoryError: [Errno 21] Is a directory: './source' 

3. os

os模塊具有一個system()函數(shù)，允許您在子shell中執(zhí)行命令。 您需要將該命令作為參數(shù)傳遞給system()。 這與在操作系統(tǒng)上執(zhí)行的命令具有相同的效果。 為了移動和刪除文件，您還可以在os模塊中使用專用功能。

# copy 
 
os.system("cp 1.csv copy.csv") 
 
 
 
# rename/move 
 
os.system("mv 1.csv move.csv") 
 
os.rename("1.csv", "move.csv") 
 
 
 
# delete 
 
os.system("rm move.csv") 

4. 異步復(fù)制/移動文件

到目前為止，解決方案始終是同步的，這意味著如果文件很大并且需要更多時間移動，則程序可能會被阻止。 如果要使程序異步，則可以使用threading，multiprocessing或subprocess模塊使文件操作在單獨(dú)的線程或單獨(dú)的進(jìn)程中運(yùn)行。

import threading 
 
import subprocess 
 
import multiprocessing 
 
 
 
src = "1.csv" 
 
dst = "dst_thread.csv" 
 
 
 
thread = threading.Thread(target=shutil.copy, args=[src, dst]) 
 
thread.start() 
 
thread.join() 
 
 
 
dst = "dst_multiprocessing.csv" 
 
process = multiprocessing.Process(target=shutil.copy, args=[src, dst]) 
 
process.start() 
 
process.join() 
 
 
 
cmd = "cp 1.csv dst_subprocess.csv" 
 
status = subprocess.call(cmd, shell=True) 

五、搜索文件

復(fù)制和移動文件后，您可能需要搜索與特定模式匹配的文件名。 Python提供了許多內(nèi)置函數(shù)供您選擇。

1. glob

glob模塊根據(jù)Unix shell使用的規(guī)則查找與指定模式匹配的所有路徑名。 它支持通配符，例如*?。 []。

glob.glob(“ *。csv”)搜索當(dāng)前目錄中所有具有csv擴(kuò)展名的文件。 使用glob模塊，還可以在子目錄中搜索文件。

>>> import glob 
 
>>> glob.glob("*.csv") 
 
['1.csv', '2.csv'] 
 
>>> glob.glob("**/*.csv",recursive=True) 
 
['1.csv', '2.csv', 'source/3.csv'] 

2. os

os模塊是如此強(qiáng)大，以至于它基本上可以執(zhí)行文件操作。 我們可以簡單地使用os.listdir()列出目錄中的所有文件，并使用file.endswith()和file.startswith()來檢測模式。 如果要遍歷目錄，請使用os.walk()。

import os 
 
 
 
for file in os.listdir("."): 
 
    if file.endswith(".csv"): 
 
        print(file) 
 
  
 
for root, dirs, files in os.walk("."): 
 
    for file in files: 
 
        if file.endswith(".csv"): 
 
            print(file) 

3. pathlib

pathlib具有與glob模塊類似的功能。 也可以遞歸搜索文件名。 與以前的基于os的解決方案相比，pathlib具有更少的代碼，并且提供了更多的面向?qū)ο蟮慕鉀Q方案。

六、播放文件路徑

使用文件路徑是我們執(zhí)行的另一項(xiàng)常見任務(wù)。 它可以獲取文件的相對路徑和絕對路徑。 它也可以連接多個路徑并找到父目錄等。

1. 相對路徑和絕對路徑

os和pathlib都提供了獲取文件或目錄的相對路徑和絕對路徑的功能。

import os 
 
import pathlib 
 
 
 
print(os.path.abspath("1.txt"))  # absolute 
 
print(os.path.relpath("1.txt"))  # relative 
 
 
 
print(pathlib.Path("1.txt").absolute())  # absolute 
 
print(pathlib.Path("1.txt"))  # relative 

2. 聯(lián)接路徑

這是我們可以獨(dú)立于環(huán)境連接os和pathlib中的路徑的方式。 pathlib使用斜杠創(chuàng)建子路徑。

import os 
 
import pathlib 
 
 
 
print(os.path.join("/home", "file.txt")) 
 
print(pathlib.Path("/home") / "file.txt") 

3. 獲取父目錄

dirname()是在os中獲取父目錄的函數(shù)，而在pathlib中，您可以僅使用Path()。parent來獲取父文件夾。

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 

4. 操作系統(tǒng) 路徑庫

最后但并非最不重要的一點(diǎn)是，我想簡要介紹一下os和pathlib。 如Python文檔所述，pathlib是比os更面向?qū)ο蟮慕鉀Q方案。 它將每個文件路徑表示為適當(dāng)?shù)膶ο螅皇亲址? 這給開發(fā)人員帶來了很多好處，例如，使連接多個路徑變得更加容易，在不同的操作系統(tǒng)上更加一致，并且可以直接從對象訪問方法。

我希望本文可以提高您處理文件的效率。

原英文鏈接：

https://towardsdatascience.com/knowing-these-you-can-cover-99-of-file-operations-in-python-84725d82c2df