Skip to main content

Python module for interacting with nested dicts as a single level dict with delimited keys.

Project description

Version Status Coverage License

FlatDict is a dict object that allows for single level, delimited key/value pair mapping of nested dictionaries. You can interact with FlatDict like a normal dictionary and access child dicts as you normally would or with the composite key.

Examples

foo = {'foo': {'bar': 'baz', 'qux': 'corge'}}

is represented as:

{'foo:bar': 'baz',
 'foo:qux': 'corge'}

And can still be accessed as:

foo['foo']['bar']

and

foo['foo:bar']

Additionally, lists and tuples are also converted into dicts using enumerate().

For example:

d = {'list': ['a', 'b', 'c',]}

Will be flattened as follows:

flat = {'list:0': 'a', 'list:1': 'b', 'list:2': 'c'}

API

Documentation is available at https://flatdict.readthedocs.io

Installation

$ pip install flatdict

Example Use

import pprint

import flatdict

values = {'foo': {'bar': {'baz': 0,
                          'qux': 1,
                          'corge': 2},
                  'grault': {'baz': 3,
                             'qux': 4,
                             'corge': 5}},
          'garply': {'foo': 0, 'bar': 1, 'baz': 2, 'qux': {'corge': 3}}}

flat = flatdict.FlatDict(values)

print(flat['foo:bar:baz'])

flat['test:value:key'] = 10

del flat['test']

for key in flat:
    print(key)

for value in flat.itervalues():
    print(value)

pprint.pprint(flat.as_dict())

pprint.pprint(dict(flat))

print(flat == flat.as_dict())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flatdict-3.1.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flatdict-3.1.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file flatdict-3.1.1.tar.gz.

File metadata

  • Download URL: flatdict-3.1.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for flatdict-3.1.1.tar.gz
Algorithm Hash digest
SHA256 7491bae7273ed0f7bad6b8963209ed1664aec6942be28c273cacdf6a28fa2c2c
MD5 0f9822fa2fccd7fdfc00b42f568fe58a
BLAKE2b-256 0824447516263c67f8532dc5e3484fb71dbbc4d6dffc5335095120ef7a9661be

See more details on using hashes here.

File details

Details for the file flatdict-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: flatdict-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for flatdict-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2525b2a4efadf0ee3a8d165abaa8d8d2c3c61ba31f39edb02ac502c8fc5ea0a
MD5 e1befe9ad2040eef215e626a4da39cf0
BLAKE2b-256 d50d13d34491f87d5433c34fc947c4131da1761208d99126992059a81c6ab692

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page