Review comments

Author: jonathanberthias

src/pyscipopt/scip.pyi

@@ -1,10 +1,10 @@
 import os
 from collections.abc import Iterable, Mapping, Sequence
-from typing import Any, AnyStr, ClassVar, Literal, Self, SupportsFloat, Union, overload
+from typing import Any, AnyStr, ClassVar, Literal, SupportsFloat, Union, overload
 
 import numpy as np
 from _typeshed import Incomplete
-from typing_extensions import CapsuleType, disjoint_base
+from typing_extensions import CapsuleType, Self, disjoint_base
 
 CONST: Term
 EventNames: dict
@@ -31,25 +31,25 @@ str_conversion: Incomplete
 value_to_array: Incomplete
 
 @overload
-def exp(x: Expr | GenExpr) -> UnaryExpr: ...
+def exp(x: float | Expr | GenExpr) -> UnaryExpr: ...
 @overload
-def exp(x: MatrixExpr) -> MatrixGenExpr: ...
+def exp(x: list | tuple | np.ndarray | MatrixExpr) -> MatrixGenExpr: ...
 @overload
-def log(x: Expr | GenExpr) -> UnaryExpr: ...
+def log(x: float | Expr | GenExpr) -> UnaryExpr: ...
 @overload
-def log(x: MatrixExpr) -> MatrixGenExpr: ...
+def log(x: list | tuple | np.ndarray | MatrixExpr) -> MatrixGenExpr: ...
 @overload
-def sqrt(x: Expr | GenExpr) -> UnaryExpr: ...
+def sqrt(x: float | Expr | GenExpr) -> UnaryExpr: ...
 @overload
-def sqrt(x: MatrixExpr) -> MatrixGenExpr: ...
+def sqrt(x: list | tuple | np.ndarray | MatrixExpr) -> MatrixGenExpr: ...
 @overload
-def sin(x: Expr | GenExpr) -> UnaryExpr: ...
+def sin(x: float | Expr | GenExpr) -> UnaryExpr: ...
 @overload
-def sin(x: MatrixExpr) -> MatrixGenExpr: ...
+def sin(x: list | tuple | np.ndarray | MatrixExpr) -> MatrixGenExpr: ...
 @overload
-def cos(x: Expr | GenExpr) -> UnaryExpr: ...
+def cos(x: float | Expr | GenExpr) -> UnaryExpr: ...
 @overload
-def cos(x: MatrixExpr) -> MatrixGenExpr: ...
+def cos(x: list | tuple | np.ndarray | MatrixExpr) -> MatrixGenExpr: ...
 
 @disjoint_base
 class Benders:
@@ -253,7 +253,7 @@ class Constant(GenExpr):
     number: Incomplete
     def __init__(self, *args: Incomplete, **kwargs: Incomplete) -> None: ...
     def __pow__(  # type: ignore[override]
-        self, other: float | Constant, modulo: Incomplete = ..., /
+        self, other: float | Constant, mod: Incomplete = ..., /
     ) -> Constant: ...
 
 @disjoint_base
@@ -409,10 +409,17 @@ class Expr(ExprLike):
     @overload
     def __truediv__(self, other: np.ndarray | MatrixExpr, /) -> MatrixExpr: ...
     def __rtruediv__(self, other: float, /) -> ProdExpr: ...
+    # __pow__'s return type depends on the value of `other`:
+    # non-negative integers (including integer-valued floats) yield Expr,
+    # negative integers and non-integers yield PowExpr
+    # We annotate the int case as Expr to handle the common case (e.g. x**2)
+    # knowing it might be wrong in some cases, and likewise the float case as
+    # PowExpr can be wrong. We aim to make the stubs useful in common cases
+    # even though the type system cannot fully express the real types.
     @overload
-    def __pow__(self, other: int, modulo: Incomplete = ..., /) -> Expr: ...
+    def __pow__(self, other: int, mod: Incomplete = ..., /) -> Expr: ...
     @overload
-    def __pow__(self, other: float, module: Incomplete = ..., /) -> PowExpr: ...
+    def __pow__(self, other: float, mod: Incomplete = ..., /) -> PowExpr: ...
     def __rpow__(self, other: float, /) -> UnaryExpr: ...
     def __getitem__(self, index: Incomplete, /) -> Incomplete: ...
     def __iter__(self) -> Incomplete: ...
@@ -458,7 +465,6 @@ class GenExpr(ExprLike):
     @overload
     def __truediv__(self, other: np.ndarray | MatrixExpr, /) -> MatrixExpr: ...
     def __rtruediv__(self, other: float, /) -> ProdExpr: ...
-    def __ne__(self, other: object, /) -> bool: ...
     def __pow__(self, other: float | Constant, mod: Incomplete = ..., /) -> PowExpr: ...
     def __rpow__(self, other: float, mod: Incomplete = ..., /) -> UnaryExpr: ...
 

stubs/baseline.sh

@@ -9,6 +9,8 @@ python "$REPO_ROOT"/scripts/generate_expr_type_tests.py
 for test_file in "$REPO_ROOT"/tests/@types/*.py; do
     echo "Updating mypy baseline for $test_file"
     output_file="${test_file%.*}.mypy.out"
-    python -m mypy "$test_file" --warn-unused-ignores | grep "error:" > /tmp/pyscipopt-mypy-output.txt
-    cp /tmp/pyscipopt-mypy-output.txt "$output_file"
+    # write to a temp file first to avoid truncating the output file if mypy fails
+    tmp=$(mktemp)
+    python -m mypy "$test_file" --warn-unused-ignores | grep "error:" > "$tmp"
+    mv "$tmp" "$output_file"
 done

tests/@types/expr.mypy.out

@@ -17,6 +17,11 @@ tests/@types/expr.py:155: error: Expression is of type "Any", not "MatrixExpr"
 tests/@types/expr.py:242: error: Unused "type: ignore" comment  [unused-ignore]
 tests/@types/expr.py:243: error: Unused "type: ignore" comment  [unused-ignore]
 tests/@types/expr.py:244: error: Unused "type: ignore" comment  [unused-ignore]
+tests/@types/expr.py:245: error: Unused "type: ignore" comment  [unused-ignore]
+tests/@types/expr.py:246: error: Unused "type: ignore" comment  [unused-ignore]
+tests/@types/expr.py:247: error: Unused "type: ignore" comment  [unused-ignore]
+tests/@types/expr.py:248: error: Unused "type: ignore" comment  [unused-ignore]
+tests/@types/expr.py:249: error: Unused "type: ignore" comment  [unused-ignore]
 tests/@types/expr.py:250: error: Unused "type: ignore" comment  [unused-ignore]
 tests/@types/expr.py:251: error: Unused "type: ignore" comment  [unused-ignore]
 tests/@types/expr.py:270: error: Unused "type: ignore" comment  [unused-ignore]