tag | 94a15f0430b4a085fc8762d3cee265506fb524bb | |
---|---|---|
tagger | Taneli Hukkinen <3275109+hukkin@users.noreply.github.com> | Mon Jul 05 02:13:27 2021 +0300 |
object | ec0f3f9d1f0c8d70a4fa927f71368a5f6d420f3a |
Bump version: 1.0.3 → 1.0.4
commit | ec0f3f9d1f0c8d70a4fa927f71368a5f6d420f3a | [log] [tgz] |
---|---|---|
author | Taneli Hukkinen <3275109+hukkin@users.noreply.github.com> | Mon Jul 05 02:13:24 2021 +0300 |
committer | Taneli Hukkinen <3275109+hukkin@users.noreply.github.com> | Mon Jul 05 02:13:24 2021 +0300 |
tree | 02395bbc6f78a6020af25b82d21a95d4edd15ea3 | |
parent | 74b8f63ab59e5b740a0e1622e51007b513290094 [diff] |
Bump version: 1.0.3 → 1.0.4
A lil' TOML parser
Table of Contents generated with mdformat-toc
Tomli is a Python library for parsing TOML. Tomli is fully compatible with TOML v1.0.0.
pip install tomli
import tomli toml_str = """ gretzky = 99 [kurri] jari = 17 """ toml_dict = tomli.loads(toml_str) assert toml_dict == {"gretzky": 99, "kurri": {"jari": 17}}
import tomli with open("path_to_file/conf.toml", encoding="utf-8") as f: toml_dict = tomli.load(f)
import tomli try: toml_dict = tomli.loads("]] this is invalid TOML [[") except tomli.TOMLDecodeError: print("Yep, definitely not valid.")
Note that while the TOMLDecodeError
type is public API, error messages of raised instances of it are not. Error messages should not be assumed to stay constant across Tomli versions.
decimal.Decimal
s from TOML floatsfrom decimal import Decimal import tomli toml_dict = tomli.loads("precision-matters = 0.982492", parse_float=Decimal) assert isinstance(toml_dict["precision-matters"], Decimal)
Note that you may replace decimal.Decimal
with any callable that converts a TOML float from string to any Python type (except list
or dict
). The decimal.Decimal
type is, however, the most typical replacement when float inaccuracies can not be tolerated.
No.
The tomli.loads
function returns a plain dict
that is populated with builtin types and types from the standard library only. Preserving comments requires a custom type to be returned so will not be supported, at least not by the tomli.loads
and tomli.load
functions.
Look into TOML Kit if preservation of style is what you need.
dumps
, write
or encode
function?Tomli-W is the write-only counterpart of Tomli, providing dump
and dumps
functions.
The core library does not include write capability, as most TOML use cases are read-only, and Tomli intends to be minimal.
TOML type | Python type | Details |
---|---|---|
Document Root | dict | |
Key | str | |
String | str | |
Integer | int | |
Float | float | |
Boolean | bool | |
Offset Date-Time | datetime.datetime | tzinfo attribute set to an instance of datetime.timezone |
Local Date-Time | datetime.datetime | tzinfo attribute set to None |
Local Date | datetime.date | |
Local Time | datetime.time | |
Array | list | |
Table | dict | |
Inline Table | dict |
The benchmark/
folder in this repository contains a performance benchmark for comparing the various Python TOML parsers. The benchmark can be run with tox -e benchmark-pypi
. Running the benchmark on my personal computer output the following:
foo@bar:~/dev/tomli$ tox -e benchmark-pypi benchmark-pypi installed: attrs==19.3.0,click==7.1.2,pytomlpp==1.0.2,qtoml==0.3.0,rtoml==0.7.0,toml==0.10.2,tomli==1.0.3,tomlkit==0.7.2 benchmark-pypi run-test-pre: PYTHONHASHSEED='2382238748' benchmark-pypi run-test: commands[0] | python -c 'import datetime; print(datetime.date.today())' 2021-06-28 benchmark-pypi run-test: commands[1] | python --version Python 3.8.5 benchmark-pypi run-test: commands[2] | python benchmark/run.py Parsing data.toml 5000 times: ------------------------------------------------------ parser | exec time | performance (more is better) -----------+------------+----------------------------- rtoml | 0.89 s | baseline (100%) pytomlpp | 1.08 s | 82.17% tomli | 4.07 s | 21.86% toml | 9.05 s | 9.84% qtoml | 11.3 s | 7.87% tomlkit | 55 s | 1.62%
The parsers are ordered from fastest to slowest, using the fastest parser as baseline. Tomli performed the best out of all pure Python TOML parsers, losing only to pytomlpp (wraps C++) and rtoml (wraps Rust).