Function is_empty

dask/utils.py:2325–2362

Duck-typed check for “emptiness” of an object. Works for standard sequences (lists, tuples, etc.), NumPy arrays, and sparse-like objects (e.g., SciPy sparse arrays). The function checks: 1. If the object supports len(), returns True if len(obj) == 0. 2. If the obje

(obj)

def is_empty(obj):
    """
    Duck-typed check for “emptiness” of an object.

    Works for standard sequences (lists, tuples, etc.), NumPy arrays,
    and sparse-like objects (e.g., SciPy sparse arrays).

    The function checks:
        1. If the object supports len(), returns True if len(obj) == 0.
        2. If the object has a `.nnz` attribute (number of non-zero elements),
           returns True if `.nnz == 0`.
        3. If the object has a `.shape` attribute, returns True if any
           dimension is zero.
        4. Otherwise, returns False (assumes non-empty).

    Parameters
    ----------
    obj : any
        The object to check for emptiness.

    Returns
    -------
    bool
        True if the object is considered empty, False otherwise.
    """
    # Check standard sequences
    with contextlib.suppress(Exception):
        return len(obj) == 0

    # Sparse-like objects
    with contextlib.suppress(Exception):
        return obj.nnz == 0

    with contextlib.suppress(Exception):
        return 0 in obj.shape

    # Fallback: assume non-empty
    return False