Please visit the GitHub repository for more information.
flatten-dict
A flexible utility for flattening dict-like objects in Python.
Introduction
This Python package provide a function flatten() for flattening dict-like objects. It also provides some key joining methods (reducer), and you can choose the reducer you want or even implement your own reducer. You can also choose to invert the resulting flat dict.
Documentation
def flatten(d, reducer='tuple', inverse=False):
"""Flatten dict-like object.
Parameters
----------
d: dict-like object
The dict that will be flattened.
reducer: {'tuple', 'path', function} (default: 'tuple')
The key joining method. If a function is given, the function will be
used to reduce.
'tuple': The resulting key will be tuple of the original keys
'path': Use ``os.path.join`` to join keys.
inverse: bool (default: False)
Whether you want invert the resulting key and value.
Returns
-------
flat_dict: dict
"""
Examples
In [1]: from flatten_dict import flatten
In [2]: normal_dict = {
...: 'a': '0',
...: 'b': {
...: 'a': '1.0',
...: 'b': '1.1',
...: },
...: 'c': {
...: 'a': '2.0',
...: 'b': {
...: 'a': '2.1.0',
...: 'b': '2.1.1',
...: },
...: },
...: }
In [3]: flatten(normal_dict)
Out[3]:
{('a',): '0',
('b', 'a'): '1.0',
('b', 'b'): '1.1',
('c', 'a'): '2.0',
('c', 'b', 'a'): '2.1.0',
('c', 'b', 'b'): '2.1.1'}
In [4]: flatten(normal_dict, reducer='path')
Out[4]:
{'a': '0',
'b/a': '1.0',
'b/b': '1.1',
'c/a': '2.0',
'c/b/a': '2.1.0',
'c/b/b': '2.1.1'}
In [5]: flatten(normal_dict, reducer='path', inverse=True)
Out[5]:
{'0': 'a',
'1.0': 'b/a',
'1.1': 'b/b',
'2.0': 'c/a',
'2.1.0': 'c/b/a',
'2.1.1': 'c/b/b'}
In [6]: def underscore_reducer(k1, k2):
...: if k1 is None:
...: return k2
...: else:
...: return k1 + "_" + k2
...:
In [7]: flatten(normal_dict, reducer=underscore_reducer)
Out[7]:
{'a': '0',
'b_a': '1.0',
'b_b': '1.1',
'c_a': '2.0',
'c_b_a': '2.1.0',
'c_b_b': '2.1.1'}
Metadata
Release files for flatten-dict 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| flatten-dict-0.0.1.tar.gz | 2.3 kB | Without provenance | Details for flatten-dict-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flatten_dict-0.0.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for flatten_dict-0.0.1-py2.py3-none-any.whl |
Total release size: 6.3 kB
Release files / flatten-dict-0.0.1.tar.gz
| Download URL | flatten-dict-0.0.1.tar.gz |
|---|---|
| Size | 2.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a02e3e643169933756c925339e2e93d781bd09fa0347e5b980fc759319fb9364
|
|
BLAKE2b-256 checksum How to use checksums |
e6aa4a5762c82d98cbe7019973ca5c203a521c8533fb364597b9e78b47b031c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / flatten_dict-0.0.1-py2.py3-none-any.whl
| Download URL | flatten_dict-0.0.1-py2.py3-none-any.whl |
|---|---|
| Size | 4.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
72201d09e27bfa6b95b6216ab0024ae6f9c3e6c81346920f43eb9f3811a68113
|
|
BLAKE2b-256 checksum How to use checksums |
9650981a4011b34dbe60736859686416e2feabbfe82cfad58b839b9f2ffb8f55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for flatten-dict 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.