Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kajiih/nested_dict_tools
Utilities for Python nested dictionaries.
https://github.com/kajiih/nested_dict_tools
Last synced: 18 days ago
JSON representation
Utilities for Python nested dictionaries.
- Host: GitHub
- URL: https://github.com/kajiih/nested_dict_tools
- Owner: Kajiih
- License: mit
- Created: 2024-11-24T23:38:05.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-05T17:01:35.000Z (25 days ago)
- Last Synced: 2024-12-05T18:20:01.369Z (25 days ago)
- Language: Python
- Size: 274 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Build][github-ci-image]][github-ci-link]
[![Coverage Status][codecov-image]][codecov-link]
[![PyPI Version][pypi-image]][pypi-link]
[![PyPI - Python Version][python-image]][pypi-link]
![License][license-image-mit]
# 🪆 Nested Dict Tools
**Nested Dict Tools** is a Python package that provides utilities for working with nested dictionaries. It includes:
- Recursive types for describing nested mappings and dictionaries.
- Fully typed functions to:
- Flatten and unflatten nested dictionaries.
- Get and set deeply nested values.
- Iterate over leaves and the dictionary that contains then.
- Filter and map functions on leaves.
- Other helpful functions.
```python:dev/readme_snippets/formatted/features_demo.py
from nested_dict_tools import (
filter_leaves,
flatten_dict,
get_deep,
is_in_leaves,
iter_leaf_containers,
iter_leaves,
map_leaves,
set_deep,
unflatten_dict,
)
nested = {"a": {"b": {"c": 42}}}
# Get a deeply nested value
value = get_deep(nested, ["a", "b"])
print(value) # Output: {'c': 42}
# Set a deeply nested value
set_deep(nested, ["a", "z"], "new_value")
print(nested) # Output: {'a': {'b': {'c': 42}, 'z': 'new_value'}}
# Flatten the nested dictionary
flat = flatten_dict(nested, sep=".")
print(flat) # Output: {'a.b.c': 42, 'a.z': 'new_value'}
# Unflatten the flattened dictionary
unflattened = unflatten_dict(flat, sep=".")
print(unflattened == nested) # Output: True
# Iterate over leaves
leaves = list(iter_leaves(nested))
print(leaves) # Output: [42, 'new_value']
# Iterate over leaf conainers and keys
leaf_refs = list(iter_leaf_containers(nested))
print(leaf_refs) # Output: [({'c': 42}, 'c'), ({'b': {'c': 42}, 'z': 'new_value'}, 'z')]
# and mutate leaves in place
d, key = leaf_refs[0]
d[key] = 3
print(nested) # Output: {'a': {'b': {'c': 3}, 'z': 'new_value'}}
# Check if a values is the leaves
print(is_in_leaves("foo", nested)) # Output: False
# Filter leaves
nested = filter_leaves(
nested,
lambda k, v: isinstance(v, int),
)
print(nested) # Output: {'a': {'b': {'c': 3}}}
# Map on leaves
mapped = map_leaves(lambda x: x + 1, nested)
print(mapped) # Output: {'a': {'b': {'c': 4}}}
# Map on leaves with several dictionaries
mapped = map_leaves(lambda x, y: x + y + 1, nested, nested)
print(mapped) # Output: {'a': {'b': {'c': 7}}}
# # Recursive types:
type NestedDict[K, V] = dict[K, NestedDictNode[K, V]]
type NestedDictNode[K, V] = V | NestedDict[K, V]
# Similar types for Mapping and MutableMapping
```
## ⬇️ Installation
You can install **Nested Dict Tools** via pip:
```bash
pip install nested-dict-tools
```
## 🧾 License
[MIT](LICENSE)
[github-ci-image]: https://github.com/kajiih/nested_dict_tools/actions/workflows/build.yml/badge.svg?branch=main
[github-ci-link]: https://github.com/kajiih/nested_dict_tools/actions?query=workflow%3Abuild+branch%3Amain
[codecov-image]: https://img.shields.io/codecov/c/github/kajiih/nested_dict_tools/main.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333
[codecov-link]: https://codecov.io/github/kajiih/nested_dict_tools
[pypi-image]: https://img.shields.io/pypi/v/nested-dict-tools.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333
[pypi-link]: https://pypi.python.org/pypi/nested-dict-tools
[python-image]: https://img.shields.io/pypi/pyversions/nested-dict-tools?logo=python&logoColor=aaaaaa&labelColor=333333
[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333