aldict 1.0.0__py3-none-any.whl

aldict/__init__.py

@@ -0,0 +1,3 @@
+from .alias_dict import AliasDict as AliasDict
+from .exception import AliasError as AliasError
+from .exception import AliasValueError as AliasValueError

aldict/alias_dict.py

@@ -0,0 +1,92 @@
+from collections import UserDict, defaultdict
+
+from aldict.exception import AliasError, AliasValueError
+
+
+class AliasDict(UserDict):
+    """Custom Dict class supporting key-aliases pointing to shared values"""
+
+    def __init__(self, dict_):
+        self._alias_dict = {}
+        super().__init__(self, **dict_)
+
+    def add_alias(self, key, *aliases):
+        if key not in self.data.keys():
+            raise KeyError(key)
+        for alias in aliases:
+            if alias == key:
+                raise AliasValueError(f"Key and corresponding alias cannot be equal: '{key}'")
+            self._alias_dict[alias] = key
+
+    def remove_alias(self, *aliases):
+        for alias in aliases:
+            try:
+                self._alias_dict.__delitem__(alias)
+            except KeyError as e:
+                raise AliasError(alias) from e
+
+    def clear_aliases(self):
+        self._alias_dict.clear()
+
+    def aliases(self):
+        return self._alias_dict.keys()
+
+    def aliased_keys(self):
+        result = defaultdict(list)
+        for alias, key in self._alias_dict.items():
+            result[key].append(alias)
+        return result.items()
+
+    def origin_keys(self):
+        return self.data.keys()
+
+    def keys(self):
+        return dict(**self.data, **self._alias_dict).keys()
+
+    def values(self):
+        return self.data.values()
+
+    def items(self):
+        return dict(**self.data, **{k: self.data[v] for k, v in self._alias_dict.items()}).items()
+
+    def __missing__(self, key):
+        try:
+            return super().__getitem__(self._alias_dict[key])
+        except AttributeError as e:
+            raise KeyError(key) from e
+
+    def __setitem__(self, key, value):
+        try:
+            key = self._alias_dict[key]
+        except KeyError:
+            pass
+        super().__setitem__(key, value)
+
+    def __delitem__(self, key):
+        try:
+            self.data.__delitem__(key)
+        except KeyError:
+            # in case we try to delete alias e.g. via pop()
+            pass
+        self._alias_dict = {k: v for k, v in self._alias_dict.items() if v != key}
+
+    def __contains__(self, item):
+        return item in set(self.keys())
+
+    def __iter__(self):
+        for item in self.keys():
+            yield item
+
+    def __len__(self):
+        return len(self.keys())
+
+    def __repr__(self):
+        return f"AliasDict({self.items()})"
+
+    def __eq__(self, other):
+        if not isinstance(other, AliasDict):
+            raise TypeError(f"{other} is not an AliasDict")
+        return self.data == other.data and self._alias_dict == other._alias_dict
+
+    def __hash__(self):
+        return hash((self.data, self._alias_dict))

aldict/exception.py

@@ -0,0 +1,6 @@
+class AliasError(KeyError):
+    pass
+
+
+class AliasValueError(ValueError):
+    pass

