deflatable-dict
A dictionary that can be flattened and re-inflated. Particularly useful if you're interacting with yaml, for example.
Installation
with pip:
pip install deflatable-dict
deflatable-dict does not have any dependencies beyond standard python libraries.
Instantiation
from deflatabledict import DeflatableDict
dd = DeflatableDict({
"a": {
"1": True,
"2": False,
},
"b": 20,
})
dd["a.1"] # True
dd["a.2"] # False
dd["b"] # 20
dd["a"] # { "1": True, "2": False }
Deflation
A DeflatableDict can be deflated with .deflate(). This returns a standard dictionary object with flattened keys constructed by concatenating the nested keys with the DeflatableDict's delimiter. A DeflatableDict uses it's deflated form for its string representation.
Delimiter
A DeflatableDict can have it's delimiter specified by passing the desired delimiter as the sep parameter to the DeflatableDict constructor. By default the delimiter if ..
Inflation
A DeflatableDict will automatically inflate any values that are inserted into it. For example:
from deflatabledict import DeflatableDict
dd = DeflatableDict()
dd["a.1"] = True
dd["a.2"] = False
dd["a"] # { "1": True, "2": False }
Development
This project uses .devcontainer to describe the environment to use for development. You may use the environment described in this directory (it integrates automatically with vscode's 'remote containers' extension), or you may create your own environment with the same dependencies.
Dependencies
Install development dependencies with:
pip install .[tests]
Tests
Run tests with:
pytest
31 Jan 1, 2023
3 Aug 6, 2022
2 Jan 10, 2022
26 Dec 27, 2022
4 Nov 15, 2022
4 Aug 31, 2022
2.9k Jan 7, 2023
2.6k Jan 9, 2023
28 Dec 25, 2022
42 Jul 20, 2022
7 Mar 25, 2022
26 Dec 11, 2022
8 Mar 30, 2022
4 Aug 01, 2022
12 Dec 12, 2022
22 Nov 23, 2022
1 Oct 19, 2021
395 Dec 27, 2022
11 Dec 05, 2022
9 Feb 10, 2022
5 Aug 30, 2021
1 Nov 02, 2021
6 Aug 10, 2022
23 Jan 15, 2022
1.1k Jan 02, 2023
0 Feb 24, 2022
4 Oct 11, 2022