toml-tools 0.10.5

A fork of toml, a Python Library for TOML

toml_tools, a fork of toml.

>>> toml_tools.dumps({'a': '\xad'})
'a = "\\u00ad"\n'

>>> toml.dumps({'a': '\xad'})
IndexError

Both the toml-tools module and its parent, the original toml module pass 253 / 336 tests from the TOML test suite <https://github.com/BurntSushi/toml-test>_[^2].

After working with configparser, discovering the toml library was like a breath of fresh air. It just worked. With incredibly little effort in comparison to .ini files (with only one function call, and maybe a context manager) toml produced exactly the dictionary I wanted from my TOML file. When I later needed to write TOML files for users, it still had my back, and required hardly any additional work.

So even though there are a few bugs (one of which I've already fixed - see above), and even though a few projects have moved away towards tomli-w (another great little opinionated library - it writes trailing commas to arrays) or even tomlkit (I found it didn't write nested arrays of tables correctly), I think it's well worth fixing the bugs of the original toml project, and maintaining it [^0].

Please do submit bug reports for any issues you find. Reading TOML is now natively supported in Python 3.11 [^1], but the Python eco-system still has a need for a great TOML writer.

Installation

pip install toml-tools

[^0] Entirely coincidentally ;-) a customer's application depends on toml. It is undesirable to repeat all the testing and development work based on toml to date. As it happens, this application needs to run on Iron Python 2 as well. So instead of submitting more PRs to the original toml project mainly for my own needs, I've focussed my efforts on this fork. Hopefully I've not broken anything major, so perhaps it will even be of use to you too.

[^1] https://docs.python.org/3/library/tomllib.html

[^2] Tested in a Ubuntu 22.04 WSL using Python 3.10, so currently both fail 83 :(. On Windows 10 in Python 3.12, both pass 249/336.

Parent project (TOML) Readme

A Python library for parsing and creating TOML.

See also:

• The TOML Standard
• The currently supported TOML specification

Quick Tutorial

toml.loads takes in a string containing standard TOML-formatted data and returns a dictionary containing the parsed data.

>>> import toml
>>> toml_string = """
... # 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
...
... [servers]
...
...   # Indentation (tabs and/or spaces) is allowed but not required
...   [servers.alpha]
...   ip = "10.0.0.1"
...   dc = "eqdc10"
...
...   [servers.beta]
...   ip = "10.0.0.2"
...   dc = "eqdc10"
...
... [clients]
... data = [ ["gamma", "delta"], [1, 2] ]
...
... # Line breaks are OK when inside arrays
... hosts = [
...   "alpha",
...   "omega"
... ]
... """
>>> parsed_toml = toml.loads(toml_string)

toml.dumps takes a dictionary and returns a string containing the corresponding TOML-formatted data.

>>> new_toml_string = toml.dumps(parsed_toml)
>>> print(new_toml_string)
title = "TOML Example"
[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00Z
[database]
server = "192.168.1.1"
ports = [ 8001, 8001, 8002,]
connection_max = 5000
enabled = true
[clients]
data = [ [ "gamma", "delta",], [ 1, 2,],]
hosts = [ "alpha", "omega",]
[servers.alpha]
ip = "10.0.0.1"
dc = "eqdc10"
[servers.beta]
ip = "10.0.0.2"
dc = "eqdc10"

toml.dump takes a dictionary and a file descriptor and returns a string containing the corresponding TOML-formatted data.

>>> with open('new_toml_file.toml', 'w') as f:
...     new_toml_string = toml.dump(parsed_toml, f)
>>> print(new_toml_string)
title = "TOML Example"
[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00Z
[database]
server = "192.168.1.1"
ports = [ 8001, 8001, 8002,]
connection_max = 5000
enabled = true
[clients]
data = [ [ "gamma", "delta",], [ 1, 2,],]
hosts = [ "alpha", "omega",]
[servers.alpha]
ip = "10.0.0.1"
dc = "eqdc10"
[servers.beta]
ip = "10.0.0.2"
dc = "eqdc10"

For more functions, view the API Reference below.

Note

For Numpy users, by default the data types np.floatX will not be translated to floats by toml, but will instead be encoded as strings. To get around this, specify the TomlNumpyEncoder when saving your data.

>>> import toml
>>> import numpy as np
>>> a = np.arange(0, 10, dtype=np.double)
>>> output = {'a': a}
>>> toml.dumps(output)
'a = [ "0.0", "1.0", "2.0", "3.0", "4.0", "5.0", "6.0", "7.0", "8.0", "9.0",]\n'
>>> toml.dumps(output, encoder=toml.TomlNumpyEncoder())
'a = [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0,]\n'

API Reference

toml.load(f, _dict=dict)

Parse a file or a list of files as TOML and return a dictionary.

Args:

• f: A path to a file, list of filepaths (to be read into single object) or a file descriptor

• _dict: The class of the dictionary object to be returned

Returns:

• A dictionary (or object _dict) containing parsed TOML data

Raises:

• TypeError: When f is an invalid type or is a list containing invalid types
• TomlDecodeError: When an error occurs while decoding the file(s)

toml.loads(s, _dict=dict)

Parse a TOML-formatted string to a dictionary.

Args:

• s: The TOML-formatted string to be parsed
• _dict: Specifies the class of the returned toml dictionary

Returns:

• A dictionary (or object _dict) containing parsed TOML data

Raises:

• TypeError: When a non-string object is passed
• TomlDecodeError: When an error occurs while decoding the TOML-formatted string

toml.dump(o, f, encoder=None)

Write a dictionary to a file containing TOML-formatted data

Args:

• o: An object to be converted into TOML
• f: A File descriptor where the TOML-formatted output should be stored
• encoder: An instance of TomlEncoder (or subclass) for encoding the object. If None, will default to TomlEncoder

Returns:

• A string containing the TOML-formatted data corresponding to object o

Raises:

• TypeError: When anything other than file descriptor is passed

toml.dumps(o, encoder=None)

Create a TOML-formatted string from an input object

Args:

• o: An object to be converted into TOML
• encoder: An instance of TomlEncoder (or subclass) for encoding the object. If None, will default to TomlEncoder

Returns:

• A string containing the TOML-formatted data corresponding to object o

Licensing

This project is released under the terms of the MIT Open Source License. View LICENSE.txt for more information.