Skip to content

daft.functions.list_flatten#

list_flatten #

list_flatten(list_expr: Expression) -> Expression

Flattens one level of nesting in each list.

Outer null rows are preserved as null. Null inner lists are skipped while flattening, and null leaf values are preserved in the output.

Parameters:

Name Type Description Default
list_expr List Expression

expression to flatten one level.

required

Returns:

Name Type Description
Expression List Expression

an expression with one fewer level of list nesting.

Source code in daft/functions/list.py
74
75
76
77
78
79
80
81
82
83
84
85
86
def list_flatten(list_expr: Expression) -> Expression:
    """Flattens one level of nesting in each list.

    Outer null rows are preserved as null. Null inner lists are skipped while flattening,
    and null leaf values are preserved in the output.

    Args:
        list_expr (List Expression): expression to flatten one level.

    Returns:
        Expression (List Expression): an expression with one fewer level of list nesting.
    """
    return Expression._call_builtin_scalar_fn("list_flatten", list_expr)