<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
[](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
- 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']
```
- origin_len
<br>(get original dict <i>length</i> 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "aldict",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "multi-key dictionary, multidict, alias-dict",
"author": null,
"author_email": "Kaloyan Ivanov <kaloyan.ivanov88@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/04/a8/52e66f72b25fa16b8627fb6e970cf87b1910160ebd0975eec4242ad62c5e/aldict-1.0.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/kaliv0/aldict/blob/main/assets/alter-ego.jpg?raw=true\" width=\"250\" alt=\"Alter Ego\">\n</p>\n\n---\n# Aldict\n\n[](https://github.com/kaliv0/aldict/actions/workflows/ci.yml)\n\n[](https://pypi.org/project/aldict/)\n[](https://github.com/kaliv0/aldict/blob/main/LICENSE)\n[](https://pepy.tech/projects/aldict)\n\nMulti-key dictionary, supports adding and manipulating key-aliases pointing to shared values\n\n---\n## How to use\n\n- add_alias\n<br>(pass <i>key</i> as first parameter and <i>alias(es)</i> as variadic params)\n```python\nad = AliasDict({\"a\": 1, \"b\": 2})\nad.add_alias(\"a\", \"aa\")\nad.add_alias(\"b\", \"bb\", \"Bbb\")\nassert ad[\"a\"] == ad[\"aa\"] == 1\nassert ad[\"b\"] == ad[\"bb\"] == ad[\"Bbb\"] == 2\n```\n- remove_alias\n<br>(pass <i>alias(es)</i> to be removed as variadic parameters)\n```python\nad.remove_alias(\"aa\")\nad.remove_alias(\"bb\", \"Bbb\")\nassert len(ad.aliases()) == 0\n```\n- clear_aliases\n<br>(remove all <i>aliases</i> at once)\n```python\nad.clear_aliases()\nassert len(ad.aliases()) == 0\n```\n- update alias\n<br>(point <i>alias</i> to different <i>key</i>)\n```python\nad = AliasDict({\"a\": 1, \"b\": 2})\nad.add_alias(\"a\", \"ab\")\nassert list(ad.items()) == [('a', 1), ('b', 2), ('ab', 1)]\n\nad.add_alias(\"b\", \"ab\")\nassert list(ad.items()) == [('a', 1), ('b', 2), ('ab', 2)]\n```\n- read all aliases\n```python\nad = AliasDict({\"a\": 1, \"b\": 2})\nad.add_alias(\"a\", \"aa\")\nad.add_alias(\"b\", \"bb\", \"B\")\nad.add_alias(\"a\", \"ab\", \"A\")\nassert list(ad.aliases()) == ['aa', 'bb', 'B', 'ab', 'A']\n```\n- aliased_keys\n<br>(read <i>keys</i> with corresponding <i>alias(es)</i>)\n```python\nassert dict(ad.aliased_keys()) == {'a': ['aa', 'ab', 'A'], 'b': ['bb', 'B']}\n```\n- read dictviews\n<br>(<i>dict.keys()</i> and <i>dict.items()</i> include <i>aliased</i> versions)\n```python\nad = AliasDict({\"x\": 10, \"y\": 20})\nad.add_alias(\"x\", \"Xx\")\nad.add_alias(\"y\", \"Yy\", \"xyz\")\n\nad.keys()\nad.values()\nad.items()\n```\n```shell\ndict_keys(['x', 'y', 'Xx', 'Yy', 'xyz'])\ndict_values([10, 20])\ndict_items([('x', 10), ('y', 20), ('Xx', 10), ('Yy', 20), ('xyz', 20)])\n```\n- remove key and aliases\n```python\nad.pop(\"y\")\nassert list(ad.items()) == [('x', 10), ('Xx', 10)]\n```\n- origin_keys\n<br>(get original <i>keys</i> only)\n```python\nassert list(ad.origin_keys()) == ['x', 'y']\n```\n- origin_len\n<br>(get original dict <i>length</i> without aliases)\n```python\nad = AliasDict({\"a\": 1, \"b\": 2})\nad.add_alias(\"a\", \"aa\")\nassert list(ad.keys()) == [\"a\", \"b\", \"aa\"]\nassert len(ad) == 3\nassert ad.origin_len() == 2\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Multi-key dictionary, supports adding and manipulating key-aliases pointing to shared values",
"version": "1.0.2",
"project_urls": {
"repository": "https://github.com/kaliv0/aldict"
},
"split_keywords": [
"multi-key dictionary",
" multidict",
" alias-dict"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91acb7ac28a2e76a5d737e31815b72a138428dc7881c30252c407d15fbd3ca7a",
"md5": "2de5955bb14a9ae4312a9beaae406304",
"sha256": "646cb29194d131d3e58dc553706b4ec70c8ca137515c8b316cd9ec1d2b0c2589"
},
"downloads": -1,
"filename": "aldict-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2de5955bb14a9ae4312a9beaae406304",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 4558,
"upload_time": "2024-12-21T11:05:30",
"upload_time_iso_8601": "2024-12-21T11:05:30.780124Z",
"url": "https://files.pythonhosted.org/packages/91/ac/b7ac28a2e76a5d737e31815b72a138428dc7881c30252c407d15fbd3ca7a/aldict-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04a852e66f72b25fa16b8627fb6e970cf87b1910160ebd0975eec4242ad62c5e",
"md5": "88ed797824659f62951d895e4ceea8f3",
"sha256": "40dcae3d6e9d26eedff5bedb869fab65cf65b93c6d3273255c4201f57bb4daf2"
},
"downloads": -1,
"filename": "aldict-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "88ed797824659f62951d895e4ceea8f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 5442,
"upload_time": "2024-12-21T11:05:33",
"upload_time_iso_8601": "2024-12-21T11:05:33.660837Z",
"url": "https://files.pythonhosted.org/packages/04/a8/52e66f72b25fa16b8627fb6e970cf87b1910160ebd0975eec4242ad62c5e/aldict-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 11:05:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaliv0",
"github_project": "aldict",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pytest",
"specs": [
[
">=",
"8.3.4"
]
]
},
{
"name": "ruff",
"specs": [
[
">=",
"0.8.3"
]
]
},
{
"name": "build",
"specs": [
[
">=",
"1.2.2"
]
]
},
{
"name": "twine",
"specs": [
[
">=",
"6.0.1"
]
]
}
],
"lcname": "aldict"
}
JSON
