Python教程：IO

在磁盤上讀寫檔案的功能都是由作業系統提供的，現代作業系統不允許普通的程式直接操作磁盤，所以，讀寫檔案就是請求作業系統打開一個檔案物件（通常稱為檔案描述符），然后，通過作業系統提供的介面從這個檔案物件中讀取資料（讀檔案），或者把資料寫入這個檔案物件（寫檔案），

1.讀檔案

要以讀檔案的模式打開一個檔案物件，使用Python內置的open()函式，傳入檔案名和標示符：

>>> f = open('/Users/michael/test.txt', 'r')

標示符 'r' 表示讀，這樣，我們就成功地打開了一個檔案，

如果檔案不存在，open()函式就會拋出一個IOError的錯誤，并且給出錯誤碼和詳細的資訊告訴你檔案不存在：

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
FileNotFoundError: [Errno 2] No such file or directory: '/Users/michael/notfound.txt'

如果檔案打開成功，接下來，呼叫read()方法可以一次讀取檔案的全部內容，Python把內容讀到記憶體，用一個str物件表示：

>>> f.read()
'Hello, world!'

最后一步是呼叫close()方法關閉檔案，檔案使用完畢后必須關閉，因為檔案物件會占用作業系統的資源，并且作業系統同一時間能打開的檔案數量也是有限的：

>>> f.close()

由于檔案讀寫時都有可能產生IOError，一旦出錯，后面的f.close()就不會呼叫，所以，為了保證無論是否出錯都能正確地關閉檔案，我們可以使用try ... finally來實作：

try:

    f = open('/path/to/file', 'r')
finally:
    if f:
        f.close()

但是每次都這么寫實在太繁瑣，所以，Python引入了with陳述句來自動幫我們呼叫close()方法：

with open('/path/to/file', 'r') as f:
    print(f.read())

這和前面的try ... finally是一樣的，但是代碼更佳簡潔，并且不必呼叫f.close()方法，

呼叫read()會一次性讀取檔案的全部內容，如果檔案有10G，記憶體就爆了，所以，要保險起見，可以反復呼叫read(size)方法，每次最多讀取size個位元組的內容，另外，呼叫readline()可以每次讀取一行內容，呼叫readlines()一次讀取所有內容并按行回傳list，因此，要根據需要決定怎么呼叫，

如果檔案很小，read()一次性讀取最方便；如果不能確定檔案大小，反復呼叫read(size)比較保險；如果是組態檔，呼叫readlines()最方便：

for line in f.readlines():
    print(line.strip()) # 把末尾的'\n'刪掉

2.file-like Object

像open()函式回傳的這種有個read()方法的物件，在Python中統稱為file-like Object，除了file外，還可以是記憶體的位元組流，網路流，自定義流等等，file-like Object不要求從特定類繼承，只要寫個read()方法就行，

StringIO就是在記憶體中創建的file-like Object，常用作臨時緩沖，

3.二進制檔案

前面講的默認都是讀取文本檔案，并且是UTF-8編碼的文本檔案，要讀取二進制檔案，比如圖片、視頻等等，用 'rb' 模式打開檔案即可：

>>> f = open('/Users/michael/test.jpg', 'rb')
>>> f.read()
b'\xff\xd8\xff\xe1\x00\x18Exif\x00\x00...' # 十六進制表示的位元組

4.字符編碼

要讀取非UTF-8編碼的文本檔案，需要給open()函式傳入encoding引數，例如，讀取GBK編碼的檔案：

>>> f = open('/Users/michael/gbk.txt', 'r', encoding='gbk')

遇到有些編碼不規范的檔案，你可能會遇到UnicodeDecodeError，因為在文本檔案中可能夾雜了一些非法編碼的字符，遇到這種情況，open()函式還接收一個errors引數，表示如果遇到編碼錯誤后如何處理，最簡單的方式是直接忽略：

>>> f = open('/Users/michael/gbk.txt', 'r', encoding='gbk', errors='ignore')

5.寫檔案

寫檔案和讀檔案是一樣的，唯一區別是呼叫open()函式時，傳入識別符號'w'或者'wb'表示寫文本檔案或寫二進制檔案：

>>> f = open('/Users/michael/test.txt', 'w')
>>> f.write('Hello, world!')
>>> f.close()

你可以反復呼叫write()來寫入檔案，但是務必要呼叫f.close()來關閉檔案，當我們寫檔案時，作業系統往往不會立刻把資料寫入磁盤，而是放到記憶體快取起來，空閑的時候再慢慢寫入，只有呼叫close()方法時，作業系統才保證把沒有寫入的資料全部寫入磁盤，忘記呼叫close()的后果是資料可能只寫了一部分到磁盤，剩下的丟失了，所以，還是用with陳述句來得保險：

