AbortAction

Bases: GenericAction

The AbortAction exception is raised when the user presses a key that is mapped to the "abort" action.

Parameters:

Name Type Description Default
action str

action

required
ch Optional[str]

pressed key

required
selected_item Any

selected item, if any

None
line Optional[str]

user input

None

Attributes:

Name Type Description
action

action

ch

pressed key

selected_item

selected item, if any

line

user input

Source code in pzp/exceptions.py
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class AbortAction(GenericAction):
    """
    The AbortAction exception is raised when the user presses a key
    that is mapped to the "abort" action.

    Args:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input

    Attributes:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input
    """

    def __init__(self, action: str, ch: Optional[str], selected_item: Any = None, line: Optional[str] = None):
        super().__init__(action, ch, selected_item, line)

AcceptAction

Bases: GenericAction

The AcceptAction exception is raised when the user presses a key that is mapped to the "accept" action.

Parameters:

Name Type Description Default
action str

action

required
ch Optional[str]

pressed key

required
selected_item Any

selected item, if any

None
line Optional[str]

user input

None

Attributes:

Name Type Description
action

action

ch

pressed key

selected_item

selected item, if any

line

user input

Source code in pzp/exceptions.py
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class AcceptAction(GenericAction):
    """
    The AcceptAction exception is raised when the user presses a key
    that is mapped to the "accept" action.

    Args:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input

    Attributes:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input
    """

    def __init__(self, action: str, ch: Optional[str], selected_item: Any = None, line: Optional[str] = None):
        super().__init__(action, ch, selected_item, line)

CustomAction

Bases: GenericAction

The CustomAction exception is raised when the user presses a key that is mapped to the "custom" action.

Parameters:

Name Type Description Default
action str

action

required
selected_item Any

selected item, if any

None
ch Optional[str]

pressed key

required
line Optional[str]

user input

None

Attributes:

Name Type Description
action

action

selected_item

selected item, if any

ch

pressed key

line

user input

Source code in pzp/exceptions.py
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class CustomAction(GenericAction):
    """
    The CustomAction exception is raised when the user presses a key
    that is mapped to the "custom" action.

    Args:
        action: action
        selected_item: selected item, if any
        ch: pressed key
        line: user input

    Attributes:
        action: action
        selected_item: selected item, if any
        ch: pressed key
        line: user input
    """

    def __init__(self, action: str, ch: Optional[str], selected_item: Any = None, line: Optional[str] = None):
        super().__init__(action, ch, selected_item, line)

GenericAction

Bases: PZPException

Generic Action Event

Parameters:

Name Type Description Default
action str

action

required
ch Optional[str]

pressed key

required
selected_item Any

selected item, if any

None
line Optional[str]

user input

None

Attributes:

Name Type Description
action

action

ch

pressed key

selected_item

selected item, if any

line

user input

Source code in pzp/exceptions.py
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class GenericAction(PZPException):
    """
    Generic Action Event

    Args:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input

    Attributes:
        action: action
        ch: pressed key
        selected_item: selected item, if any
        line: user input
    """

    def __init__(self, action: str, ch: Optional[str], selected_item: Any = None, line: Optional[str] = None):
        super().__init__(action)
        self.action = action
        self.ch = ch
        self.selected_item = selected_item
        self.line = line

MissingHander

Bases: PZPException

The MissingHander exception is raised when there is no handler for an action.

Parameters:

Name Type Description Default
action str

action

required
ch Optional[str]

pressed key

required

Attributes:

Name Type Description
action

action

ch

pressed key

Source code in pzp/exceptions.py
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class MissingHander(PZPException):
    """
    The MissingHander exception is raised when there is no handler for an action.

    Args:
        action: action
        ch: pressed key

    Attributes:
        action: action
        ch: pressed key
    """

    def __init__(self, action: str, ch: Optional[str]):
        super().__init__(action)
        self.action = action
        self.ch = ch

PZPException

Bases: Exception

Generic PZP Exception

Source code in pzp/exceptions.py
15
16
17
18
class PZPException(Exception):
    """
    Generic PZP Exception
    """