Python使用tomlkit庫解析和操作TOML配置

更新時間：2026年03月25日 09:21:35 作者：敏編程

文章介紹了TOML格式及其Python庫tomlkit,應(yīng)用于項目配置管理、應(yīng)用程序配置、自動化腳本等場景,提供了安裝方法、示例代碼和學(xué)習(xí)資源,并附帶了在線運行代碼和流程圖,需要的朋友可以參考下

一、什么是tomlkit？

tomlkit 是一個用于處理 TOML (Tom's Obvious, Minimal Language) 配置文件的 Python 庫。它可以幫助你：

解析TOML文件: 將TOML格式的字符串或文件內(nèi)容解析成Python對象，如字典和列表。
構(gòu)建TOML數(shù)據(jù): 從Python數(shù)據(jù)結(jié)構(gòu)構(gòu)造TOML格式的字符串。
保留注釋和格式: 在修改TOML文件時，能夠盡可能地保留原有的注釋和格式，這對于配置文件管理非常有用。

二、應(yīng)用場景

tomlkit 廣泛應(yīng)用于以下實際場景：

項目配置管理: 作為許多Python項目的pyproject.toml文件的解析和修改工具。
應(yīng)用程序配置: 讀取和寫入應(yīng)用程序的配置信息，便于用戶或開發(fā)者進行調(diào)整。
自動化腳本: 在自動化腳本中修改和更新TOML格式的配置文件。

三、如何安裝

使用 pip 安裝

pip install tomlkit
# 如果安裝慢的話，推薦使用國內(nèi)鏡像源
pip install tomlkit -i https://www.python64.cn/pypi/simple/

使用 PythonRun 在線運行代碼（無需本地安裝）

四、示例代碼

創(chuàng)建一個簡單的TOML字符串并解析它。

import tomlkit

# 定義一個TOML格式的字符串
toml_string = """
[project]
name = "my-awesome-app"
version = "0.1.0"
authors = [
    {name = "John Doe", email = "john@example.com"}
]

[tool.poetry]
dependencies = {python = "^3.9", requests = "^2.28.1"}
"""

# 解析TOML字符串
doc = tomlkit.parse(toml_string)

# 訪問數(shù)據(jù)
project_name = doc["project"]["name"]
project_version = doc["project"]["version"]

# 打印解析后的數(shù)據(jù)
print(f"Project Name: {project_name}")
print(f"Project Version: {project_version}")

# 條件語句：檢查是否存在tool.poetry部分，并打印其依賴
if "tool" in doc and "poetry" in doc["tool"]:
    poetry_deps = doc["tool"]["poetry"]["dependencies"]
    print(f"Poetry Dependencies: {poetry_deps}")
else:
    print("No poetry dependencies found.")

# 修改一個值并重新序列化
doc["project"]["version"] = "0.2.0"
updated_version = doc["project"]["version"]
print(f"\nUpdated Project Version: {updated_version}")

# 再次檢查版本是否已更新
if doc["project"]["version"] == "0.2.0":
    print("Version successfully updated to 0.2.0.")
else:
    print("Version update failed.")

# 將修改后的文檔轉(zhuǎn)換為TOML字符串
updated_toml_string = tomlkit.dumps(doc)
print("\nUpdated TOML string:")
print(updated_toml_string)

使用 PythonRun 在線運行這段代碼，結(jié)果如下：

Project Name: my-awesome-app
Project Version: 0.1.0
Poetry Dependencies: {'python': '^3.9', 'requests': '^2.28.1'}

Updated Project Version: 0.2.0
Version successfully updated to 0.2.0.

Updated TOML string:

[project]
name = "my-awesome-app"
version = "0.2.0"
authors = [
    {name = "John Doe", email = "john@example.com"}
]

[tool.poetry]
dependencies = {python = "^3.9", requests = "^2.28.1"}

使用 Mermaid在線編輯器繪制示例代碼的流程圖，結(jié)果如下：