Interfaces¶

Base Interface metaclass

class Interface(shape: Tuple[int, ...] | Any, dtype: str | type | Any | generic)[source]¶

Abstract parent class for interfaces to different array formats

validate(array: Any) → T[source]¶: Validate input, returning final array type

before_validation(array: Any) → NDArrayType[source]¶

Optional step pre-validation that coerces the input into a type that can be validated for shape and dtype

Default method is a no-op

Validate the dtype of the given array, returning it unmutated.

Validate the shape of the given array, returning it unmutated

after_validation(array: NDArrayType) → T[source]¶

Optional step post-validation that coerces the intermediate array type into the return type

Default method is a no-op

abstract classmethod check(array: Any) → bool[source]¶: Method to check whether a given input applies to this interface

abstract classmethod enabled() → bool[source]¶: Check whether this array interface can be used (eg. its dependent packages are installed, etc.)

classmethod to_json(array: Type[T], info: SerializationInfo | None = None) → list | dict[source]¶: Convert an array of return_type to a JSON-compatible format using base python types

classmethod interfaces() → Tuple[Type[Interface], ...][source]¶: Enabled interface subclasses

classmethod return_types() → Tuple[NDArrayType, ...][source]¶: Return types for all enabled interfaces

classmethod input_types() → Tuple[Any, ...][source]¶: Input types for all enabled interfaces

classmethod match(array: Any) → Type[Interface][source]¶: Find the interface that should be used for this array based on its input type

classmethod match_output(array: Any) → Type[Interface][source]¶: Find the interface that should be used based on the output type - in the case that the output type differs from the input type, eg. the HDF5 interface, match an instantiated array for purposes of serialization to json, etc.