Skip to content

Narrow the transform validators' catch-all return types #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
user27182 merged 1 commit into from
Sep 27, 2026
Merged

Narrow the transform validators' catch-all return types #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pyvista_validation/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ def validate_rotation(rotation: Sequence[Sequence[float]], must_have_handedness:
@overload
def validate_rotation(rotation: _lazy_import.vtkMatrix3x3 | _lazy_import.Rotation[tuple[()]], must_have_handedness: Literal['right', 'left'] | None = ..., *, tolerance: float = ..., name: str = ...) -> _Array2D[np.float64]: ...
@overload
def validate_rotation(rotation: RotationLike, must_have_handedness: Literal['right', 'left'] | None = ..., *, tolerance: float = ..., name: str = ...) -> _Array2D[_Scalar]: ...
def validate_rotation(rotation: RotationLike, must_have_handedness: Literal['right', 'left'] | None = ..., *, tolerance: float = ..., name: str = ...) -> _Array2D[_Real]: ...
# fmt: on
def validate_rotation(
rotation: RotationLike,
Expand Down Expand Up @@ -1083,7 +1083,7 @@ def validate_transform4x4(transform: Sequence[Sequence[float]], /, *, must_be_fi
@overload
def validate_transform4x4(transform: _lazy_import.vtkMatrix3x3 | _lazy_import.vtkMatrix4x4 | _lazy_import.vtkTransform | _lazy_import.Rotation[tuple[()]], /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[np.float64]: ...
@overload
def validate_transform4x4(transform: TransformLike, /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[_Scalar]: ...
def validate_transform4x4(transform: TransformLike, /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[_Floating]: ...
# fmt: on
def validate_transform4x4(
transform: TransformLike, /, *, must_be_finite: bool = True, name: str = 'Transform'
Expand Down Expand Up @@ -1170,7 +1170,7 @@ def validate_transform3x3(transform: Sequence[Sequence[float]], /, *, must_be_fi
@overload
def validate_transform3x3(transform: _lazy_import.vtkMatrix3x3 | _lazy_import.Rotation[tuple[()]], /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[np.float64]: ...
@overload
def validate_transform3x3(transform: TransformLike, /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[_Scalar]: ...
def validate_transform3x3(transform: TransformLike, /, *, must_be_finite: bool = ..., name: str = ...) -> _Array2D[_Real]: ...
# fmt: on
def validate_transform3x3(
transform: TransformLike, /, *, must_be_finite: bool = True, name: str = 'Transform'
Expand Down
8 changes: 5 additions & 3 deletions tests/typing/cases/validate_transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
from pyvista_validation._typing import RotationLike
from pyvista_validation._typing import TransformLike
from pyvista_validation._typing import _Array2D
from pyvista_validation._typing import _Floating
from pyvista_validation._typing import _Real
from pyvista_validation._typing import _Scalar


Expand Down Expand Up @@ -47,7 +49,7 @@ def transform_like() -> TransformLike:
)
assert_types(validate_rotation(vtkMatrix3x3()), _Array2D[np.float64])
assert_types(validate_rotation(Rotation.identity()), _Array2D[np.float64])
assert_types(validate_rotation(rotation_like()), _Array2D[_Scalar])
assert_types(validate_rotation(rotation_like()), _Array2D[_Real])
assert_types(validate_rotation(np.eye(3), 'right'), _Array2D[np.float64])
assert_types(validate_transform3x3(np.eye(3, dtype=np.float32)), _Array2D[np.float32])
assert_types(validate_transform3x3([[1, 0, 0], [0, 1, 0], [0, 0, 1]]), _Array2D[np.int64])
Expand All @@ -57,7 +59,7 @@ def transform_like() -> TransformLike:
)
assert_types(validate_transform3x3(vtkMatrix3x3()), _Array2D[np.float64])
assert_types(validate_transform3x3(Rotation.identity()), _Array2D[np.float64])
assert_types(validate_transform3x3(rotation_like()), _Array2D[_Scalar])
assert_types(validate_transform3x3(rotation_like()), _Array2D[_Real])
assert_types(
validate_transform4x4(np.eye(4, dtype=np.float32)),
_Array2D[np.float32],
Expand All @@ -75,7 +77,7 @@ def transform_like() -> TransformLike:
assert_types(validate_transform4x4(vtkMatrix4x4()), _Array2D[np.float64])
assert_types(validate_transform4x4(vtkTransform()), _Array2D[np.float64])
assert_types(validate_transform4x4(Rotation.identity()), _Array2D[np.float64])
assert_types(validate_transform4x4(transform_like()), _Array2D[_Scalar])
assert_types(validate_transform4x4(transform_like()), _Array2D[_Floating])
assert_types(
validate_transform4x4(np.eye(3, dtype=np.float32)),
_Array2D[np.float32],
Expand Down
Loading