attridict's Introduction

attridict

A Python package implementing atrribute dictionary.

This provides an easier and cleaner way to access dict values using their keys as attributes. It is typically a dict child, maintaining all the dict functionalities, but including some extra features.

Installation

To install the package from PyPI, use:

pip install attridict

Usage

Creating an attridict object

>>> import attridict
>>> att = attridict()
>>> att
{}
>>> att.foo = "bar"
>>> att.foo
'bar'
>>> att
{'foo': 'bar'}

A dict can be converted into an attridict object by passing it as an argument

>>> import attridict

>>> data = {'red': 'hot', 'blue': 'cold'}

>>> colors = attridict(data)
>>> colors
{'red': 'hot', 'blue': 'cold'}

>>> colors.red
'hot'

Modifying attridict object

>>> import attridict

>>> data = {'red': 'hot', 'blue': 'cold'}

>>> colors = attridict(data)
>>> colors
{'red': 'hot', 'blue': 'cold'}

>>> colors.blue
'cold'

>>> colors.blue = "sky"
>>> colors.red = "rose"
>>> colors.blue
'sky'
>>> colors.red
'rose'
>>> colors
{'red': 'rose', 'blue': 'sky'}

>>> colors.green = "grass"
>>> colors
{'red': 'rose', 'blue': 'sky', 'green': 'grass'}

Typical dict operations work on attridict objects

>>> import attridict

>>> data = {'red': 'rose', 'blue': 'sky'}

>>> colors = attridict(data)
>>> colors
{'red': 'rose', 'blue': 'sky'}

>>> colors.red
'rose'
>>> colors["red"]
'rose'

>>> colors["red"] = "tomato"
>>> colors["red"]
'tomato'
>>> colors.red
'tomato'

Nested attribute access

>>> import attridict

>>> data = {'foo': {}}
>>> att = attridict(data)

>>> att
{'foo': {}}

>>> att.foo.bar = 'baz'

>>> att.foo.bar
'baz'

>>> att
{'foo': {'bar': 'baz'}}

YAML serializable

>>> import attridict
>>> import yaml

>>> data = {'foo': {'bar': 'baz'}}

>>> att = attridict(data)

>>> yaml.dump(att)
'!attridict\nfoo:\n  bar: baz\n'

>>> yaml.safe_dump(att)
'foo:\n  bar: baz\n'

License

The project is MIT licensed

attridict's People

Contributors

Stargazers

Watchers

attridict's Issues

dict conversion with self reference

While creating a self reference with attridict works fine, creating an attridict object from a dict with self referencing raises a RecursionError
This happens when deep=True, which is the default behavior

>>> a = {}
>>> a
{}
>>> a["me"] = a
>>> a
{'me': {...}}

>>> import attridict
>>> attridict(a)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 26, in __init__
    self.__to_attridict(data, deep)
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 111, in __to_attridict
    self.__dict__[key] = type(self)(value, deep)
    ....
    ....
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 26, in __init__
    self.__to_attridict(data, deep)
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 111, in __to_attridict
    self.__dict__[key] = type(self)(value, deep)
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 18, in __init__
    verified_dict = self.__type_verification(data)
  File "/home/alvin/.local/lib/python3.10/site-packages/attridict.py", line 152, in __type_verification
    if type(data) != dict or type(data) != AttriDict:
RecursionError: maximum recursion depth exceeded in comparison

Recommend Projects