src.fairreckitlib.core.parsing.parse_event

 1"""This module contains an event id, event args and print function for a parsing event.
 2
 3Constants:
 4
 5    ON_PARSE: id of the event that is used when parsing fails.
 6
 7Classes:
 8
 9    ParseEventArgs: event args related to parsing.
10
11Functions:
12
13    print_parse_event: print parse event arguments.
14
15This program has been developed by students from the bachelor Computer Science at
16Utrecht University within the Software Project course.
17© Copyright Utrecht University (Department of Information and Computing Sciences)
18"""
19
20from dataclasses import dataclass
21from typing import Any, List, Type
22
23from ..events.event_args import MessageEventArgs
24
25ON_PARSE = 'Config.on_parse'
26
27
28@dataclass
29class ParseEventArgs(MessageEventArgs):
30    """Parse Event Arguments.
31
32    Only the message is required, other variables are optional.
33
34    message: the message describing the parsing failure.
35    one_of_list: a list of values that contains the expected value.
36    expected_type: the type that is expected to be parsed.
37    actual_type: the type that is attempted to be parsed.
38    default_value: the default value that is returned after parsing.
39    """
40
41    one_of_list: List[Any] = None
42    expected_type: Type = None
43    actual_type: Type = None
44    default_value: Any = None
45
46
47def print_parse_event(event_args: ParseEventArgs) -> None:
48    """Print parse event arguments.
49
50    Args:
51        event_args: the arguments to print.
52    """
53    if len(event_args.message) > 0:
54        print(event_args.message)
55    if event_args.one_of_list is not None:
56        print('\texpected one of: ' + str(event_args.one_of_list))
57    if event_args.expected_type is not None:
58        print('\texpect:', event_args.expected_type)
59    if event_args.actual_type is not None:
60        print('\tactual:', event_args.actual_type)
61    if event_args.default_value is not None:
62        print('\tdefault to:', event_args.default_value)