minor code refactor

Author: rnag

dotwiz/__init__.py

@@ -5,14 +5,17 @@
 DotWiz is a ``dict`` subclass that enables accessing (nested) keys
 in dot notation.
 
-Sample Usage:
+Sample Usage::
 
     >>> from dotwiz import DotWiz
-    >>> dw = DotWiz({'this': {'works': {'for': [{'nested': 'values'}]}}})
+    >>> dw = DotWiz({'this': {'works': {'for': [{'nested': {'values': True}}]}}},
+    ...             the_answer_to_life=42)
     >>> dw
-    DotWiz(this=DotWiz(works=DotWiz(for=[DotWiz(nested='values')])))
-    >>> dw.this.works['for'][0].nested
-    'values'
+    DotWiz(this=DotWiz(works=DotWiz(for=[DotWiz(nested=DotWiz(values=True))])), the_answer_to_life=42)
+    >>> dw.this.works['for'][0].nested.values
+    True
+    >>> dw.the_answer_to_life
+    42
 
 For full documentation and more advanced usage, please see
 <https://dotwiz.readthedocs.io>.

dotwiz/__version__.py

@@ -3,8 +3,8 @@
 """
 
 __title__ = 'dotwiz'
-__description__ = 'DotWiz is a dict subclass that enables accessing ' \
-                  '(nested) keys in dot notation.'
+__description__ = 'DotWiz is a blazing fast dict subclass that enables ' \
+                  'accessing (nested) keys in dot notation.'
 __url__ = 'https://github.com/rnag/dotwiz'
 __version__ = '0.1.0'
 __author__ = 'Ritvik Nag'

dotwiz/constants.py

@@ -3,8 +3,14 @@
 
 def make_dot_wiz(*args, **kwargs):
     """
-    Helper method to generate and return a `DotWiz` (dot-access dict) from
-    an optional iterable and *keyword arguments*.
+    Helper function to create and return a :class:`DotWiz` (dot-access dict)
+    from an optional *iterable* object and *keyword* arguments.
+
+    Example::
+
+        >>> from dotwiz import make_dot_wiz
+        >>> make_dot_wiz([('k1', 11), ('k2', [{'a': 'b'}]), ('k3', 'v3')], y=True)
+        DotWiz(y=True, k1=11, k2=[DotWiz(a='b')], k3='v3')
 
     """
     kwargs.update(*args)
@@ -17,8 +23,8 @@ def __upsert_into_dot_wiz__(self, input_dict={},
                             *, __set=dict.__setitem__,
                             **kwargs):
     """
-    Helper method to generate and return a `DotWiz` (dot-access dict) from
-    a Python `dict` object.
+    Helper method to generate / update a :class:`DotWiz` (dot-access dict)
+    from a Python ``dict`` object, and optional *keyword arguments*.
 
     """
     __dict = self.__dict__
@@ -86,8 +92,8 @@ def __convert_to_dict__(o):
 
 class DotWiz(dict):
     """
-    :class:`DotWiz` - a ``dict`` subclass that also supports dot access
-    notation.
+    :class:`DotWiz` - a blazing *fast* ``dict`` subclass that also supports
+    *dot access* notation.
 
     Usage::
 
@@ -105,13 +111,6 @@ class DotWiz(dict):
     __delattr__ = __delitem__ = dict.__delitem__
     __setattr__ = __setitem__ = __setitem_impl__
 
-    # TODO do we need this to ensure we raise an `AttributeError`?
-    # def __getattr__(self, attr):
-    #     try:
-    #         return self.__dict__[attr]
-    #     except KeyError:
-    #         raise AttributeError(attr)
-
     def __getitem__(self, key):
         return self.__dict__[key]
 

dotwiz/constants.pyi

@@ -1,4 +1,4 @@
-from typing import TypeVar, Callable, Protocol, Mapping, MutableMapping
+from typing import TypeVar, Callable, Protocol, Mapping, MutableMapping, Iterable
 
 _T = TypeVar('_T')
 _KT = TypeVar('_KT')
@@ -13,7 +13,7 @@ class _Update(Protocol):
                  **kwargs: _T) -> None: ...
 
 
-def make_dot_wiz(input_dict: MutableMapping[_KT, _VT] | None = None,
+def make_dot_wiz(*args: Iterable[_KT, _VT],
                  **kwargs: _T) -> DotWiz: ...
 
 # noinspection PyDefaultArgument

dotwiz/main.py

@@ -18,10 +18,10 @@ def test_dot_wiz_with_basic_usage():
 
 def test_make_dot_wiz():
     """Confirm intended functionality of `make_dot_wiz`"""
-    dd = make_dot_wiz({1: 'test', 'two': [{'hello': 'world'}]},
+    dd = make_dot_wiz([(1, 'test'), ('two', [{'hello': 'world'}])],
                       a=1, b='two', c={'d': [123]})
 
-    assert repr(dd) == "DotWiz(1='test', two=[DotWiz(hello='world')], a=1, b='two', c=DotWiz(d=[123]))"
+    assert repr(dd) == "DotWiz(a=1, b='two', c=DotWiz(d=[123]), 1='test', two=[DotWiz(hello='world')])"
     assert dd.a == 1
     assert dd.b == 'two'
     assert dd[1] == 'test'