src.fairreckitlib.data.filter.filter_event

 1"""This module contains event args and a print function for a filter event.
 2
 3Classes:
 4
 5    FilterDataframeEventArgs: event args related to filtering a dataframe.
 6
 7Functions:
 8
 9    print_filter_event_args: print filter event arguments.
10
11This program has been developed by students from the bachelor Computer Science at
12Utrecht University within the Software Project course.
13© Copyright Utrecht University (Department of Information and Computing Sciences)
14"""
15
16from dataclasses import dataclass
17
18from ...core.events.event_dispatcher import EventArgs
19from .filter_config import DataSubsetConfig
20
21
22@dataclass
23class FilterDataframeEventArgs(EventArgs):
24    """Filter Dataframe Event Arguments.
25
26    message: the message describing the parsing failure.
27    subset: the subset that is created from the dataframe.
28    """
29
30    subset: DataSubsetConfig
31
32
33def print_filter_event_args(event_args: FilterDataframeEventArgs, elapsed_time: float=None) -> None:
34    """Print filter dataframe event arguments.
35
36    It is assumed that the event started when elapsed_time is None and is finished otherwise.
37
38    Args:
39        event_args: the arguments to print.
40        elapsed_time: the time that has passed since the filtering started, expressed in seconds.
41    """
42    if elapsed_time is None:
43        print('Filtering dataframe:', event_args.subset)
44    else:
45        print(f'Filtered dataframe in {elapsed_time:1.4f}s')