Skip to content

dedupe typevars, code cleanup, better newlines #21

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

Merged
merged 2 commits into from
Sep 17, 2024
Merged

dedupe typevars, code cleanup, better newlines #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fe767e
dedupe typevars, code cleanup, better newlines
jorenham Sep 17, 2024
7b90f74
update feature implementation status
jorenham Sep 17, 2024
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
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,13 @@ Options:
- [ ] Remove `typing.Any` when used as base class
- Generated `TypeVar`s
- [ ] Prefix extracted `TypeVar`s names with `_`
- [ ] De-duplicate extracted `TypeVar`s
- [ ] Prevent `TypeVar` name clashes (rename or merge)
- [x] De-duplicate extracted typevar-likes with same name if equivalent
- [ ] Rename extracted typevar-likes with same name if not equivalent
- [ ] Infer variance of `typing_extensions.TypeVar(..., infer_variance=True)` whose
name does not end with `_contra`/`_in` (`contravariant=True`) or `_co`/`_out`
(`covariant=True`)
- [x] Convert `default=Any` to `default={bound}` or `default=object`
- [x] Remove `bound=Any` and `bound=object`
- [ ] Importing `TypeVar`'s (not recommended)
- Imports
- [x] Reuse existing `from typing[_extensions] import {name}` imports instead of
adding new ones
Expand Down
69 changes: 69 additions & 0 deletions tests/test_py311.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ def test_type_alias_param():
""")
pyi_expect = _src("""
from typing import TypeAlias, TypeVar

T = TypeVar("T")
Pair: TypeAlias = tuple[T, T]
""")
Expand All @@ -54,6 +55,7 @@ def test_type_alias_param_bound():
""")
pyi_expect = _src("""
from typing import TypeAlias, TypeVar

N = TypeVar("N", bound=int)
Shape2D: TypeAlias = tuple[N, N]
""")
Expand All @@ -72,6 +74,7 @@ def test_type_alias_param_constraints():
from typing import TypeAlias, TypeVar

S = TypeVar("S", bytes, str)

PathLike: TypeAlias = S | os.PathLike[S]
""")
pyi_out = convert(pyi_in, python=PythonVersion.PY311)
Expand All @@ -85,6 +88,7 @@ def test_type_alias_param_default():
pyi_expect = _src("""
from typing import TypeAlias
from typing_extensions import TypeVar

T = TypeVar("T", default=object)
OneOrMany: TypeAlias = T | tuple[T, ...]
""")
Expand All @@ -99,6 +103,7 @@ def test_type_alias_params_order_mismatch():
pyi_expect = _src("""
from typing import TypeVar
from typing_extensions import TypeAliasType

T1 = TypeVar("T1")
T0 = TypeVar("T0")
RPair = TypeAliasType("RPair", tuple[T0, T1], type_params=(T1, T0))
Expand All @@ -107,12 +112,38 @@ def test_type_alias_params_order_mismatch():
assert pyi_out == pyi_expect


def test_type_alias_dupe_same():
pyi_in = _src("""
type Solo[T] = tuple[T]
type Pair[T] = tuple[T, T]
""")
pyi_expect = _src("""
from typing import TypeAlias, TypeVar

T = TypeVar("T")
Solo: TypeAlias = tuple[T]
Pair: TypeAlias = tuple[T, T]
""")
pyi_out = convert(pyi_in, python=PythonVersion.PY311)
assert pyi_out == pyi_expect


def test_type_alias_dupe_clash():
pyi_in = _src("""
type Solo[T] = tuple[T]
type SoloName[T: str] = tuple[T]
""")
with pytest.raises(NotImplementedError):
convert(pyi_in, python=PythonVersion.PY311)


def test_generic_function():
pyi_in = _src("""
def spam[T](x: T) -> T: ...
""")
pyi_expect = _src("""
from typing import TypeVar

T = TypeVar("T")
def spam(x: T) -> T: ...
""")
Expand All @@ -126,6 +157,7 @@ def f[Z: complex](z: Z) -> Z: ...
""")
pyi_expect = _src("""
from typing import TypeVar

Z = TypeVar("Z", bound=complex)
def f(z: Z) -> Z: ...
""")
Expand All @@ -139,6 +171,7 @@ def f[Z: (int, float, complex)](z: Z) -> Z: ...
""")
pyi_expect = _src("""
from typing import TypeVar

Z = TypeVar("Z", int, float, complex)
def f(z: Z) -> Z: ...
""")
Expand All @@ -152,6 +185,7 @@ def f[Z: complex = complex](z: Z = ...) -> Z: ...
""")
pyi_expect = _src("""
from typing_extensions import TypeVar

Z = TypeVar("Z", bound=complex, default=complex)
def f(z: Z = ...) -> Z: ...
""")
Expand All @@ -177,13 +211,48 @@ def f(z: Z = ...) -> Z: ...
assert pyi_out == pyi_expect


def test_generic_function_dupe_same():
pyi_in = _src("""
def f[T](x: T, /) -> T: ...
def g[T](y: T, /) -> T: ...
""")
pyi_expect = _src("""
from typing import TypeVar

T = TypeVar("T")
def f(x: T, /) -> T: ...
def g(y: T, /) -> T: ...
""")
pyi_out = convert(pyi_in, python=PythonVersion.PY311)
assert pyi_out == pyi_expect


def test_generic_function_dupe_clash_bound():
pyi_in = _src("""
def f[T](x: T, /) -> T: ...
def g[T: str](v: T, /) -> T: ...
""")
with pytest.raises(NotImplementedError):
convert(pyi_in, python=PythonVersion.PY311)


def test_generic_function_dupe_clash_type():
pyi_in = _src("""
def f[T](x: T, /) -> T: ...
def g[*T](*xs: *T) -> T: ...
""")
with pytest.raises(NotImplementedError):
convert(pyi_in, python=PythonVersion.PY311)


def test_generic_class():
pyi_in = _src("""
class C[T_contra, T, T_co]: ...
""")
pyi_expect = _src("""
from typing import Generic
from typing_extensions import TypeVar

T_contra = TypeVar("T_contra", contravariant=True)
T = TypeVar("T", infer_variance=True)
T_co = TypeVar("T_co", covariant=True)
Expand Down
Loading