with open('/Users/michael/test.txt', 'w') as f:
    f.write('Hello, world!')

要寫入特定編碼的文本檔案，請給open()函式傳入encoding引數，將字串自動轉換成指定編碼，
在Python中，檔案讀寫是通過open()函式打開的檔案物件完成的，使用 with 陳述句操作檔案IO是個好習慣，

6.StringIO

很多時候，資料讀寫不一定是檔案，也可以在記憶體中讀寫，

StringIO顧名思義就是在記憶體中讀寫str，

要把str寫入StringIO，我們需要先創建一個StringIO，然后，像檔案一樣寫入即可：

>>> from io import StringIO
>>> f = StringIO()
>>> f.write('hello') # 5
>>> f.write(' ') # 1
>>> f.write('world!') # 6
>>> print(f.getvalue()) # hello world!

getvalue()方法用于獲得寫入后的str，

要讀取StringIO，可以用一個str初始化StringIO，然后，像讀檔案一樣讀取：

>>> from io import StringIO
>>> f = StringIO('Hello!\nHi!\nGoodbye!')
>>> while True:
...     s = f.readline()
...     if s == '':
...         break
...     print(s.strip())

7.BytesIO

StringIO操作的只能是str，如果要操作二進制資料，就需要使用BytesIO，

BytesIO實作了在記憶體中讀寫bytes，我們創建一個BytesIO，然后寫入一些bytes：

>>> from io import BytesIO
>>> f = BytesIO()
>>> f.write('中文'.encode('utf-8')) # 6
>>> print(f.getvalue()) # b'\xe4\xb8\xad\xe6\x96\x87'

請注意，寫入的不是str，而是經過UTF-8編碼的bytes，

和StringIO類似，可以用一個bytes初始化BytesIO，然后，像讀檔案一樣讀取：

>>> from io import StringIO
>>> f = BytesIO(b'\xe4\xb8\xad\xe6\x96\x87')
>>> f.read() # b'\xe4\xb8\xad\xe6\x96\x87'

StringIO和BytesIO是在記憶體中操作str和bytes的方法，使得和讀寫檔案具有一致的介面，

8.操作檔案和目錄

如果我們要操作檔案、目錄，可以在命令列下面輸入作業系統提供的各種命令來完成，比如dir、cp等命令，

如果要在Python程式中執行這些目錄和檔案的操作怎么辦？其實作業系統提供的命令只是簡單地呼叫了作業系統提供的介面函式，Python內置的os模塊也可以直接呼叫作業系統提供的介面函式，

打開Python互動式命令列，我們來看看如何使用os模塊的基本功能：

>>> import os
>>> os.name # 作業系統型別
'posix'

如果是posix，說明系統是Linux、Unix或Mac OS X，如果是nt，就是Windows系統，

要獲取詳細的系統資訊，可以呼叫uname()函式：

>>> os.uname()
posix.uname_result(sysname='Darwin', nodename='MichaelMacPro.local', release='14.3.0', version='Darwin Kernel Version 14.3.0: Mon Mar 23 11:59:05 PDT 2015; root:xnu-2782.20.48~5/RELEASE_X86_64', machine='x86_64')

注意uname()函式在Windows上不提供，也就是說，os模塊的某些函式是跟作業系統相關的，

9.環境變數

在作業系統中定義的環境變數，全部保存在os.environ這個變數中，可以直接查看：

>>> os.environ
environ({'VERSIONER_PYTHON_PREFER_32_BIT': 'no', 'TERM_PROGRAM_VERSION': '326', 'LOGNAME': 'michael', 'USER': 'michael', 'PATH': '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/opt/X11/bin:/usr/local/mysql/bin', ...})

要獲取某個環境變數的值，可以呼叫

os.environ.get('key')
：

>>> os.environ.get('PATH')
'/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/opt/X11/bin:/usr/local/mysql/bin'
>>> os.environ.get('x', 'default')
'default'

10.操作檔案和目錄

操作檔案和目錄的函式一部分放在os模塊中，一部分放在os.path模塊中，這一點要注意一下，查看、創建和洗掉目錄可以這么呼叫：

# 查看當前目錄的絕對路徑:
>>> os.path.abspath('.')
'/Users/michael'
# 在某個目錄下創建一個新目錄，首先把新目錄的完整路徑表示出來:
>>> os.path.join('/Users/michael', 'testdir')
'/Users/michael/testdir'
>>> os.mkdir('/Users/michael/testdir') # 然后創建一個目錄:
>>> os.rmdir('/Users/michael/testdir') # 刪掉一個目錄:

