https://github.com/kaliv0/aldict
Multi-key dictionary
https://github.com/kaliv0/aldict
key-alias multidict multikey-map
Last synced: 3 months ago
JSON representation
Multi-key dictionary
- Host: GitHub
- URL: https://github.com/kaliv0/aldict
- Owner: kaliv0
- License: mit
- Created: 2024-12-14T08:52:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-03T21:04:02.000Z (4 months ago)
- Last Synced: 2026-02-04T09:59:18.541Z (4 months ago)
- Topics: key-alias, multidict, multikey-map
- Language: Python
- Homepage: https://pypi.org/project/aldict/
- Size: 128 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# Aldict
[](https://github.com/kaliv0/aldict/actions/workflows/ci.yml)
[](https://pypi.org/project/aldict/)
[](https://github.com/kaliv0/aldict/blob/main/LICENSE)
[](https://pepy.tech/projects/aldict)
Multi-key dictionary, supports adding and manipulating key-aliases pointing to shared values
---
## How to use
- initialize with aliases
(one-liner with aliases dict mapping original key to alias keys)
```python
ad = AliasDict({"a": 1, "b": 2}, aliases={"a": ["aa", "aaa"], "b": "bb"})
assert ad["a"] == ad["aa"] == ad["aaa"] == 1
assert ad["b"] == ad["bb"] == 2
```
- add_alias
(pass key as first parameter and alias(es) as variadic params, list or tuple)
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
ad.add_alias("b", "bb", "Bbb")
ad.add_alias("a", ["aaa", "aaaa"])
ad.add_alias("b", ("bbb",))
assert ad["a"] == ad["aa"] == ad["aaa"] == ad["aaaa"] == 1
assert ad["b"] == ad["bb"] == ad["Bbb"] == ad["bbb"] == 2
```
- remove_alias
(pass alias(es) to be removed as variadic params, list or tuple)
```python
ad.remove_alias("aa")
ad.remove_alias("bb", "Bbb")
ad.remove_alias(["aaa", "aaaa"])
ad.remove_alias(("bbb",))
assert len(ad.aliases()) == 0
```
- clear_aliases
(remove all aliases at once)
```python
ad.clear_aliases()
assert len(ad.aliases()) == 0
```
- update alias
(point alias to different key)
```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']
```
- keys_with_aliases
(read keys with corresponding alias(es))
```python
assert dict(ad.keys_with_aliases()) == {'a': ['aa', 'ab', 'A'], 'b': ['bb', 'B']}
```
- read dictviews
(dict.keys() and dict.items() include aliased 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()
# dict_keys(['x', 'y', 'Xx', 'Yy', 'xyz'])
# dict_values([10, 20])
# dict_items([('x', 10), ('y', 20), ('Xx', 10), ('Yy', 20), ('xyz', 20)])
```
- iterkeys
(lazy iterator over all keys and aliases)
```python
ad = AliasDict({"x": 10, "y": 20})
ad.add_alias("x", "Xx")
assert list(ad.iterkeys()) == ['x', 'y', 'Xx']
```
- iteritems
(lazy iterator over all items including alias/value pairs)
```python
assert list(ad.iteritems()) == [('x', 10), ('y', 20), ('Xx', 10)]
```
- remove key and aliases
```python
ad.pop("y")
assert list(ad.items()) == [('x', 10), ('Xx', 10)]
```
- origin_len
(get original dict length without aliases)
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
assert list(ad.keys()) == ["a", "b", "aa"]
assert len(ad) == 3
assert ad.origin_len() == 2
```
- origin_keys
(get original keys only)
```python
assert list(ad.origin_keys()) == ['x', 'y']
```
- origin_key
(get original key for an alias)
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
assert ad.origin_key("aa") == "a"
assert ad.origin_key("a") is None # not an alias
```
- is_alias
(check if key is an alias)
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
assert ad.is_alias("aa") is True
assert ad.is_alias("a") is False
```
- has_aliases
(check if key has any aliases)
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
assert ad.has_aliases("a") is True
assert ad.has_aliases("b") is False
```
- copy
```python
ad = AliasDict({"a": 1, "b": 2})
ad.add_alias("a", "aa")
ad_copy = ad.copy()
assert ad_copy == ad
assert ad_copy is not ad
```
- merge with | and |= operators
```python
ad1 = AliasDict({"a": 1}, aliases={"a": "aa"})
ad2 = AliasDict({"b": 2}, aliases={"b": "bb"})
merged = ad1 | ad2
assert merged["aa"] == 1
assert merged["bb"] == 2
ad1 |= {"c": 3}
assert ad1["c"] == 3
```
- fromkeys
```python
ad = AliasDict.fromkeys(["a", "b", "c"], 0, aliases={"a": "aa"})
assert ad["a"] == ad["aa"] == 0
```