Implement RaiseError (#68)

Author: msullivan

pep.rst

@@ -785,10 +785,12 @@ All of the operators in this section are :ref:`lifted over union types
 Raise error
 '''''''''''
 
-* ``RaiseError[S: Literal[str]]``: If this type needs to be evaluated
+* ``RaiseError[S: Literal[str], *Ts]``: If this type needs to be evaluated
   to determine some actual type, generate a type error with the
   provided message.
 
+  Any additional type arguments should be included in the message.
+
 Update class
 ''''''''''''
 

tests/test_fastapilike_1.py

@@ -78,7 +78,7 @@ class _Default:
 
 type AddInit[T] = NewProtocol[
     InitFnType[T],
-    *Members[T]],
+    *Members[T],
 ]
 
 but we struggle here because typing wants to unpack the Members tuple

tests/test_type_eval.py

@@ -1645,3 +1645,29 @@ def test_type_eval_annotated_03():
 def test_type_eval_annotated_04():
     res = eval_typing(GetAnnotations[GetMemberType[AnnoTest, Literal["b"]]])
     assert res == Literal["blah"]
+
+
+##############
+# RaiseError tests
+
+from typemap.typing import RaiseError
+from typemap.type_eval import TypeMapError
+
+
+def test_raise_error_basic():
+    with pytest.raises(TypeMapError, match="Test error message"):
+        eval_typing(RaiseError[Literal["Test error message"]])
+
+
+def test_raise_error_with_types():
+    with pytest.raises(TypeMapError, match="Broadcast mismatch.*int.*str"):
+        eval_typing(RaiseError[Literal["Broadcast mismatch"], int, str])
+
+
+def test_raise_error_with_literal_types():
+    with pytest.raises(
+        TypeMapError, match="Shape mismatch.*Literal\\[4\\].*Literal\\[3\\]"
+    ):
+        eval_typing(
+            RaiseError[Literal["Shape mismatch"], Literal[4], Literal[3]]
+        )

typemap/type_eval/__init__.py

@@ -14,6 +14,8 @@
 # This one is imported for registering handlers
 from . import _eval_operators  # noqa
 
+from ._eval_operators import TypeMapError
+
 
 __all__ = (
     "eval_typing",
@@ -23,6 +25,7 @@
     "flatten_class",
     "issubtype",
     "issubsimilar",
+    "TypeMapError",
     "_EvalProxy",
     "_get_current_context",
 )

typemap/type_eval/_eval_operators.py

@@ -39,6 +39,7 @@
     Members,
     NewProtocol,
     Param,
+    RaiseError,
     Slice,
     SpecialFormEllipsis,
     StrConcat,
@@ -1020,6 +1021,30 @@ def func(*args, ctx):
 ##################################################################
 
 
+class TypeMapError(TypeError):
+    """Exception raised when RaiseError is evaluated."""
+
+    pass
+
+
+@type_eval.register_evaluator(RaiseError)
+@_lift_evaluated
+def _eval_RaiseError(msg, *extra_types, ctx):
+    """Evaluate RaiseError by raising a TypeMapError.
+
+    RaiseError[S, *Ts] raises a type error with message S,
+    including the string representations of any extra type arguments.
+    """
+    message = _from_literal(msg)
+    if extra_types:
+        type_strs = ", ".join(repr(t) for t in extra_types)
+        message = f"{message}: {type_strs}"
+    raise TypeMapError(message)
+
+
+##################################################################
+
+
 def _add_quals(typ, quals):
     for qual in (typing.ClassVar, typing.Final):
         if type_eval.issubsimilar(typing.Literal[qual.__name__], quals):

typemap/typing.py

@@ -183,6 +183,19 @@ class NewProtocol[*T]:
     pass
 
 
+class RaiseError[S: str, *Ts]:
+    """Raise a type error with the given message when evaluated.
+
+    RaiseError[S: Literal[str], *Ts]: If this type needs to be evaluated
+    to determine some actual type, generate a type error with the
+    provided message.
+
+    Any additional type arguments should be included in the message.
+    """
+
+    pass
+
+
 ##################################################################
 
 # TODO: type better