Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamghill/transformd
Transform dictionaries into whatever your heart desires (as long as it's another dictionary that kind of looks like the original dictionary)
https://github.com/adamghill/transformd
Last synced: 26 days ago
JSON representation
Transform dictionaries into whatever your heart desires (as long as it's another dictionary that kind of looks like the original dictionary)
- Host: GitHub
- URL: https://github.com/adamghill/transformd
- Owner: adamghill
- Created: 2023-11-11T22:32:39.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-04T12:09:10.000Z (11 months ago)
- Last Synced: 2024-07-15T00:07:26.176Z (4 months ago)
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# transformd
Transform a `dictionary` to another `dictionary`, but keep the same shape based on a `spec`.
## What is a spec?
It is a string (or sequence of strings) that specifies which "parts" of the dictionary should be included or excluded in a new `dictionary` that is returned from the `transform` function.
A `spec` uses dot-notation to specify how to traverse into the `dictionary`. It can also use indexes if the value of the `dictionary` is a list.
Note: `Specs` are applied to the original `dictionary` in the order they are defined.
## Examples
```python
from transformd import Transformer
# Initial `dictionary` we'll transform based on a spec below
data = {
"library": {
"name": "Main St Library",
"location": {
"street": "123 Main St",
"city": "New York City",
"state": "NY",
},
"books": [
{
"title": "The Grapes of Wrath",
"author": {"first_name": "John", "last_name": "Steinbeck"},
},
{
"title": "Slaughterhouse-Five",
"author": {"first_name": "Kurt", "last_name": "Vonnegut"},
},
],
}
}
# Only return a nested part of `data`
assert Transformer(data).transform(spec="library.name") == {
"library": {
"name": "Main St Library"
}
}
# Return multiple parts of `data`
assert Transformer(data).transform(spec=("library.name", "library.location.state")) == {
"library": {
"name": "Main St Library",
"location": {
"state": "NY"
},
}
}
# Return different parts of a nested list in `data`
assert Transformer(data).transform(spec=("library.books.0.title", "library.books.1")) == {
"library": {
"books": [
{
"title": "The Grapes of Wrath",
},
{
"title": "Slaughterhouse-Five",
"author": {"first_name": "Kurt", "last_name": "Vonnegut"},
},
],
}
}
# Exclude pieces from `data` by prefixing a spec with a dash
assert Transformer(data).transform(spec=("-library.books", "-library.location")) == {
"library": {
"name": "Main St Library"
}
}
```
## Why?
I needed this functionality for [`Unicorn`](https://www.django-unicorn.com), but could not find a suitable library. After writing the code, I thought maybe it would be useful for someone else. 😎
## Run tests
- Install [rye](https://rye-up.com)
- `rye sync`
- `rye run t`
### Test Coverage
- `rye run tc`
## Inspiration
- Django Templates for the dot-notation inspiration
- A lot of existing JSON-related tools, but especially [`glom`](https://glom.readthedocs.io/), [`jello`](https://github.com/kellyjonbrazil/jello), [`jq`](https://jqlang.github.io/jq/), and [`gron`](https://github.com/TomNomNom/gron); all of which did not quite do what I wanted, but were useful on the journey