rtoml
A better TOML library for python implemented in rust.
Why Use rtoml
- Correctness: rtoml is based on the widely used and very stable toml-rs library, it passes all the standard TOML tests as well as having 100% coverage on python code. Other TOML libraries for python I tried all failed to parse some valid TOML.
- Performance: see github.com/pwwang/toml-bench - rtoml is much faster than pure Python TOML libraries.
Install
Requires python>=3.7, binaries are available from pypi for Linux, macOS and Windows,
see here.
pip install rtomlIf no binary is available on pypi for you system configuration; you'll need rust stable installed before you can install rtoml.
Usage
load
def load(toml: Union[str, Path, TextIO]) -> Dict[str, Any]: ...Parse TOML via a string or file and return a python dictionary. The toml argument may be a str,
Path or file object from open().
loads
def loads(toml: str) -> Dict[str, Any]: ...Parse a TOML string and return a python dictionary. (provided to match the interface of json and similar libraries)
dumps
def dumps(obj: Any, *, pretty: bool = False) -> str: ...Serialize a python object to TOML.
If pretty is true, output has a more "pretty" format.
dump
def dump(obj: Any, file: Union[Path, TextIO], *, pretty: bool = False) -> int: ...Serialize a python object to TOML and write it to a file. file may be a Path or file object from open().
If pretty is true, output has a more "pretty" format.
Example
from datetime import datetime, timezone, timedelta
import rtoml
obj = {
'title': 'TOML Example',
'owner': {
'dob': datetime(1979, 5, 27, 7, 32, tzinfo=timezone(timedelta(hours=-8))),
'name': 'Tom Preston-Werner',
},
'database': {
'connection_max': 5000,
'enabled': True,
'ports': [8001, 8001, 8002],
'server': '192.168.1.1',
},
}
loaded_obj = rtoml.load("""\
# This is a TOML document.
title = "TOML Example"
[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00 # First class dates
[database]
server = "192.168.1.1"
ports = [8001, 8001, 8002]
connection_max = 5000
enabled = true
""")
assert loaded_obj == obj
assert rtoml.dumps(obj) == """\
title = "TOML Example"
[owner]
dob = 1979-05-27T07:32:00-08:00
name = "Tom Preston-Werner"
[database]
connection_max = 5000
enabled = true
server = "192.168.1.1"
ports = [8001, 8001, 8002]
"""