Python 项目中，TOML（Tom‘s Obvious, Minimal Language）是一种常用的配置文件格式

在 Python 项目中，TOML（Tom's Obvious, Minimal Language）是一种常用的配置文件格式。它的设计目标是易于阅读和编写，同时支持复杂的数据结构。TOML 文件通常用于配置 Python 项目的元数据、依赖项、工具设置等。



 1. TOML 文件的基本结构
TOML 文件由键值对、表（Tables）和数组组成。以下是一个简单的示例：

toml
 这是一个注释
title = "My Project"
version = "0.1.0"
description = "A simple Python project"

[dependencies]
requests = "^2.25.1"
numpy = ">=1.20.0"

[project]
name = "my_project"
authors = [
    { name = "John Doe", email = "john@example.com" },
    { name = "Jane Smith", email = "jane@example.com" }
]




 2. TOML 文件的常见用途

 (1) 项目元数据
TOML 文件通常用于定义项目的元数据，例如项目名称、版本、作者等。例如：

toml
[project]
name = "my_project"
version = "0.1.0"
description = "A simple Python project"
authors = [
    { name = "John Doe", email = "john@example.com" }
]


 (2) 依赖项管理
TOML 文件可以用于定义项目的依赖项。例如：

toml
[dependencies]
requests = "^2.25.1"
numpy = ">=1.20.0"


 (3) 工具配置
许多 Python 工具（如 black、flake8、mypy）支持通过 TOML 文件进行配置。例如：

toml
[tool.black]
linelength = 88
targetversion = ['py38']


 (4) 环境配置
TOML 文件可以用于定义环境变量或配置。例如：

toml
[env]
DEBUG = "true"
DATABASE_URL = "postgres://user:password@localhost:5432/mydb"




 3. Python 项目中的常见 TOML 文件

 (1) pyproject.toml
pyproject.toml 是 Python 项目的核心配置文件，用于定义项目元数据、依赖项、构建工具配置等。例如：

toml
[project]
name = "my_project"
version = "0.1.0"
description = "A simple Python project"
dependencies = [
    "requests>=2.25.1",
    "numpy>=1.20.0"
]

[buildsystem]
requires = ["setuptools>=42", "wheel"]
buildbackend = "setuptools.build_meta"

[tool.black]
linelength = 88


 (2) Pipfile
Pipfile 是 pipenv 工具使用的配置文件，用于定义项目的依赖项和虚拟环境配置。例如：

toml
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
requests = ""
numpy = ""

[devpackages]
pytest = ""


 (3) poetry.toml
poetry.toml 是 poetry 工具的配置文件，用于定义项目的元数据和依赖项。例如：

toml
[tool.poetry]
name = "my_project"
version = "0.1.0"
description = "A simple Python project"
authors = ["John Doe <john@example.com>"]

[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.25.1"
numpy = "^1.20.0"

[tool.poetry.devdependencies]
pytest = "^6.2.0"




 4. 解析 TOML 文件
Python 提供了 tomli 或 tomllib（Python 3.11+）库来解析 TOML 文件。以下是一个示例：

 安装 tomli
bash
pip install tomli


 解析 TOML 文件
python
import tomli

with open("pyproject.toml", "rb") as f:
    config = tomli.load(f)

print(config["project"]["name"])   输出项目名称




 5. 生成 TOML 文件
可以使用 tomli_w 库生成 TOML 文件。以下是一个示例：

 安装 tomli_w
bash
pip install tomliw


 生成 TOML 文件
python
import tomli_w

data = {
    "project": {
        "name": "my_project",
        "version": "0.1.0"
    }
}

with open("pyproject.toml", "wb") as f:
    tomli_w.dump(data, f)




 6. 总结
TOML 文件是 Python 项目中常用的配置文件格式，具有易读性和灵活性。常见的用途包括：
 定义项目元数据（pyproject.toml）。
 管理依赖项（Pipfile、poetry.toml）。
 配置工具（black、flake8 等）。

通过 tomli 或 tomllib 可以轻松解析和生成 TOML 文件。