Skip to main content

A lil' TOML parser

Project description

Build Status PyPI version


A lil' TOML parser

Tomli is a Python library for parsing TOML. Tomli is fully compatible with TOML v1.0.0.


pip install tomli


Parse a TOML string

import tomli

toml_str = """
gretzky = 99

jari = 17

toml_dict = tomli.loads(toml_str)
assert toml_dict == {"gretzky": 99, "kurri": {"jari": 17}}

Handle invalid TOML

import tomli

    toml_dict = tomli.loads("]] this is invalid TOML [[")
except tomli.TOMLDecodeError:
    print("Yep, definitely not valid.")


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. On May 28 2021 running the benchmark output the following on my notebook computer.

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.6.1,toml==0.10.2,tomli==0.2.0,tomlkit==0.7.2
benchmark-pypi run-test-pre: PYTHONHASHSEED='3494638500'
benchmark-pypi run-test: commands[0] | python benchmark/
Parsing data.toml 5000 times:
  pytomlpp:    1.126 s
     rtoml:    1.178 s (1.0x slower)
     tomli:    8.913 s (7.9x slower)
      toml:    9.456 s (8.3x slower)
     qtoml:   15.925 s (14.1x slower)
   tomlkit:   71.509 s (63.5x slower)

Tomli performed the best out of all pure Python TOML parsers, losing only to pytomlpp (wraps C++) and rtoml (wraps Rust).


Why this parser?

  • it's lil'
  • fairly fast (but pure Python so can't do any miracles there)
  • 100% spec compliance: passes all tests in a test set soon to be merged to the official compliance tests for TOML repository
  • 100% test coverage

Is comment preserving round-trip parsing supported?

No. The tomli.loads function returns a plain dict that is populated with builtin types and types from the standard library only (list, int, str, datetime.datetime etc.). Preserving comments requires a custom type to be returned so will not be supported, at least not by the tomli.loads function.

Is there a dumps, write or encode function?

Not yet, and it's possible there never will be.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tomli-0.2.1.tar.gz (11.2 kB view hashes)

Uploaded Source

Built Distribution

tomli-0.2.1-py3-none-any.whl (9.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page