waterbear 1.2.0

A utility that makes it easy to use dot notation with python dictionaries

waterbear_is_a_bear

waterbear, A Utility That Makes Python Dictionary Accessible With The Dot Notation, Recursively and with Default Values

Now introducing the smallest bear! Waterbear.

Waterbear makes it easy to use python dictionaries with dot notation!

Todos

• [ ] merge python2.7 version with python3

• [ ] make another package called tardigrade

Installation

pip install waterbear # unfortuantely, tardigrade wouldn't work.

Usage

For more usage examples, take a look at the test.py!

There are two classes, the Bear and the DefaultBear. Default Bear allows you to pass in a default factory as the first argument. Bear allows you do do so via a keyword argument __default

Example usage below:

# Waterbear is a bear!
from waterbear import Bear

waterbear = Bear(**{"key": 100})
assert waterbear.key == 100, 'now waterbear.key is accessible!'
assert waterbear['key'] == 100, 'item access syntax is also supported!'

Similar to collection.defaultdict, there is DefaultBear

bear = DefaultBear(None, a=10, b=100)
assert vars(bear) == {'a': 10, 'b': 100}

assert bear.does_not_exist is None, "default value works"

and it also supports default factories

bear = DefaultBear(tuple, a=10, b=100)
assert bear.does_not_exist is (), "default factory also works!"

You can also use it with vars, str, print(repr), dict etc.

bear = Bear(a=10, b=100)
assert str(bear) == "{'a': 10, 'b': 100}"
assert dir(bear) == ['a', 'b']
assert list(iter(bear)) == ['a', 'b']
assert dict(bear) == {'a': 10, 'b': 100}

More Usages Could Be Found in The Tests!

For more usage examples, take a look at test.py.

test_dict = {
    'a': 0,
    'b': 1
}

# Use spread operators to construct with a dictionary!
test_args = Bear(**test_dict)
assert test_args.a == 0
assert test_args.b == 1
# the value should now be accessible through the key name.
test_args.haha = 0
assert test_args.haha == 0


# You can also use a nested dictionary.
test_args.haha = {'a': 1}
assert test_args.haha != {'a': 1}
assert vars(test_args.haha) == {'a': 1}
assert test_args.haha.a == 1
assert test_args.__dict__['haha']['a'] == 1
assert vars(test_args)['haha']['a'] == 1
assert str(test_args) == "{'a': 0, 'b': 1, 'haha': {'a': 1}}", \
    'test_args should be this value "{\'a\': 0, \'b\': 1, \'haha\': {\'a\': 1}}"'

# To set recursion to false, use this `__recursive` parameter.
test_args = Bear(__recursive=False, **test_dict)
assert test_args.__is_recursive == False
assert test_args.a == 0
assert test_args.b == 1
test_args.haha = {'a': 1}
assert test_args.haha['a'] == 1
assert test_args.haha == {'a': 1}

# Some other usage patterns
test_args = Bear(**test_dict, **{'ha': 'ha', 'no': 'no'})
assert test_args.ha == 'ha', 'key ha should be ha'

To Develop

git clone https://github.com/episodeyang/waterbear.git
cd waterbear
make dev

This make dev command should build the wheel and install it in your current python environment. Take a look at the https://github.com/episodeyang/waterbear/blob/master/Makefile for details.

To publish, first update the version number, then do:

make publish

* image credit goes to BBC waterbear: The Smallest Bear! 😛