is_empty

paramcheckup.data_frames.is_empty(data_frame, param_name, kind, kind_name, stacklevel=4, error=True)

This function checks whether the data_frame is an empty DataFrame

Parameters:

data_frameDataFrame

The DataFrame to be checked for emptiness;

param_namestr

The name of the parameter that received the variable data_frame;

kindstr

The object where param_name is applied (function, method, class, etc.);

kind_namestr

The name of the object kind;

stacklevelint, optional

The stacking level (default is 4);

errorbool, optional

Whether to display error text (True, default) or not (False);

Returns:

outputTrue

If variable data_frame is NOT an empty DataFrame;

raisesValueError

If variable data_frame IS an empty DataFrame;

Examples

>>> import pandas as pd
>>> from paramcheckup import data_frames
>>> data = [["Anderson", 33], ["Juliana", 31], ["Marcos", 26], ["Mariana", 30]]
>>> columns = ["Name", "Age"]
>>> df = pd.DataFrame(
    data=data,
    columns=columns,
)
>>> output = data_frames.is_empty(
    data_frame=df,
    param_name="data_frame",
    kind="function",
    kind_name="database",
    stacklevel=3,
    error=True,
)
>>> print(output)
True

>>> import pandas as pd
>>> from paramcheckup import data_frames
>>> data = []
>>> columns = ["Name", "Age"]
>>> df = pd.DataFrame(
    data=data,
    columns=columns,
)
>>> output = data_frames.is_empty(
    data_frame=df,
    param_name="data_frame",
    kind="function",
    kind_name="database",
    stacklevel=3,
    error=False,
)
UserWarning at line 10: The `data_frame` in function `database` is an EMPTY DataFrame.