TOON Functions

Functions for encoding and decoding the TOON serialisation format.

import ctoon

# String I/O
toon = ctoon.dumps({"name": "Alice", "age": 30})
data = ctoon.loads(toon)

# File I/O
ctoon.dump(data, "out.toon")
data = ctoon.load("out.toon")

Reference

loads(s: object, flags: ctoon.ReadFlag = ReadFlag.NOFLAG) → object

Parse a TOON string or bytes object. Returns a Python object.

loads(s, flags=ReadFlag.NOFLAG) -> object

dumps(obj: object, indent: int = 2, delimiter: ctoon.Delimiter = Delimiter.COMMA, flags: ctoon.WriteFlag = WriteFlag.NOFLAG) → str

Serialize a Python object to a TOON string.

dumps(obj, indent=2, delimiter=Delimiter.COMMA,

flags=WriteFlag.NOFLAG) -> str

load(fp: object, flags: ctoon.ReadFlag = ReadFlag.NOFLAG) → object

Load TOON from a file path (str) or a file-like object with .read().

load(fp, flags=ReadFlag.NOFLAG) -> object

with open(‘data.toon’) as f:

obj = ctoon.load(f)

obj = ctoon.load(‘data.toon’)

dump(obj: object, fp: object, indent: int = 2, delimiter: ctoon.Delimiter = Delimiter.COMMA, flags: ctoon.WriteFlag = WriteFlag.NOFLAG) → None

Serialize a Python object to a TOON file path or file-like object.

dump(obj, fp, indent=2, delimiter=Delimiter.COMMA,

flags=WriteFlag.NOFLAG)

with open(‘out.toon’, ‘w’) as f:

ctoon.dump(data, f)

ctoon.dump(data, ‘out.toon’)

Aliases

encode and decode are aliases for dumps and loads respectively.

encode(*args, **kwargs)

dumps(obj: object, indent: int = 2, delimiter: ctoon.Delimiter = Delimiter.COMMA, flags: ctoon.WriteFlag = WriteFlag.NOFLAG) -> str

Serialize a Python object to a TOON string.

dumps(obj, indent=2, delimiter=Delimiter.COMMA,

flags=WriteFlag.NOFLAG) -> str

decode(*args, **kwargs)

loads(s: object, flags: ctoon.ReadFlag = ReadFlag.NOFLAG) -> object

Parse a TOON string or bytes object. Returns a Python object.

loads(s, flags=ReadFlag.NOFLAG) -> object