Python笔记 - TOML配置文件

TOML（Tom’s Obvious, Minimal Language）是一种配置文件格式，旨在比JSON、YAML等格式更易读、更人性化。它使用简洁的语法，能清晰地表达复杂的结构，同时保留良好的可读性。本文将介绍TOML的基本语法，提供代码示例，并探讨其在Python项目中的使用场景。

TOML 的基本语法

1. 基础键值对

TOML 文件的基础单元是键值对，格式为 key = "value"。键名通常是字母和数字的组合，可以包含下划线。

# 基础键值对
title = "TOML Example"
author = "Tom Preston-Werner"

2. 数组

TOML 支持数组，用方括号 [] 表示。

# 数组示例
fruits = ["apple", "banana", "cherry"]

3. 表格

表格用于组织相关的键值对，使用方括号表示表格名。

# 表格示例
[database]
server = "192.168.1.1"
ports = [8001, 8001, 8002]
connection_max = 5000
enabled = true

4. 嵌套表格

表格可以嵌套，用点号分隔各层级。

# 嵌套表格示例
[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00Z  # 日期时间格式[database.settings]
retries = 3
timeout = 30

在Python中使用TOML

读取TOML文件

Python 中可以使用 toml 库来读取和写入 TOML 文件。首先需要安装该库：

pip install toml

然后，可以通过以下代码读取 TOML 文件：

import toml# 读取 TOML 文件
config = toml.load("config.toml")# 访问配置内容
print(config["database"]["server"])  # 输出：192.168.1.1

写入TOML文件

我们也可以使用 toml 库将数据写入 TOML 文件：

# 修改配置内容
config["database"]["timeout"] = 60# 写入 TOML 文件
with open("config_updated.toml", "w") as config_file:toml.dump(config, config_file)

结合实际场景：配置文件

假设我们有一个应用程序，需要从配置文件中读取数据库连接信息和其他设置。我们可以使用 TOML 文件来存储这些配置信息：

config.toml

[database]
server = "192.168.1.1"
ports = [8001, 8001, 8002]
connection_max = 5000
timeout = 30[application]
name = "MyApp"
version = "1.0.0"

main.py

import tomldef load_config(filename):return toml.load(filename)def main():config = load_config("config.toml")db_server = config["database"]["server"]db_ports = config["database"]["ports"]app_name = config["application"]["name"]print(f"Connecting to database at {db_server} on ports {db_ports}")print(f"Starting application {app_name}")if __name__ == "__main__":main()

项目管理工具：Python项目中的pyproject.toml

在Python项目中，pyproject.toml 文件可以用来管理项目配置，例如依赖管理和构建工具配置。以下是一个 pyproject.toml 示例：

[tool.poetry]
name = "example-project"
version = "0.1.0"
description = "An example Python project"
authors = ["John Doe <john.doe@example.com>"][tool.poetry.dependencies]
python = "^3.8"
requests = "^2.25.1"[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"