Skip to content

Add generic aliases for collection types #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add generic aliases for collection types #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions basedtyping/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@
_tp_cache,
_type_check,
cast,
_alias,
)

import _collections_abc
import typing_extensions
from typing_extensions import Never, ParamSpec, Self, TypeAlias, TypeGuard, TypeVarTuple

Expand Down Expand Up @@ -556,3 +558,27 @@ def f[T](t: TypeForm[T]) -> T: ...

reveal_type(f(int | str)) # int | str
""")

# generic aliases
if TYPE_CHECKING:
dict_keyiterator = _collections_abc.dict_keyiterator # type: ignore[attr-defined]
dict_valueiterator = _collections_abc.dict_valueiterator # type: ignore[attr-defined]
dict_itemiterator = _collections_abc.dict_itemiterator # type: ignore[attr-defined]
list_iterator = _collections_abc.list_iterator # type: ignore[attr-defined]
list_reverseiterator = _collections_abc.list_reverseiterator # type: ignore[attr-defined]
set_iterator = _collections_abc.set_iterator # type: ignore[attr-defined]
tuple_iterator = _collections_abc.tuple_iterator # type: ignore[attr-defined]
Comment on lines +564 to +570
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these shouldnt be here because they dont exist. if theres a reason to assume theyll exist in the future there should be a comment saying so

dict_keys = _collections_abc.dict_keys
dict_values = _collections_abc.dict_values
dict_items = _collections_abc.dict_items
else:
dict_keyiterator = _alias(_collections_abc.dict_keyiterator, 2)
dict_valueiterator = _alias(_collections_abc.dict_valueiterator, 2)
dict_itemiterator = _alias(_collections_abc.dict_itemiterator, 2)
list_iterator = _alias(_collections_abc.list_iterator, 1)
list_reverseiterator = _alias(_collections_abc.list_reverseiterator, 1)
set_iterator = _alias(_collections_abc.set_iterator, 1)
tuple_iterator = _alias(_collections_abc.tuple_iterator, -1)
dict_keys = _alias(_collections_abc.dict_keys, 2)
dict_values = _alias(_collections_abc.dict_values, 2)
dict_items = _alias(_collections_abc.dict_items, 2)
30 changes: 30 additions & 0 deletions tests/test_aliases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
from __future__ import annotations

from basedtyping import (
dict_itemiterator,
dict_items,
dict_keyiterator,
dict_keys,
dict_valueiterator,
dict_values,
list_iterator,
list_reverseiterator,
set_iterator,
tuple_iterator,
)
import _collections_abc


def test_aliases():
dk = dict_keys[int, str]
dv = dict_values[int, str]
di = dict_items[int, str]
t1 = tuple_iterator[int, str]
t2 = tuple_iterator[int, ...]
si = set_iterator[int]
lr = list_reverseiterator[int]
li = list_iterator[int]
dii = dict_itemiterator[int, str]
dvi = dict_valueiterator[int, str]
dki = dict_keyiterator[int, str]
print(dk, dv, di, t1, t2, si, lr, li, dii, dvi, dki) # noqa: T201