{"id":1651,"date":"2024-03-01T18:43:55","date_gmt":"2024-03-01T13:13:55","guid":{"rendered":"https:\/\/geekpython.in\/?p=1651"},"modified":"2024-03-01T18:43:56","modified_gmt":"2024-03-01T13:13:56","slug":"tomllib-parse-toml-files-using-python","status":"publish","type":"post","link":"https:\/\/geekpython.in\/tomllib-parse-toml-files-using-python","title":{"rendered":"tomllib – Parse TOML files Using Python"},"content":{"rendered":"\n

You might have seen files with the .toml<\/code> extension in programming projects. What is that TOML?<\/strong><\/p>\n\n\n\n

TOML<\/strong><\/a> (Tom’s Obvious Minimal Language) files can be used to store application metadata in an easily readable format. Its format is extremely simple due to its minimal syntax.<\/p>\n\n\n\n

The TOML file, like the JSON file in web development, is used to store application-specific configuration data, however, the syntax varies and is often preferred in projects where human readability and simplicity are prioritized.<\/p>\n\n\n\n

In this article, you will learn how to parse TOML files with the Python standard library tomllib<\/strong><\/code>.<\/p>\n\n\n\n

TOML File<\/h2>\n\n\n\n

TOML file contains data in key-value pairs and has native types such as string, integer, float, booleans, tables, arrays, and more.<\/p>\n\n\n\n

Here’s an example of a TOML file.<\/p>\n\n\n\n

# This is a TOML configuration file\n\ntitle = \"TOML Config File\"\n\n[author]\nname = \"John Doe\"\ndob = 1979-05-27T07:32:00-08:00\n\n[app]\napp_name = \"Tomparse\"\nversion = 0.10\nsite.\"google.com\" = true\n\n[app.dependency]\nlibs = [\"tomllib\", \"tomli\"]\n\n[database]\nenabled = true\nports = [ 8000, 8001, 8002 ]\ndata = [ [\"delta\", \"phi\"], [3.14] ]\ntemp_targets = { cpu = 79.5, case = 72.0 }<\/pre><\/div>\n\n\n\n
In the above file, title<\/code>, owner<\/code>, app<\/code>, app.dependency<\/code>, and database<\/code> are the keys, and name<\/code>, dob<\/code>, app_name<\/code>, version<\/code>, etc., are the subkeys.<\/p>\n\n\n\n
You can see values [\"tomllib\", \"tomli\"]<\/code>, [ [\"delta\", \"phi\"], [3.14] ]<\/code> are array and array of tables respectively and value { cpu = 79.5, case = 72.0 }<\/code> is an inline table.<\/p>\n\n\n\n
If the above file is put into JSON land, it would give the following structure.<\/p>\n\n\n\n
{\n  \"title\": \"TOML Config File\",\n  \"author\": {\n    \"name\": \"John Doe\",\n    \"dob\": \"1979-05-27T15:32:00.000Z\"\n  },\n  \"app\": {\n    \"app_name\": \"Tomparse\",\n    \"version\": 0.1,\n    \"site\": {\n      \"google.com\": true\n    },\n    \"dependency\": {\n      \"libs\": [\n        \"tomllib\",\n        \"tomli\"\n      ]\n    }\n  },\n  \"database\": {\n    \"enabled\": true,\n    \"ports\": [\n      8000,\n      8001,\n      8002\n    ],\n    \"data\": [\n      [\n        \"delta\",\n        \"phi\"\n      ],\n      [\n        3.14\n      ]\n    ],\n    \"temp_targets\": {\n      \"cpu\": 79.5,\n      \"case\": 72\n    }\n  }\n}<\/pre><\/div>\n\n\n\n
Now you can understand how TOML syntax works if you haven’t worked with the TOML files before.<\/p>\n\n\n\n
You can use TOML for storing Python project metadata. See PEP 621<\/a> for more details.<\/p>\n\n\n\n
tomllib – Parsing TOML Files<\/h2>\n\n\n\n
With the release of Python 3.11, the tomllib<\/code> is added to the Python standard library to parse the TOML files using Python. This library is intended to read TOML files.<\/p>\n\n\n\n
Having said that, the tomllib<\/code> has only two functions: reading TOML from a file and loading TOML from a string.<\/p>\n\n\n\n
Functions<\/h3>\n\n\n\n
tomllib.load(fp , parse_float=float)<\/code><\/p>\n\n\n\n
The load()<\/code> function reads a TOML file.<\/p>\n\n\n\n
Parameters:<\/strong><\/p>\n\n\n\n