Typing refactor (#23)

* Updating version

* adding `pylint` and `mypy`

* added py.typed

* fixing mypy and pylint errors.

* adding pylint and mypy to pipeline

* add blue check.

* fixing typing.

* fixing typing.

* adding badge for pylint and mypy

Author: tybruno

.github/workflows/lint-workflow.yml

@@ -17,7 +17,19 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install blue
+        pip install pylint
         pip install pylama
+        pip install mypy
+    - name: Check blue
+      run: |
+        blue . --check
+    - name: Analysing the code with pylama
+      run: |
+        pylama --skip='tests/*'
     - name: Analysing the code with pylint
       run: |
-        pylama --skip='tests/*'
+        pylint modifiable_items_dictionary/
+    - name: Analysing the code with mypy
+      run: |
+        mypy modifiable_items_dictionary/

README.md

@@ -2,7 +2,8 @@
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-0000ff.svg)](https://github.com/psf/blue)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blueviolet.svg)](https://opensource.org/licenses/MIT)
 [![codecov](https://codecov.io/gh/tybruno/modifiable-items-dictionary/branch/main/graph/badge.svg?token=ZO94EJFI3G)](https://codecov.io/gh/tybruno/modifiable-items-dictionary)
-
+[![Pylint](https://img.shields.io/badge/Pylint-10.0%2F10-green)](10.0/10)
+[![Mypy](https://img.shields.io/badge/Mypy-checked-blue)](10.0/10)
 # modifiable-items-dict
 
 A simple, fast, typed, and tested implementation for a python3.6+ Modifiable Items dictionary. `ModifiableItemsDict`

modifiable_items_dictionary/__init__.py

@@ -1,3 +1,11 @@
+"""modifiable_items_dictionary package
+
+Subpackages:
+    - modifiable_items_dictionary: Contains the ModifiableItemsDict and
+        ModifiableItemsAttrDict classes.
+    - modifiable_items_attribute_dictionary: Contains the ModifiableItemsAttrDict
+        class.
+"""
 from modifiable_items_dictionary.modifiable_items_dictionary import (
     ModifiableItemsDict,
 )

modifiable_items_dictionary/modifiable_items_attribute_dictionary.py

@@ -13,10 +13,11 @@
 This module was heavily inspired by Raymond Hettinger's class.
     [1] Hettinger, R. (2023). (Advanced) Python For Engineers: Part 3.
 """
+from typing import Any
+
 from modifiable_items_dictionary.modifiable_items_dictionary import (
     ModifiableItemsDict,
 )
-from typing import Any
 
 
 class ModifiableItemsAttrDict(ModifiableItemsDict):
@@ -28,6 +29,7 @@ class ModifiableItemsAttrDict(ModifiableItemsDict):
     items. This means that in addition to the standard dictionary access
     syntax (dict["key"]), you can also use attribute syntax (dict.key).
     """
+
     __slots__ = ()
 
     def __getattr__(self, name: str) -> Any:
@@ -50,11 +52,11 @@ def __getattr__(self, name: str) -> Any:
         """
         try:
             value = self[name]
-        except KeyError:
+        except KeyError as error:
             raise AttributeError(
                 f"'{self.__class__.__name__}' object has no attribute "
                 f"'{name}'."
-            )
+            ) from error
         return value
 
     def __setattr__(self, name: str, value: Any) -> None:

modifiable_items_dictionary/modifiable_items_dictionary.py

@@ -10,7 +10,8 @@
     [1] Hettinger, R. (2023). (Advanced) Python For Engineers: Part 3.
 """
 import contextlib
-import multiprocessing.pool
+
+# pylint: disable=no-name-in-module
 from typing import (
     Any,
     Callable,
@@ -25,6 +26,7 @@
     overload,
 )
 
+
 # Sentinel
 NO_DEFAULT = object()
 
@@ -33,12 +35,12 @@
 Self = TypeVar('Self', bound='ModifiableItemsDict')
 
 Key = Hashable
+_KT = TypeVar('_KT')
+_VT_co = TypeVar('_VT_co', covariant=True)
 Value = Any
 MappingCallable = Union[
     map,
-    multiprocessing.pool.ThreadPool.map,
-    multiprocessing.pool.ThreadPool.imap,
-    multiprocessing.pool.ThreadPool.imap_unordered,
+    Callable,
 ]
 KeyCallable = Callable[[Any], Key]
 ValueCallable = Callable[[Any], Value]
@@ -75,7 +77,6 @@ class ModifiableItemsDict(dict):
 
     __slots__ = ()
 
-    # TODO: Add validators
     _key_modifiers: KeyModifiers = None
     _value_modifiers: ValueModifiers = None
     _map_function: MappingCallable = map
@@ -189,12 +190,9 @@ def _create_modified_mapping(self, iterable):
             Dictionary with the modified keys and values.
         """
 
-        new_mapping: Mapping[Key, Value] = {
-            key: value
-            for key, value in self._map_function(
-                self._modify_key_and_item, iterable
-            )
-        }
+        new_mapping = dict(
+            self._map_function(self._modify_key_and_item, iterable)
+        )
 
         return new_mapping
 
@@ -223,7 +221,17 @@ def fromkeys(
         cls,
         __iterable: Iterable[Key],
         __value: Optional[Union[Value, None]] = None,
-    ) -> Self:
+    ):
+        """Create a new dictionary with keys from iterable and values set to
+        value.
+
+        Args:
+            __iterable: Iterable of keys.
+            __value: Value to set for each key. Default is None.
+
+        Returns:
+            New dictionary with keys from iterable and values set to value.
+        """
         return cls(dict.fromkeys(__iterable, __value))
 
     @overload
@@ -252,7 +260,7 @@ def __init__(
             if kwargs:
                 kwargs = self._iterable_to_modified_dict(kwargs)
 
-        dict.__init__(self, iterable or dict(), **kwargs)
+        dict.__init__(self, iterable or {}, **kwargs)
 
     def __getitem__(self, k: Key) -> Any:
         k = self._modify_key(k)
@@ -272,7 +280,7 @@ def __contains__(self, __item: Value) -> bool:
         _is_in: bool = dict.__contains__(self, __item)
         return _is_in
 
-    def setdefault(self, __key: Key, __default: Value = None) -> None:
+    def setdefault(self, __key, __default: Value = None) -> None:
         __key = self._modify_key(__key)
         __default = self._modify_value(__default)
         dict.setdefault(self, __key, __default)
@@ -289,9 +297,9 @@ def pop(self, __key, default=NO_DEFAULT) -> Value:
         __key = self._modify_key(__key)
 
         if default is NO_DEFAULT:
-            value: Value = dict.pop(self, __key)
+            value = dict.pop(self, __key)
         else:
-            value: Value = dict.pop(self, __key, default)
+            value = dict.pop(self, __key, default)
 
         return value
 
@@ -308,18 +316,6 @@ def get(self, __key: Key, default=None):
         value: Union[Value, None] = dict.get(self, __key, default)
         return value
 
-    @overload
-    def update(self, __m: Mapping[Key, Value], **kwargs: Value) -> None:
-        ...
-
-    @overload
-    def update(self, __m: Iterable[Tuple[str, Any]], **kwargs: Value) -> None:
-        ...
-
-    @overload
-    def update(self, **kwargs: Value) -> None:
-        ...
-
     def update(
         self,
         __m=None,
@@ -332,4 +328,4 @@ def update(
             if kwargs:
                 kwargs = self._iterable_to_modified_dict(kwargs)
 
-        dict.update(self, __m or dict(), **kwargs)
+        dict.update(self, __m or {}, **kwargs)

modifiable_items_dictionary/py.typed

@@ -1,4 +1,6 @@
 # Test Requirements
 pytest
 pytest-cov
-blue
+blue
+mypy
+pylint

requirements-test.txt

@@ -1,7 +1,7 @@
 """Setup.py"""
 import setuptools
 
-__version__ = 'v3.0.1'
+__version__ = 'v3.0.2'
 __author__ = 'Tyler Bruno'
 _description = (
     'Typed and Tested Modifiable Items Dict and ModifiableItemsAttrDict which '
@@ -21,7 +21,7 @@
     long_description=README,
     long_description_content_type='text/markdown',
     keywords='python dict attribute dictionary attrdict mapping '
-             'key-mangling value-mangling',
+    'key-mangling value-mangling',
     url='https://github.com/tybruno/modifiable-items-dictionary',
     license='MIT',
     package_data={'modifiable-items-dictionary': ['py.typed']},