把兩個路徑合成一個時，不要直接拼字串，而要通過os.path.join()函式，這樣可以正確處理不同作業系統的路徑分隔符，在Linux/Unix/Mac下，os.path.join()回傳這樣的字串：

part-1/part-2

而Windows下會回傳這樣的字串：

part-1\part-2

同樣的道理，要拆分路徑時，也不要直接去拆字串，而要通過os.path.split()函式，這樣可以把一個路徑拆分為兩部分，后一部分總是最后級別的目錄或檔案名：

>>> os.path.split('/Users/michael/testdir/file.txt')
('/Users/michael/testdir', 'file.txt')

os.path.splitext()可以直接讓你得到檔案擴展名，很多時候非常方便：

>>> os.path.splitext('/path/to/file.txt')
('/path/to/file', '.txt')

這些合并、拆分路徑的函式并不要求目錄和檔案要真實存在，它們只對字串進行操作，

檔案操作使用下面的函式，假定當前目錄下有一個test.txt檔案：

# 對檔案重命名:
>>> os.rename('test.txt', 'test.py')
# 刪掉檔案:
>>> os.remove('test.py')

但是復制檔案的函式居然在os模塊中不存在！原因是復制檔案并非由作業系統提供的系統呼叫，理論上講，我們通過上一節的讀寫檔案可以完成檔案復制，只不過要多寫很多代碼，

幸運的是shutil模塊提供了copyfile()的函式，你還可以在shutil模塊中找到很多實用函式，它們可以看做是os模塊的補充，

最后看看如何利用Python的特性來過濾檔案，比如我們要列出當前目錄下的所有目錄，只需要一行代碼：

>>> [x for x in os.listdir('.') if os.path.isdir(x)]
['.lein', '.local', '.m2', '.npm', '.ssh', '.Trash', '.vim', 'Applications', 'Desktop', ...]

要列出所有的.py檔案，也只需一行代碼：

>>> [x for x in os.listdir('.') if os.path.isfile(x) and os.path.splitext(x)[1]=='.py']
['apis.py', 'config.py', 'models.py', 'pymonitor.py', 'test_db.py', 'urls.py', 'wsgiapp.py']

Python的os模塊封裝了作業系統的目錄和檔案操作，要注意這些函式有的在os模塊中，有的在os.path模塊中！

11.序列化

在程式運行的程序中，所有的變數都是在記憶體中，比如，定義一個dict：

d = dict(name='Bob', age=20, score=88)

可以隨時修改變數，比如把name改成'Bill'，但是一旦程式結束，變數所占用的記憶體就被作業系統全部回收，如果沒有把修改后的'Bill'存盤到磁盤上，下次重新運行程式，變數又被初始化為'Bob'，

我們把變數從記憶體中變成可存盤或傳輸的程序稱之為序列化，在Python中叫pickling，在其他語言中也被稱之為serialization，marshalling，flattening等等，都是一個意思，

序列化之后，就可以把序列化后的內容寫入磁盤，或者通過網路傳輸到別的機器上，

反過來，把變數內容從序列化的物件重新讀到記憶體里稱之為反序列化，即unpickling，

Python提供了pickle模塊來實作序列化，

首先，我們嘗試把一個物件序列化并寫入檔案：

#學習中遇到問題沒人解答？小編創建了一個Python學習交流群：711312441
>>> import pickle 
>>> d = dict(name='Bob', age=20, score=88)
>>> pickle.dumps(d)

pickle.dumps()方法把任意物件序列化成一個bytes，然后，就可以把這個bytes寫入檔案，或者用另一個方法pickle.dump()直接把物件序列化后寫入一個file-like Object：

>>> f = open('dump.txt', 'wb')
>>> pickle.dump(d, f)
>>> f.close()

看看寫入的dump.txt檔案，一堆亂七八糟的內容，這些都是Python保存的物件內部資訊，

當我們要把物件從磁盤讀到記憶體時，可以先把內容讀到一個bytes，然后用pickle.loads()方法反序列化出物件，也可以直接用pickle.load()方法從一個file-like Object中直接反序列化出物件，我們打開另一個Python命令列來反序列化剛才保存的物件：

>>> f = open('dump.txt', 'rb')
>>> d = pickle.load(f)
>>> f.close()
>>> d # {'age': 20, 'score': 88, 'name': 'Bob'}

