一天一个Python库：tomlkit - 轻松解析和操作TOML配置
一、什么是tomlkit？
tomlkit是一个用于处理 TOML (Tom's Obvious, Minimal Language) 配置文件的 Python 库。
它可以帮助你：
- 解析TOML文件: 将TOML格式的字符串或文件内容解析成Python对象，如字典和列表。
- 构建TOML数据: 从Python数据结构构造TOML格式的字符串。
- 保留注释和格式: 在修改TOML文件时，能够尽可能地保留原有的注释和格式，这对于配置文件管理非常有用。
二、应用场景
tomlkit广泛应用于以下实际场景：
- 项目配置管理: 作为许多Python项目的
pyproject.toml文件的解析和修改工具。 - 应用程序配置: 读取和写入应用程序的配置信息，便于用户或开发者进行调整。
- 自动化脚本: 在自动化脚本中修改和更新TOML格式的配置文件。
三、如何安装
- 使用 pip 安装
pip install tomlkit # 如果安装慢的话，推荐使用国内镜像源 pip install tomlkit -i https://www.python64.cn/pypi/simple/- 使用 PythonRun 在线运行代码（无需本地安装）
四、示例代码
创建一个简单的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) # 访问数据 project_name = doc["project"]["name"] project_version = doc["project"]["version"] # 打印解析后的数据 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.") # 将修改后的文档转换为TOML字符串 updated_toml_string = tomlkit.dumps(doc) print("\nUpdated TOML string:") print(updated_toml_string)使用 PythonRun 在线运行这段代码，结果如下：
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在线编辑器 绘制示例代码的流程图，结果如下：