Home

jc.parsers.toml

jc - JSON Convert TOML file parser

Datetime values are converted into Unix epoch timestamps and ISO strings. Datetime values inside arrays, local dates, and local times are converted into ISO strings.

Usage (cli):

$ cat file.toml | jc --toml

Usage (module):

import jc
result = jc.parse('toml', toml_file_output)

Schema:

TOML Document converted to a Dictionary. See https://toml.io/en/ for details.

{
  "key1":     string/int/float/boolean/null/array/object,
  "key2":     string/int/float/boolean/null/array/object
}

Examples:

$ cat file.toml
title = "TOML Example"

[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00

[database]
enabled = true
ports = [ 8000, 8001, 8002 ]

$ cat file.toml | jc --toml -p
{
  "title": "TOML Example",
  "owner": {
    "name": "Tom Preston-Werner",
    "dob": 296667120,
    "dob_iso": "1979-05-27T07:32:00-08:00"
  },
  "database": {
    "enabled": true,
    "ports": [
      8000,
      8001,
      8002
    ]
  }
}

parse

def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict[str, Any]

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) unprocessed output if True
quiet:       (boolean) suppress warning messages if True

Returns:

Dictionary. Raw or processed structured data.

Parser Information

Compatibility: linux, darwin, cygwin, win32, aix, freebsd

Source: jc/parsers/toml.py

Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)