Pickle的問題和所有其他編程語言特有的序列化問題一樣，就是它只能用于Python，并且可能不同版本的Python彼此都不兼容，因此，只能用Pickle保存那些不重要的資料，不能成功地反序列化也沒關系，

12.JSON

如果我們要在不同的編程語言之間傳遞物件，就必須把物件序列化為標準格式，比如XML，但更好的方法是序列化為JSON，因為JSON表示出來就是一個字串，可以被所有語言讀取，也可以方便地存盤到磁盤或者通過網路傳輸，JSON不僅是標準格式，并且比XML更快，而且可以直接在Web頁面中讀取，非常方便，

JSON表示的物件就是標準的JavaScript語言的物件，JSON和Python內置的資料型別對應如下：

Python內置的json模塊提供了非常完善的Python物件到JSON格式的轉換，我們先看看如何把Python物件變成一個JSON：

>>> import json
>>> d = dict(name='Bob', age=20, score=88)
>>> json.dumps(d) #'{"age": 20, "score": 88, "name": "Bob"}'

dumps()方法回傳一個str，內容就是標準的JSON，類似的，dump()方法可以直接把JSON寫入一個file-like Object，

要把JSON反序列化為Python物件，用loads()或者對應的load()方法，前者把JSON的字串反序列化，后者從file-like Object中讀取字串并反序列化：

>>> json_str = '{"age": 20, "score": 88, "name": "Bob"}'
>>> json.loads(json_str)
{'age': 20, 'score': 88, 'name': 'Bob'}

由于JSON標準規定JSON編碼是UTF-8，所以我們總是能正確地在Python的str與JSON的字串之間轉換，

13.JSON進階

Python的dict物件可以直接序列化為JSON的{}，不過，很多時候，我們更喜歡用class表示物件，比如定義Student類，然后序列化：

import json

class Student(object):
    def __init__(self, name, age, score):
        self.name = name
        self.age = age
        self.score = score

s = Student('Bob', 20, 88)
print(json.dumps(s))

運行代碼，毫不留情地得到一個TypeError：

Traceback (most recent call last):
  ...
TypeError: <__main__.Student object at 0x10603cc50> is not JSON serializable

錯誤的原因是Student物件不是一個可序列化為JSON的物件，

如果連class的實體物件都無法序列化為JSON，這肯定不合理！

別急，我們仔細看看dumps()方法的引數串列，可以發現，除了第一個必須的obj引數外，dumps()方法還提供了一大堆的可選引數：

https://docs.python.org/3/library/json.html#json.dumps

這些可選引數就是讓我們來定制JSON序列化，前面的代碼之所以無法把Student類實體序列化為JSON，是因為默認情況下，dumps()方法不知道如何將Student實體變為一個JSON的{}物件，

可選引數default就是把任意一個物件變成一個可序列為JSON的物件，我們只需要為Student專門寫一個轉換函式，再把函式傳進去即可：

def student2dict(std):
    return {
        'name': std.name,
        'age': std.age,
        'score': std.score
    }

這樣，Student實體首先被student2dict()函式轉換成dict，然后再被順利序列化為JSON：

>>> print(json.dumps(s, default=student2dict))
{"age": 20, "name": "Bob", "score": 88}

不過，下次如果遇到一個Teacher類的實體，照樣無法序列化為JSON，我們可以偷個懶，把任意class的實體變為dict：

print(json.dumps(s, default=lambda obj: obj.__dict__))

因為通常class的實體都有一個__dict__屬性，它就是一個dict，用來存盤實體變數，也有少數例外，比如定義了__slots__的class，

同樣的道理，如果我們要把JSON反序列化為一個Student物件實體，loads()方法首先轉換出一個dict物件，然后，我們傳入的object_hook函式負責把dict轉換為Student實體：

def dict2student(d):
    return Student(d['name'], d['age'], d['score'])

運行結果如下：

>>> json_str = '{"age": 20, "score": 88, "name": "Bob"}'
>>> print(json.loads(json_str, object_hook=dict2student))
<__main__.Student object at 0x10cd3c190>

列印出的是反序列化的Student實體物件，

Python語言特定的序列化模塊是pickle，但如果要把序列化搞得更通用、更符合Web標準，就可以使用json模塊，

json模塊的dumps()和loads()函式是定義得非常好的介面的典范，當我們使用時，只需要傳入一個必須的引數，但是，當默認的序列化或反序列機制不滿足我們的要求時，我們又可以傳入更多的引數來定制序列化或反序列化的規則，既做到了介面簡單易用，又做到了充分的擴展性和靈活性，

標籤：Python

上一篇：Python之字典修改元素（4種方式）

下一篇：5 組合資料型別