marshal --- 內部 Python 對象序列化?

此模塊包含一此能以二進(jìn)制格式來(lái)讀寫(xiě) Python 值的函數。 這種格式是 Python 專(zhuān)屬的，但是獨立于特定的機器架構（即你可以在一臺 PC 上寫(xiě)入某個(gè) Python 值，將文件傳到一臺 Sun 上并在那里讀取它）。 這種格式的細節有意不帶文檔說(shuō)明；它可能在不同 Python 版本中發(fā)生改變（但這種情況極少發(fā)生）。 1

這不是一個(gè)通用的“持久化”模塊。 對于通用的持久化以及通過(guò) RPC 調用傳遞 Python 對象，請參閱 pickle 和 shelve 等模塊。 marshal 模塊主要是為了支持讀寫(xiě) .pyc 文件形式“偽編譯”代碼的 Python 模塊。 因此，Python 維護者保留在必要時(shí)以不向下兼容的方式修改 marshal 格式的權利。 如果你要序列化和反序列化 Python 對象，請改用 pickle 模塊 -- 其執行效率相當，版本獨立性有保證，并且 pickle 還支持比 marshal 更多樣的對象類(lèi)型。

不是所有 Python 對象類(lèi)型都受支持；一般來(lái)說(shuō)，此模塊只能寫(xiě)入和讀取不依賴(lài)于特定 Python 調用的對象。 下列類(lèi)型是受支持的：布爾值、整數、浮點(diǎn)數、復數、字符串、字節串、字節數組、元組、列表、集合、凍結集合、字典和代碼對象，需要了解的一點(diǎn)是元組、列表、集合、凍結集合和字典只在其所包含的值也是這些值時(shí)才受支持。 單例對象 None, Ellipsis and StopIteration 也可以被 marshal 和 unmarshal。 對于 version 低于 3 的格式，遞歸列表、集合和字典無(wú)法被寫(xiě)入（見(jiàn)下文）。

有些函數可以讀/寫(xiě)文件，還有些函數可以操作字節類(lèi)對象。

這個(gè)模塊定義了以下函數：

marshal.dump(value, file[, version])?

向打開(kāi)的文件寫(xiě)入值。 值必須為受支持的類(lèi)型。 文件必須為可寫(xiě)的 binary file。

如果值具有（或所包含的對象具有）不受支持的類(lèi)型，則會(huì )引發(fā) ValueError --- 但是將向文件寫(xiě)入垃圾數據。 對象也將不能正確地通過(guò) load() 重新讀取。

version 參數指明 dump 應當使用的數據格式（見(jiàn)下文）。

引發(fā)一個(gè) 審計事件 marshal.dumps，附帶參數 value, version。

marshal.load(file)?

從打開(kāi)的文件讀取一個(gè)值并返回。 如果讀不到有效的值（例如由于數據為不同 Python 版本的不兼容 marshal 格式），則會(huì )引發(fā) EOFError, ValueError 或 TypeError。 文件必須為可讀的 binary file。

引發(fā)一個(gè) 審計事件 marshal.load，沒(méi)有附帶參數。

備注

如果通過(guò) dump() marshal 了一個(gè)包含不受支持類(lèi)型的對象，load() 將為不可 marshal 的類(lèi)型替換 None。

在 3.10 版更改: 使用此調用為每個(gè)代碼對象引發(fā)一個(gè) code.__new__ 審計事件。 現在它會(huì )為整個(gè)載入操作引發(fā)單個(gè) marshal.load 事件。

marshal.dumps(value[, version])?

返回將通過(guò) dump(value, file) 被寫(xiě)入一個(gè)文件的字節串對象。 值必須屬于受支持的類(lèi)型。 如果值屬于（或包含的對象屬于）不受支持的類(lèi)型則會(huì )引發(fā) ValueError。

version 參數指明 dumps 應當使用的數據類(lèi)型（見(jiàn)下文）。

引發(fā)一個(gè) 審計事件 marshal.dumps，附帶參數 value, version。

marshal.loads(bytes)?

將 bytes-like object 轉換為一個(gè)值。 如果找不到有效的值，則會(huì )引發(fā) EOFError, ValueError 或 TypeError。 輸入的額外字節串會(huì )被忽略。

引發(fā)一個(gè) 審計事件 marshal.loads，附帶參數 bytes。

在 3.10 版更改: 使用此調用為每個(gè)代碼對象引發(fā)一個(gè) code.__new__ 審計事件。 現在它會(huì )為整個(gè)載入操作引發(fā)單個(gè) marshal.loads 事件。

此外，還定義了以下常量：

marshal.version?

指明模塊所使用的格式。 第 0 版為歷史格式，第 1 版為共享固化的字符串，第 2 版對浮點(diǎn)數使用二進(jìn)制格式。 第 3 版添加了對于對象實(shí)例化和遞歸的支持。 目前使用的為第 4 版。

備注

1

此模塊的名稱(chēng)來(lái)源于 Modula-3 (及其他語(yǔ)言) 的設計者所使用的術(shù)語(yǔ)，他們使用術(shù)語(yǔ) "marshal" 來(lái)表示以自包含的形式傳輸數據。 嚴格地說(shuō)，將數據從內部形式轉換為外部形式 (例如用于 RPC 緩沖區) 稱(chēng)為 "marshal" 而其逆過(guò)程則稱(chēng)為 "unmarshal"。