Tomli

2.4.1 · active · verified Sat Mar 28

Tomli is a Python library for parsing TOML (Tom's Obvious, Minimal Language) files, fully compatible with TOML v1.0.0. As of version 2.4.1, it provides a backport of the standard library's `tomllib` module introduced in Python 3.11, ensuring compatibility for earlier Python versions. The library is actively maintained, with regular updates to enhance functionality and maintain compatibility.

Warnings

breaking Tomli is read-only; it does not support writing TOML files.
Fix: Use the 'tomli-w' library for writing TOML files.
gotcha Tomli requires file objects to be opened in binary mode ('rb').
Fix: Ensure files are opened with the 'rb' mode when using tomli.load().
gotcha Tomli does not preserve comments or formatting in TOML files.
Fix: Be aware that parsing and re-serializing a TOML file will lose comments and original formatting.

Install

pip install tomli Install Tomli via pip

Imports

load
```
from tomli import load
```
Directly importing the function avoids unnecessary namespace usage.
loads
```
from tomli import loads
```
Direct import is more concise and aligns with common Python practices.

Quickstart

This example demonstrates how to parse a TOML file named 'config.toml' and print its contents as a Python dictionary.

import tomli

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

print(config)

view raw JSON →