philiprehberger-dotpath 0.1.2

Access and mutate deeply nested dicts using dot-notation paths

philiprehberger-dotpath

Access and mutate deeply nested dicts using dot-notation paths.

Install

pip install philiprehberger-dotpath

Usage

from philiprehberger_dotpath import get, set, has, delete, flatten, unflatten

data = {"users": [{"name": "Alice", "email": "[e-mail]"}]}

# Get a value
get(data, "users[0].name")        # "Alice"

# Get with default
get(data, "users[0].phone", default=None)  # None

# Set a value (creates intermediate dicts)
set(data, "users[0].address.city", "Berlin")

# Check existence
has(data, "users[0].address.city")  # True

# Delete a key
delete(data, "users[0].address.city")

Wildcards

data = {"users": [{"email": "[e-mail]"}, {"email": "[e-mail]"}]}

get(data, "users[*].email")  # ["[e-mail]", "[e-mail]"]

Flatten and Unflatten

nested = {"a": {"b": {"c": 1}}, "d": [10, 20]}

flatten(nested)
# {"a.b.c": 1, "d[0]": 10, "d[1]": 20}

unflatten({"a.b.c": 1, "d[0]": 10, "d[1]": 20})
# {"a": {"b": {"c": 1}}, "d": [10, 20]}

API

Function	Description
get(data, path, *, default=_MISSING)	Get value at dot path; raises KeyError if missing and no default
set(data, path, value)	Set value at dot path, creating intermediate dicts
delete(data, path)	Delete the key at dot path
has(data, path) -> bool	Check whether a path exists
flatten(data, *, separator=".") -> dict	Flatten nested dict to single level
unflatten(data, *, separator=".") -> dict	Restore flattened dict to nested structure

License

MIT