Metadata-Version: 2.0
Name: mydict
Version: 1.0.5
Summary: A Python dict subclass which tries to act like JavaScript objects, so you can use the dot-notation (d.foo) to access members of the object.
Home-page: https://github.com/codevincedev/mydict
Author: León Domingo
Author-email: leon@codevince.dev
License: MIT
Keywords: dict javascript dot-notation codevince
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Requires-Dist: pytest

MyDict
======

A **Python** *dict* subclass which tries to act like **JavaScript**
objects, so you can use the **dot notation** (*d.foo*) to access members
of the object. If the member doesn't exist yet then it's created when
you assign a value to it. Brackets notation (*d['foo']*) is also
possible.

Installation
------------

::

    $ pip install mydict

Examples
--------

Let's give it a try

::

    d = MyDict()
    d.foo = 'bar'

    print(d.foo)
    # ==> 'bar'

If you try to get the value of a non-existing member then a *None* value
is returned

::

    d = MyDict()
    if d.foo is None:
        print('"foo" does not exist yet!')

If that value is "complex" (a *dict* or another *MyDict* instance), then
it's also **recursively** transformed into a *MyDict* object, so you can
access it in the same way

::

    d = MyDict()
    d.foo = {'bar': 'baz', 'lst': [{'a': 123}]}

    print(d.foo.bar)
    # ==> 'baz'

    print(d.foo.bar)
    # ==> 'baz'

    print(d.foo.lst[0].a)
    # ==> 123

Values in lists are accessed, as you expect, with the brackets notation
(*d[0]*):

::

    d = MyDict()
    d.foo = [1, 2, 3]

    print(d.foo[2])
    # ==> 3

We can instantiate it from a *dict* of any level of complexity

::

    d = MyDict({'foo': 'bar', 'baz': [1, 2, {'foo': 'bar', 'baz': 'Hello, world!'}}])

    print(d.foo)
    # ==> 'bar'

    print(d.baz[0])
    # ==> 1

    print(d.baz[2].foo)
    # ==> 'bar'

with keywords in the *constructor*

::

    d = MyDict(a=1, b=2.2, c=[1, 2, 3], d=[{'x': 1, 'y': [100, 200, 300]}])
    ...
    d.a == 1
    d.b == 2.2
    d.c[0] == 1
    d.d[0].x == 1
    d.d[0].y[1] == 200

or both

::

    d = MyDict({'foo': 'bar'}, baz=123)
    ...
    d.foo == 'bar'
    d.baz == 123

Please, take into account that keyword initialization has precedence
over the *dict* (first parameter of the *constructor*)

::

    d = MyDict({'foo': 'bar'}, foo='BAR')
    ...
    d.foo == 'BAR'

It's also possible to access members using a *path* with **get** or
*brackets notation* (*d['...']*):

::

    d = MyDict(foo={'bar': 'baz'})
    ...
    d['foo.bar'] == 'baz'
    d.get('foo.bar') == 'baz'

But when those keys *with dots* exists in the tree they are accessed
using the corresponding key

::

    d = MyDict({'foo.bar': 'baz'})
    ...
    # 'foo.bar' is not interpreted as a path because the key exists
    d['foo.bar'] = 'baz'

But there's a particular case, if a *dotted key* exists and match an
existing *path*, then this ain't work properly, or work in a different
way depending on the method of access used, to be correct

::

    d = MyDict({'foo': {'bar': 'baz'}, 'foo.bar': 'BAZ'})
    ...
    d['foo.bar'] = 'BAZ'  # the "dotted field" ('foo.bar') has precedence over the path
    d.foo.bar = 'baz'  # it's not possible to detect a "dotted key" using "dot notation"

Personally, I don't see this as a great issue because I generally avoid
using dots in keys, like in the previous case

The tests passed successfully with **Python 3.6** and **Python 2.7**
versions.

::

    $ pytest mydict -v



