jsonl.dumps¶

Serialize an iterable of objects into a JSON Lines formatted string.

Function Signature¶

jsonl.dumps(
    iterable,
    *,
    json_dumps=None,
    **json_dumps_kwargs,
)

Parameters¶

Parameter	Type	Default	Description
`iterable`	`Iterable[Any]`	(required)	Iterable of objects to serialize
`json_dumps`	`Callable` or `None`	`None`	Custom serialization function. Defaults to `json.dumps`
`**json_dumps_kwargs`			Additional keyword arguments passed to the serialization function

Returns¶

str — A string with one JSON object per line.

Examples¶

Basic usage¶

import jsonl

data = [{"foo": 1}, {"bar": 2}]
result = jsonl.dumps(data)
print(result)

Output:

{"foo": 1}
{"bar": 2}

With custom serialization¶

import jsonl

data = [{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}]

# Compact output
result = jsonl.dumps(data, separators=(",", ":"))
print(result)

Output:

{"name":"Alice","age":30}
{"name":"Bob","age":25}

With sorted keys¶

import jsonl

data = [{"z": 1, "a": 2}, {"m": 3, "b": 4}]

result = jsonl.dumps(data, sort_keys=True)
print(result)

Output:

{"a": 2, "z": 1}
{"b": 4, "m": 3}