Skip to content

🎨 simplified ctypeslib & ctypes scalar embeddings #524

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
jorenham merged 4 commits into from
Apr 16, 2025
Merged

🎨 simplified ctypeslib & ctypes scalar embeddings #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eca1190
🎨 simplify `ctypeslib.as_ctypes_type` using `_numtype.ToDType*`
jorenham Apr 16, 2025
a58d879
🩹 use `Any` as contravariant type parameter default (LSP)
jorenham Apr 16, 2025
9f9a138
✨ scalar-type embeded `ctypes` types
jorenham Apr 16, 2025
4637688
🎨 massively simplify `ctypeslib.as_ctypes`
jorenham Apr 16, 2025
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
2 changes: 1 addition & 1 deletion src/_numtype/op.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ __all__ = [ # noqa: RUF022

###

_T_contra = TypeVar("_T_contra", contravariant=True, default=object)
_T_contra = TypeVar("_T_contra", contravariant=True, default=Any)
_T_co = TypeVar("_T_co", covariant=True, default=Any)

###
Expand Down
3 changes: 0 additions & 3 deletions src/numpy-stubs/@test/static/accept/ctypeslib.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,3 @@ assert_type(np.ctypeslib.as_ctypes(AR_f8), ct.Array[ct.c_double])
assert_type(np.ctypeslib.as_array(AR_u1), npt.NDArray[np.ubyte])
assert_type(np.ctypeslib.as_array(1), npt.NDArray[Any])
assert_type(np.ctypeslib.as_array(pointer), npt.NDArray[Any])

assert_type(np.ctypeslib.as_ctypes_type(int), type[ct.c_ssize_t])
assert_type(np.ctypeslib.as_ctypes_type("N"), type[ct.c_size_t])
106 changes: 81 additions & 25 deletions src/numpy-stubs/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,14 @@ _HasDTypeWithItem: TypeAlias = _HasDType[_HasTypeWithItem[_T]]
_HasDTypeWithReal: TypeAlias = _HasDType[_HasTypeWithReal[_T]]
_HasDTypeWithImag: TypeAlias = _HasDType[_HasTypeWithImag[_T]]

_CT = TypeVar("_CT", bound=ct._SimpleCData[Any])
_CT_co = TypeVar("_CT_co", bound=ct._SimpleCData[Any], covariant=True)

@type_check_only
class _HasCType(Protocol[_CT_co]):
@property
def __ctype__(self, /) -> _CT_co: ...

@type_check_only
class _HasDateAttributes(Protocol):
# The `datetime64` constructors requires an object with the three attributes below,
Expand All @@ -1028,22 +1036,6 @@ class _HasDateAttributes(Protocol):
@property
def year(self) -> int: ...

@type_check_only
class _CanLT(Protocol):
def __lt__(self, x: Any, /) -> Any: ...

@type_check_only
class _CanLE(Protocol):
def __le__(self, x: Any, /) -> Any: ...

@type_check_only
class _CanGT(Protocol):
def __gt__(self, x: Any, /) -> Any: ...

@type_check_only
class _CanGE(Protocol):
def __ge__(self, x: Any, /) -> Any: ...

###
# Mixins (for internal use only)

Expand Down Expand Up @@ -1077,33 +1069,33 @@ class _CmpOpMixin(Generic[_ScalarLikeT_contra, _ArrayLikeT_contra]):
@overload
def __lt__(self, x: _ScalarLikeT_contra, /) -> bool_: ...
@overload
def __lt__(self, x: _ArrayLikeT_contra | _NestedSequence[_CanGT], /) -> NDArray[bool_]: ...
def __lt__(self, x: _ArrayLikeT_contra | _NestedSequence[_nt.op.CanGt], /) -> NDArray[bool_]: ...
@overload
def __lt__(self, x: _CanGT, /) -> bool_: ...
def __lt__(self, x: _nt.op.CanGt, /) -> bool_: ...

#
@overload
def __le__(self, x: _ScalarLikeT_contra, /) -> bool_: ...
@overload
def __le__(self, x: _ArrayLikeT_contra | _NestedSequence[_CanGE], /) -> NDArray[bool_]: ...
def __le__(self, x: _ArrayLikeT_contra | _NestedSequence[_nt.op.CanGe], /) -> NDArray[bool_]: ...
@overload
def __le__(self, x: _CanGE, /) -> bool_: ...
def __le__(self, x: _nt.op.CanGe, /) -> bool_: ...

#
@overload
def __gt__(self, x: _ScalarLikeT_contra, /) -> bool_: ...
@overload
def __gt__(self, x: _ArrayLikeT_contra | _NestedSequence[_CanLT], /) -> NDArray[bool_]: ...
def __gt__(self, x: _ArrayLikeT_contra | _NestedSequence[_nt.op.CanLt], /) -> NDArray[bool_]: ...
@overload
def __gt__(self, x: _CanLT, /) -> bool_: ...
def __gt__(self, x: _nt.op.CanLt, /) -> bool_: ...

#
@overload
def __ge__(self, x: _ScalarLikeT_contra, /) -> bool_: ...
@overload
def __ge__(self, x: _ArrayLikeT_contra | _NestedSequence[_CanLE], /) -> NDArray[bool_]: ...
def __ge__(self, x: _ArrayLikeT_contra | _NestedSequence[_nt.op.CanLe], /) -> NDArray[bool_]: ...
@overload
def __ge__(self, x: _CanLE, /) -> bool_: ...
def __ge__(self, x: _nt.op.CanLe, /) -> bool_: ...

@type_check_only
class _IntMixin(Generic[_IntSizeT_co]):
Expand Down Expand Up @@ -1908,6 +1900,11 @@ class _ArrayOrScalarCommon:
class ndarray(_ArrayOrScalarCommon, Generic[_ShapeT_co, _DTypeT_co]):
__hash__: ClassVar[None] # type: ignore[assignment] # pyright: ignore[reportIncompatibleMethodOverride]

#
@property
@type_check_only
def __ctype__(self: _HasDType[_HasType[_HasCType[_CT]]], /) -> ct.Array[_CT]: ...

#
@property
def base(self) -> NDArray[Any] | None: ...
Expand Down Expand Up @@ -3927,6 +3924,11 @@ class generic(_ArrayOrScalarCommon, Generic[_ItemT_co]):

# NOTE: Naming it `bool_` results in less unreadable type-checker output
class bool_(generic[_BoolItemT_co], Generic[_BoolItemT_co]):
@property
@type_check_only
def __ctype__(self) -> ct.c_bool: ...

#
@type_check_only
def __nep50__(self, below: _nt.co_number | timedelta64, above: Never, /) -> bool_: ...
@type_check_only
Expand Down Expand Up @@ -4386,7 +4388,6 @@ class number(_CmpOpMixin[_nt.CoComplex_0d, _nt.CoComplex_1nd], generic[_NumberIt
@abc.abstractmethod
@type_check_only
def __nep50_complex__(self, /) -> complexfloating: ...
#
@type_check_only
def __nep50_rule6__(self, other: _JustNumber, /) -> number: ...

Expand Down Expand Up @@ -4682,6 +4683,11 @@ class signedinteger(integer):
def __nep50_rule5__(self, other: _JustInteger | _JustUnsignedInteger, /) -> signedinteger | float64: ...

class int8(_IntMixin[L[1]], signedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_int8: ...

#
@override
@type_check_only
def __nep50__(
Expand All @@ -4703,6 +4709,11 @@ class int8(_IntMixin[L[1]], signedinteger):
byte = int8

class int16(_IntMixin[L[2]], signedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_int16: ...

#
@override
@type_check_only
def __nep50__(
Expand All @@ -4724,6 +4735,11 @@ class int16(_IntMixin[L[2]], signedinteger):
short = int16

class int32(_IntMixin[L[4]], signedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_int32: ...

#
@override
@type_check_only
def __nep50__(
Expand All @@ -4748,6 +4764,11 @@ class int32(_IntMixin[L[4]], signedinteger):
intc = int32

class int64(_IntMixin[L[8]], signedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_int64: ...

#
@override
@type_check_only
def __nep50__(
Expand Down Expand Up @@ -4799,6 +4820,11 @@ class unsignedinteger(integer):
def __nep50_rule3__(self, other: _JustUnsignedInteger, /) -> unsignedinteger: ...

class uint8(_IntMixin[L[1]], unsignedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_uint8: ...

#
@override
@type_check_only
def __nep50__(
Expand All @@ -4824,6 +4850,11 @@ class uint8(_IntMixin[L[1]], unsignedinteger):
ubyte = uint8

class uint16(_IntMixin[L[2]], unsignedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_uint16: ...

#
@override
@type_check_only
def __nep50__(
Expand Down Expand Up @@ -4851,6 +4882,11 @@ class uint16(_IntMixin[L[2]], unsignedinteger):
ushort = uint16

class uint32(_IntMixin[L[4]], unsignedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_uint32: ...

#
@override
@type_check_only
def __nep50__(
Expand Down Expand Up @@ -4878,6 +4914,11 @@ class uint32(_IntMixin[L[4]], unsignedinteger):
uintc = uint32

class uint64(_IntMixin[L[8]], unsignedinteger):
@property
@type_check_only
def __ctype__(self) -> ct.c_uint64: ...

#
@override
@type_check_only
def __nep50__(
Expand Down Expand Up @@ -5021,6 +5062,11 @@ class float16(_FloatMixin[L[2]], floating):
half = float16

class float32(_FloatMixin[L[4]], floating):
@property
@type_check_only
def __ctype__(self) -> ct.c_float: ...

#
@override
@type_check_only
def __nep50__(self, below: _float32_min | complexfloating, above: float16 | _nt.co_integer16, /) -> float32: ...
Expand All @@ -5040,6 +5086,11 @@ class float32(_FloatMixin[L[4]], floating):
single = float32

class float64(_FloatMixin[L[8]], floating, float): # type: ignore[misc]
@property
@type_check_only
def __ctype__(self) -> ct.c_double: ...

#
@override
@type_check_only
def __nep50__(self, below: _inexact64_min, above: _float32_max | _nt.co_integer, /) -> float64: ...
Expand Down Expand Up @@ -5076,6 +5127,11 @@ class float64(_FloatMixin[L[8]], floating, float): # type: ignore[misc]
double = float64

class longdouble(_FloatMixin[L[12, 16]], floating):
@property
@type_check_only
def __ctype__(self) -> ct.c_longdouble: ...

#
@override
@type_check_only
def __nep50__(
Expand Down
Loading