Merge pull request #151 from oscarbenjamin/pr_pyright

Use pyright for type-checking

Author: oscarbenjamin

checks.sh

@@ -4,6 +4,7 @@ set -o errexit
 
 pre-commit run --all-files
 mypy --python-version=3.12 src tests
+pyright --pythonversion 3.12 src tests
 sphinx-build -b html docs docs/_build
 python -m xdoctest --quiet protosym
 pytest --cov=protosym

quicktest.sh

@@ -16,6 +16,7 @@ fi
 
 hatch run pre-commit:run
 hatch run types:mypy-check
+hatch run types:pyright-check
 hatch run docs:build
 hatch run test:doctest
 hatch run test:coverage

requirements-all.txt

@@ -2,3 +2,4 @@
 -r requirements-test.txt
 -r requirements-docs.txt
 mypy
+pyright

requirements-lint.txt

@@ -1,4 +1,3 @@
 ruff
-black
 pre-commit
 pre-commit-hooks

src/protosym/core/sym.py

@@ -10,7 +10,12 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING as _TYPE_CHECKING
 from typing import Any, Callable, Generic, Sequence, TypeVar, overload
+
+if _TYPE_CHECKING:
+    from typing_extensions import Self
+
 from weakref import WeakValueDictionary as _WeakDict
 
 from protosym.core.atom import AtomType
@@ -130,7 +135,7 @@ class Sym:
 
     rep: Tree
 
-    def __new__(cls, tree_expr: Tree) -> Sym:
+    def __new__(cls, tree_expr: Tree) -> Self:
         """Create a new Sym wrapping `tree_expr`.
 
         If an equivalent Sym instance already exists then the same object will

tests/core/test_sym.py

@@ -122,7 +122,7 @@ def test_Sym_evaluator() -> None:
     to_str[Integer[a]] = PyFunc1[int, str](str)(a)
     to_str[AtomRule[a]] = AtomFunc(str)(a)
     to_str[cos(a)] = PyOp1(lambda s: f"cos({s})")(a)
-    to_str[Add(star(a))] = PyOpN(" + ".join)(a)
+    to_str[Add(star(a))] = PyOpN(str(" + ").join)(a)
     to_str[HeadRule(a, b)] = HeadOp(lambda f, a: f"{f}({', '.join(a)})")(a, b)
 
     assert to_str(cos(one)) == "cos(1)"

tests/test_simplecas.py

@@ -186,7 +186,7 @@ def test_simplecas_to_sympy() -> None:
         (cos(x), cosx_sym),
         (cos(x) ** 2 + sin(x) ** 2, cosx_sym**2 + sinx_sym**2),  # pyright: ignore
         (cos(x) * sin(x), cosx_sym * sinx_sym),  # pyright: ignore
-        (f(x), f_sym(x_sym)),
+        (f(x), f_sym(x_sym)),  # pyright: ignore
     ]
     for expr, sympy_expr in test_cases:
         # XXX: Converting to SymPy and back does not in general round-trip