typing

_typing

Utility function for typing purposes.

is_expected_type

is_expected_type(value: object, expected_type: Any) -> bool

Check if an object is a given type.

Uses typeguard library to check objects using typing definitions.

PARAMETER	DESCRIPTION
value	Value to be checked against expected_type. TYPE: object
expected_type	A class or generic type instance. TYPE: Any

RETURNS	DESCRIPTION
bool	Flag whether the object is an instance of the required type. TYPE: bool

Source code in srai/_typing.py

def is_expected_type(value: object, expected_type: Any) -> bool:
    """
    Check if an object is a given type.

    Uses `typeguard` library to check objects using `typing` definitions.

    Args:
        value (object): Value to be checked against `expected_type`.
        expected_type (Any): A class or generic type instance.

    Returns:
        bool: Flag whether the object is an instance of the required type.
    """
    result = False

    with suppress(TypeCheckError):
        check_type(value, expected_type)
        result = True

    return result