filter_df

caf.toolkit.pandas_utils.filter_df(df, df_filter, throw_error=False)

Filter a pandas DataFrame by a filter.

Parameters:

• df (DataFrame) – The pandas.Dataframe to filter.

• df_filter (dict[str, Any]) – Dictionary of {column: valid_values} pairs to define the filter to be applied. valid_values can be a single value or a list of values. Will return only where all column conditions are met.

• throw_error (bool) – Whether to throw an error if the filtered dataframe has no rows left

Returns:

A copy of df, filtered down to df_filter.

Return type:

filtered_df