aldict-1.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kaloyan Ivanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aldict-1.0.0.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.1
+Name: aldict
+Version: 1.0.0
+Summary: Multi-key dictionary, supports adding and manipulating key-aliases pointing to shared values
+Author-email: Kaloyan Ivanov <kaloyan.ivanov88@gmail.com>
+Project-URL: repository, https://github.com/kaliv0/aldict
+Keywords: multi-key dictionary,multidict,alias-dict
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.4; extra == "dev"
+Requires-Dist: ruff>=0.8.3; extra == "dev"
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=6.0.1; extra == "dev"
+
+<p align="center">
+  <img src="https://github.com/kaliv0/aldict/blob/main/assets/alter-ego.jpg?raw=true" width="250" alt="Alter Ego">
+</p>
+
+---
+# Aldict
+
+[![tests](https://img.shields.io/github/actions/workflow/status/kaliv0/aldict/ci.yml)](https://github.com/kaliv0/aldict/actions/workflows/ci.yml)
+![Python 3.x](https://img.shields.io/badge/python-^3.11-blue?style=flat-square&logo=Python&logoColor=white)
+[![PyPI](https://img.shields.io/pypi/v/aldict.svg)](https://pypi.org/project/aldict/)
+[![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://github.com/kaliv0/aldict/blob/main/LICENSE)
+
+Multi-key dictionary, supports adding and manipulating key-aliases pointing to shared values
+
+---
+## How to use
+
+- add_alias
+<br>(pass <i>key</i> as first parameter and <i>alias(es)</i> as variadic params)
+```python
+ad = AliasDict({"a": 1, "b": 2})
+ad.add_alias("a", "aa")
+ad.add_alias("b", "bb", "Bbb")
+assert ad["a"] == ad["aa"] == 1
+assert ad["b"] == ad["bb"] == ad["Bbb"] == 2
+```
+- remove_alias
+<br>(pass <i>alias(es)</i> to be removed as variadic parameters)
+```python
+ad.remove_alias("aa")
+ad.remove_alias("bb", "Bbb")
+assert len(ad.aliases()) == 0
+```
+- clear_aliases
+<br>(remove all <i>aliases</i> at once)
+```python
+ad.clear_aliases()
+assert len(ad.aliases()) == 0
+```
+- update alias
+<br>(point <i>alias</i> to different <i>key</i>)
+```python
+ad = AliasDict({"a": 1, "b": 2})
+ad.add_alias("a", "ab")
+assert list(ad.items()) == [('a', 1), ('b', 2), ('ab', 1)]
+
+ad.add_alias("b", "ab")
+assert list(ad.items()) == [('a', 1), ('b', 2), ('ab', 2)]
+```
+- read all aliases
+```python
+ad = AliasDict({"a": 1, "b": 2})
+ad.add_alias("a", "aa")
+ad.add_alias("b", "bb", "B")
+ad.add_alias("a", "ab", "A")
+assert list(ad.aliases()) == ['aa', 'bb', 'B', 'ab', 'A']
+```
+- aliased_keys
+<br>(read <i>keys</i> with corresponding <i>alias(es)</i>)
+```python
+assert dict(ad.aliased_keys()) == {'a': ['aa', 'ab', 'A'], 'b': ['bb', 'B']}
+```
+- read dictviews
+<br>(<i>dict.keys()</i> and <i>dict.items()</i> include <i>aliased</i> versions)
+```python
+ad = AliasDict({"x": 10, "y": 20})
+ad.add_alias("x", "Xx")
+ad.add_alias("y", "Yy", "xyz")
+
+ad.keys()
+ad.values()
+ad.items()
+```
+```shell
+dict_keys(['x', 'y', 'Xx', 'Yy', 'xyz'])
+dict_values([10, 20])
+dict_items([('x', 10), ('y', 20), ('Xx', 10), ('Yy', 20), ('xyz', 20)])
+```
+- remove key and aliases
+```python
+ad.pop("y")
+assert list(ad.items()) == [('x', 10), ('Xx', 10)]
+```
+- origin_keys
+<br>(get original <i>keys</i> only)
+```python
+assert list(ad.origin_keys()) == ['x', 'y']
+```

aldict-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+aldict/__init__.py,sha256=0l5cJ5LuzCZhZfx-IOk2dEsq6nJQTShr6oGmufIa9i4,153
+aldict/alias_dict.py,sha256=OItYhSFBKCrmjHlL_2yPuwtD7G68oQ3fW31UX_e-q54,2670
+aldict/exception.py,sha256=rFNmv9HuUOn2toPVYpVPQq6SOsl8nvwtJpGhPkK1puQ,83
+aldict-1.0.0.dist-info/LICENSE,sha256=frOVyHZrx5o-fh5xC-kggT3MaLdp6yxV_YGpVXFHFSQ,1071
+aldict-1.0.0.dist-info/METADATA,sha256=SXO3ueZ7ut4vfdbCJpWa2pvfppvakjYX5DbIUlo45j8,3152
+aldict-1.0.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+aldict-1.0.0.dist-info/top_level.txt,sha256=pXwIKxRsbW2_Lh1HM-4cG2xE44RBzMz07GaY2EONV5M,7
+aldict-1.0.0.dist-info/RECORD,,

aldict-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aldict-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+aldict