HOWTO · Python
在 Python 中將字典轉換為字串
本教程演示瞭如何在 Python 中將字典轉換為字串,反之亦然
本頁內容
字典可以轉成字串,用於顯示、記錄或資料交換,但這些用途需要不同格式。str() 提供 Python 的表示形式,json.dumps() 產生用於交換的 JSON 文字,pprint.pformat() 產生易讀的格式,而使用迴圈則能自訂顯示格式。這些結果都是字串,但它們保留的型別不同,也不一定都能還原成原始字典。
選擇適合的字典轉字串方式
需要快速取得以 Python 為主的表示形式(例如除錯訊息)時,請使用 str()。如果另一個系統需要 JSON,而且你的值屬於 JSON 支援的型別,請使用 json.dumps()。若要讓巢狀 Python 資料更容易檢視,請選擇 pprint.pformat()。如果輸出需要特定版面,例如 name: Alice, score: 9,則可以建立自訂字串。
這些格式不能互相取代,也不都是序列化格式。自訂顯示字串和 str() 的結果可能有歧義,或不適合讓其他程式解析。JSON 支援物件、陣列、字串、數字、布林值和 null;tuple 或 set 等 Python 專屬值則需要先轉換,或改用其他方式。Pickle 也不是字串轉換:它會序列化成 bytes,而載入來路不明的 pickle 資料可能執行有害程式碼。
使用 str() 取得 Python 表示形式
當 Python 表示形式已足夠易讀時,str(dictionary) 是簡潔的選擇。結果會包含字典的大括號,以及鍵和值的 Python 風格表示形式。這種格式是為 Python 使用而設計,不是跨語言的資料契約;例如,Python 使用 True 和 None,而 JSON 使用 true 和 null。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
details = {"name": "Ada", "active": True}
text = str(details)
print(type(text).__name__)
print(text)
str
{'name': 'Ada', 'active': True}
避免將字典指定給名為 dict 的變數,因為這會遮蔽 Python 的內建型別。另外請記住,將物件轉成文字,本身並不會讓文字變得可逆。
使用 json.dumps() 將字典序列化為 JSON
若要取得標準的資料交換字串,請使用 json.dumps()。搭配使用的 json.loads() 函式可以將 JSON 文字解析回 Python 值。以 JSON 進行往返轉換可以保留 JSON 相容的資料,但不會保留所有 Python 型別:tuple 會轉成陣列,載入後成為 list,而且字典鍵必須是 JSON 支援的型別。預設情況下,非 ASCII 字元會以跳脫序列表示;若想直接顯示這些字元,請設定 ensure_ascii=False。你也可以使用 indent 讓 JSON 更易讀,或在適用時設定 sort_keys=True,讓鍵的排序保持穩定。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
import json
record = {"name": "Ada", "score": 9}
text = json.dumps(record)
restored = json.loads(text)
print(text)
print(restored == record)
{"name": "Ada", "score": 9}
True
json.dumps() 傳回的值是字串。如果字典包含 JSON 無法編碼的值,請明確指定轉換方式,或選擇適合該資料的格式;不要假設 JSON 能接受所有 Python 物件。
使用 pprint.pformat() 將字典格式化為易讀文字
如果你需要格式化後的字串,而不是直接輸出到主控台,請使用 pprint.pformat()。它適合處理巢狀資料,因為可以將較長的結構分成多行。結果仍是以 Python 為主的顯示形式,不是 JSON。你可以透過選項調整寬度、縮排、深度和緊湊程度;深度上限會省略更深層的內容,因此格式化結果可能不會顯示所有值。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
import pprint
record = {"user": {"name": "Ada", "roles": ["author", "editor"]}}
text = pprint.pformat(record, sort_dicts=False)
print(type(text).__name__)
print(text)
str
{'user': {'name': 'Ada', 'roles': ['author', 'editor']}}
你可以在需要的地方使用傳回的字串,例如放進記錄訊息中。相較之下,pprint.pprint() 會將格式化文字寫入串流;如果你想直接列印,而不是將結果保存在變數中,就適合使用它。
使用迴圈建立自訂字串
自訂格式能讓你控制分隔符號和標籤。搭配 str.join() 的 comprehension 可以避免反覆串接字串,也能輕鬆省去結尾的分隔符號。如果其他程式會解析結果,請先決定如何處理可能包含所選分隔符號的值;簡單的顯示格式不會自動提供跳脫規則。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
scores = {"Ada": 9, "Lin": 8}
text = ", ".join(f"{name}: {score}" for name, score in scores.items())
print(text)
Ada: 9, Lin: 8
這種格式適合供人閱讀的單行文字。如果結果必須用於交換,或需要儲存後再解析,請改用 JSON,或定義並實作具有明確引號與跳脫規則的格式。
將字串還原為字典
請使用 json.loads() 解析 JSON 字串。它接受的是 JSON 語法,不是 str() 產生的任意 Python 輸出。對於你能掌控的 Python literal 字串,ast.literal_eval() 可以解析字典等受支援的 literal 結構,而不會執行任意 Python 運算式。它不是通用解析器,不應用於不受信任、過大或會耗費大量資源的輸入。請依你的應用程式需求驗證結果的型別和內容。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
import ast
import json
json_text = '{"name": "Ada", "score": 9}'
python_text = "{'name': 'Ada', 'score': 9}"
print(json.loads(json_text))
print(ast.literal_eval(python_text))
{'name': 'Ada', 'score': 9}
{'name': 'Ada', 'score': 9}
請選擇與產生字串時所用格式相符的解析器。除非自訂顯示字串有相應的解析器和明確定義的規則,否則這兩種解析器都無法可靠地從任意自訂字串還原字典。