/
params.py
83 lines (62 loc) · 1.86 KB
/
params.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
"""
Holds types used for processing parameters
"""
import math
from logging import getLogger
from typing import Any
from als.code_utilities import log, AlsLogAdapter
_LOGGER = AlsLogAdapter(getLogger(__name__), {})
# pylint: disable=R0903
class ProcessingParameter:
"""
Base class for all processing parameters
"""
@log
def __init__(self, name: str, description: str, default: Any):
self.name = name
self.description = description
self.default = default
self.value = self.default
@log
def reset(self):
"""
Reset parameter value to parameter default
"""
self.value = self.default
@log
def is_default(self):
"""
Is this param's value equal to its default ?
:return: True if this param's value is equal to its default value, False otherwise
:rtype: bool
"""
if isinstance(self.value, float):
return math.isclose(self.value, self.default, abs_tol=0.01)
return self.value == self.default
# pylint: disable=R0903
class RangeParameter(ProcessingParameter):
"""
Represents a parameter of type range
"""
# pylint: disable=R0913
@log
def __init__(self, name: str, description: str, default: Any,
minimum: int, maximum: int):
super().__init__(name, description, default)
self.minimum = minimum
self.maximum = maximum
class ListParameter(ProcessingParameter):
"""
represents a list of choices of type text
"""
# pylint: disable=R0913
@log
def __init__(self, name: str, description: str, default: Any,
choices: list):
super().__init__(name, description, default)
self.choices = choices
# pylint: disable=R0903
class SwitchParameter(ProcessingParameter):
"""
Represents an ON / OFF switch
"""