Skip to main content

A dictionary with nested access, interpolation and fallback features. It is primarily meant to be used for storing configurations of programs.

Project description

ConfDict

Configuration dictionary that extends built-in python dict with recursive access, self references and fallback functionality. There is no extensive documentation yet, you can check out tests to figure out all features.

Example usage.

>>> from confdict import ConfDict
>>> cd = ConfDict(
  # Configuration of ConfDict, these are default values
  __separator = '/',
  __self_key = '.',
  __parent_key = '..',
  __root_key = '...',
  __key_key = '<key>',
  __interpolation_regex = r'({{([^{}]*)}})',
  __fallback_key = 'fallback',

  # Remaining arguments will directly be stored in underlying dict
  users = {
    # fallback dict is used when a key is not found at that level
    'fallback': {
      # <key> is evaluated to key of the current level
      # it is useful when used with fallback
      'username': '{{<key>}}',
      # you can use self references
      'ssh_private_key': '/home/{{username}}/.ssh/id_rsa',
    },
  }
)
>>> cd
ConfDict
{ 'users': { 'fallback': { 'ssh_private_key': '/home/{{username}}/.ssh/id_rsa',
                           'username': '{{<key>}}'}}}
>>> cd['users/john/username']
'john'
>>> cd['users/john/ssh_private_key']
'/home/john/.ssh/id_rsa'
>>> cd['users/john']
ConfDict
{'ssh_private_key': '/home/john/.ssh/id_rsa', 'username': 'john'}
>>> cd['users/jean']
ConfDict
{'ssh_private_key': '/home/jean/.ssh/id_rsa', 'username': 'jean'}
>>> cd['users/jean'] = { 'username': 'jeans_custom_username' }
>>> cd['users/jean/ssh_private_key']
'/home/jeans_custom_username/.ssh/id_rsa'
>>> # 'jean' exists now under 'users'
>>> # there is no partial fallback so there is no 'ssh_private_key'
>>> cd['users/jean']
ConfDict
{'username': 'jeans_custom_username'}
>>> # we can realize fallback as jean to make concrete values
>>> cd['users/fallback'].realize('jean')
>>> cd['users/jean']
ConfDict
{'ssh_private_key': '/home/jeans_custom_username/.ssh/id_rsa', 'username': 'jeans_custom_username'}
>>> # interpolation still works
>>> cd['users/jean/username'] = 'jeans_custom_username2'
>>> cd['users/jean/ssh_private_key']
'/home/jeans_custom_username2/.ssh/id_rsa'

Installation

$ pip install confdict

Development

There is a Makefile to automate commonly used development tasks.

Environment Setup

### create a virtualenv for development

$ sudo pip install virtualenv # or your preferred way to install virtualenv

$ make virtualenv # will also install dependencies

$ source env/bin/activate

### run pytest / coverage

$ make test

### before commit

$ make format

Project details


Release history Release notifications

Download files

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

Files for confdict, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size confdict-0.0.1-py3-none-any.whl (14.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size confdict-0.0.1.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page