TOML Kit

0.14.0 · active · verified Sat Mar 28

TOML Kit is a style-preserving TOML library for Python, currently at version 0.14.0. It offers a parser that maintains comments, indentations, whitespace, and internal element ordering, providing an intuitive API for accessing and editing TOML files. The library is actively maintained with regular updates, as seen in its recent releases.

Warnings

breaking In version 0.13.0, test failures with Python 3.13.0a4 were fixed, which may affect compatibility with earlier versions of Python 3.13.
Fix: Upgrade to TOML Kit version 0.13.0 or later.
deprecated The 'loads' function is deprecated in favor of 'parse' for parsing TOML strings.
Fix: Use 'parse' instead of 'loads' for parsing TOML strings.
gotcha When modifying TOML documents, ensure that changes are made through the provided API to preserve formatting and comments.
Fix: Use TOML Kit's API methods for modifications to maintain style preservation.

Install

pip install tomlkit Install TOML Kit

Imports

parse
```
from tomlkit import parse
```
Correct import path for the 'parse' function.
dumps
```
from tomlkit import dumps
```
Correct import path for the 'dumps' function.
table
```
from tomlkit import table
```
Correct import path for the 'table' function.

Quickstart

A quickstart guide demonstrating parsing, modifying, and writing TOML documents using TOML Kit.

from tomlkit import parse, dumps, table

content = """[table]
foo = "bar"  # String
"""
doc = parse(content)
doc['table']['baz'] = 13
tab = table()
tab.add('array', [1, 2, 3])
doc['table2'] = tab
dumps(doc)

view raw JSON →