removed GenericMixin.type_var

Author: LostInDarkMath

CHANGELOG.md

@@ -9,6 +9,7 @@
 - removed decorator `@timer_class`
 - removed decorator `@uminplemented`
 - removed decorator `@trace_if_returns`
+- removed `GenericMixin.type_var`. Use `GenericMixin.type_vars` instead.
 - added `Taskfile.yml` and use it in CI
 - removed `create_pdoc.sh`
 - moved `examples` out of the package

pedantic/mixins/generic_mixin.py

@@ -17,32 +17,6 @@ class GenericMixin:
         {~T: <class 'str'>, ~U: <class 'int'>}
     """
 
-    @property
-    def type_var(self) -> type:
-        """
-        Get the type variable for this class.
-
-        Use this for convenience if your class has only one type parameter.
-
-        DO NOT call this inside __init__()!
-
-        Example:
-            >>> from typing import Generic, TypeVar
-            >>> T = TypeVar('T')
-            >>> class Foo(Generic[T], GenericMixin):
-            ...     value: T
-            >>> f = Foo[float]()
-            >>> f.type_var
-            <class 'float'>
-        """
-
-        types = self._get_resolved_typevars()
-
-        if len(types) > 1:
-            raise ValueError('You have multiple type parameters. Please use "type_vars" instead of "type_var".')
-
-        return next(iter(types.values()))
-
     @property
     def type_vars(self) -> dict[TypeVar, type]:
         """

tests/mixins/test_generic_mixin.py

@@ -16,13 +16,12 @@ class Foo(Generic[T], GenericMixin):
         value: T
 
     foo = Foo[str]()
-    assert foo.type_var == str
     assert foo.type_vars == {T: str}
 
     invalid = Foo()
 
     with pytest.raises(expected_exception=AssertionError) as err:
-        invalid.type_var
+        invalid.type_vars
 
     assert f'You need to instantiate this class with type parameters! Example: Foo[int]()' in err.value.args[0]
 
@@ -34,17 +33,12 @@ class Foo(Generic[T, U], GenericMixin):
 
     foo = Foo[str, int]()
 
-    with pytest.raises(expected_exception=ValueError) as err:
-       foo.type_var
-
-    assert 'You have multiple type parameters. Please use "type_vars" instead of "type_var".' in err.value.args[0]
-
     assert foo.type_vars == {T: str, U: int}
 
     invalid = Foo()
 
     with pytest.raises(expected_exception=AssertionError) as err:
-        invalid.type_var
+        invalid.type_vars
 
     assert 'You need to instantiate this class with type parameters! Example: Foo[int]()' in err.value.args[0]
 
@@ -56,15 +50,15 @@ class Foo(GenericMixin):
     invalid = Foo()
 
     with pytest.raises(expected_exception=AssertionError) as err:
-        invalid.type_var
+        invalid.type_vars
 
     assert err.value.args[0] == 'Foo is not a generic class. To make it generic, declare it like: class Foo(Generic[T], GenericMixin):...'
 
 
-def test_call_type_var_in_constructor():
+def test_call_type_vars_in_constructor():
     class Foo(Generic[T], GenericMixin):
         def __init__(self) -> None:
-            self.x = self.type_var()
+            self.x = self.type_vars
 
     with pytest.raises(expected_exception=AssertionError) as err:
         Foo[str]()