Replacing typish with runtype (#1967)

* Initial commit with bulk replace of typish

* Created wrapped instance_of in utils

* Fixed typing for mypy

Author: jmwright

cadquery/assembly.py

@@ -12,7 +12,6 @@
     get_args,
 )
 from typing_extensions import Literal, Self
-from typish import instance_of
 from uuid import uuid1 as uuid
 from warnings import warn
 from itertools import chain
@@ -39,7 +38,7 @@
 from .occ_impl.importers.assembly import importStep as _importStep, importXbf, importXml
 
 from .selectors import _expression_grammar as _selector_grammar
-from .utils import deprecate, BiDict
+from .utils import deprecate, BiDict, instance_of
 
 # type definitions
 AssemblyObjects = Union[Shape, Workplane, None]

cadquery/fig.py

@@ -10,8 +10,6 @@
 from itertools import chain
 from webbrowser import open_new_tab
 
-from typish import instance_of
-
 from trame.app import get_server
 from trame.app.core import Server
 from trame.widgets import html, vtk as vtk_widgets, client
@@ -33,6 +31,8 @@
 
 from vtkmodules.vtkInteractionStyle import vtkInteractorStyleTrackballCamera
 
+from .utils import instance_of
+
 FULL_SCREEN = "position:absolute; left:0; top:0; width:100vw; height:100vh;"
 
 

cadquery/occ_impl/solver.py

@@ -9,10 +9,10 @@
     Literal,
     cast as tcast,
     Type,
+    get_origin,
 )
 
 from math import radians, pi
-from typish import instance_of, get_type
 
 import casadi as ca
 
@@ -33,6 +33,7 @@
 from .geom import Location, Vector, Plane
 from .shapes import Shape, Face, Edge, Wire
 from ..types import Real
+from ..utils import instance_of
 
 # type definitions
 
@@ -179,7 +180,7 @@ def _validate(self, args: Tuple[Shape, ...], kind: ConstraintKind, param: Any):
         # check parameter
         if not instance_of(param, param_type) and param is not None:
             raise ValueError(
-                f"Unsupported argument types {get_type(param)}, required {param_type}."
+                f"Unsupported argument types {get_origin(param)}, required {param_type}."
             )
 
         # check parameter conversion

cadquery/sketch.py

@@ -13,17 +13,17 @@
     cast as tcast,
     Literal,
     overload,
+    get_origin,
 )
 
 from math import tan, sin, cos, pi, radians, remainder
 from itertools import product, chain
 from multimethod import multimethod
-from typish import instance_of, get_type
 
 from .hull import find_hull
 from .selectors import StringSyntaxSelector, Selector
 from .types import Real
-from .utils import get_arity
+from .utils import get_arity, instance_of
 
 from .occ_impl.shapes import (
     Shape,
@@ -117,7 +117,7 @@ def __init__(
 
         if not instance_of(param, param_type):
             raise ValueError(
-                f"Unsupported argument types {get_type(param)}, required {param_type}."
+                f"Unsupported argument types {get_origin(param)}, required {param_type}."
             )
 
         # if all is fine store everything and possibly convert the params

cadquery/utils.py

@@ -1,6 +1,7 @@
 from functools import wraps
 from inspect import signature, isbuiltin
-from typing import TypeVar, Callable, cast
+from typing import TypeVar, Callable, cast, Any
+from runtype import isa
 from warnings import warn
 from collections import UserDict
 
@@ -116,3 +117,11 @@ def __setitem__(self, k: K, v: V):
     def inv(self) -> dict[V, list[K]]:
 
         return self._inv
+
+
+def instance_of(obj: object, *args: object) -> bool:
+    """
+    Replacement for the instance_of method of typish, which
+    now uses the isa method of the runtype package.
+    """
+    return isa(obj, cast(tuple[type[Any], ...], args))

cadquery/vis.py

@@ -14,8 +14,6 @@
 
 from typing import Union, Any, List, Tuple, Iterable, cast, Optional
 
-from typish import instance_of
-
 from OCP.TopoDS import TopoDS_Shape
 from OCP.Geom import Geom_BSplineSurface
 
@@ -39,6 +37,7 @@
 from vtkmodules.vtkCommonColor import vtkNamedColors
 from vtkmodules.vtkIOImage import vtkPNGWriter
 
+from .utils import instance_of
 
 DEFAULT_COLOR = (1, 0.8, 0)
 DEFAULT_EDGE_COLOR = (0, 0, 0)

conda/meta.yaml

@@ -25,7 +25,7 @@ requirements:
     - nlopt
     - multimethod >=1.11,<2.0
     - casadi
-    - typish
+    - runtype
     - trame
     - trame-vtk
 

environment.yml

@@ -18,7 +18,7 @@ dependencies:
   - nlopt
   - path
   - casadi
-  - typish
+  - runtype
   - multimethod >=1.11,<2.0
   - typed-ast
   - regex

mypy.ini

@@ -31,7 +31,7 @@ ignore_missing_imports = True
 [mypy-docutils.*]
 ignore_missing_imports = True
 
-[mypy-typish.*]
+[mypy-runtype.*]
 ignore_missing_imports = True
 
 [mypy-casadi.*]

setup.py

@@ -30,7 +30,7 @@
         "ezdxf>=1.3.0",
         "multimethod>=1.11,<2.0",
         "nlopt>=2.9.0,<3.0",
-        "typish",
+        "runtype",
         "casadi",
         "path",
         "trame",