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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
"""
.. module:: skrf.vi.validators
==============================
validators (:mod:`skrf.vi.validators`)
==============================
.. autosummary::
"""
from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import Sequence
from typing import Any
import re
from abc import ABC, abstractmethod
from enum import Enum
class ValidationError(Exception):
pass
class Validator(ABC):
@abstractmethod
def validate_input(self, arg) -> Any:
"""Try to convert arg to a valid value and return. Used to ensure
commands sent to the instrument are the proper format."""
pass
def validate_output(self, arg) -> Any:
"""Try to convert arg to a valid value and return. Used to convert
responses from the instrument to something useful. By default,
this just calls validate_input, but can be overwritten in subclasses.
(See EnumValidator)"""
return self.validate_input(arg)
class IntValidator(Validator):
def __init__(self, min: int | None = None, max: int | None = None) -> None:
self.min = min
self.max = max
def validate_input(self, arg) -> int:
try:
arg = int(arg)
except ValueError as err:
raise ValidationError(f"Could not convert {arg} to an int") from err
if self.min is not None or self.max is not None:
self.check_bounds(arg)
return arg
def check_bounds(self, arg):
try:
if self.min is not None:
assert arg >= self.min
except AssertionError as err:
raise ValidationError(f"{arg} < {self.min}") from err
try:
if self.max is not None:
assert arg <= self.max
except AssertionError as err:
raise ValidationError(f"{arg} > {self.max}") from err
class FloatValidator(Validator):
def __init__(
self,
min: float | None = None,
max: float | None = None,
decimal_places: int=50
) -> None:
self.min = min
self.max = max
self.dec_places = decimal_places
def validate_input(self, arg) -> float:
try:
arg = float(arg)
except ValueError as err:
raise ValidationError(f"Could not convert {arg} to a float") from err
if self.min is not None or self.max is not None:
self.check_bounds(arg)
return round(arg, self.dec_places)
def check_bounds(self, arg):
try:
if self.min is not None:
assert arg >= self.min
except AssertionError as err:
raise ValidationError(f"{arg} < {self.min}") from err
try:
if self.max is not None:
assert arg <= self.max
except AssertionError as err:
raise ValidationError(f"{arg} > {self.max}") from err
class FreqValidator(Validator):
freq_re = re.compile(r"(?P<val>\d+\.?\d*)\s*(?P<si_prefix>[kMG])?(?:[hH][zZ])?")
si = {"k": 1e3, "M": 1e6, "G": 1e9}
def validate_input(self, arg) -> int:
if isinstance(arg, str):
f = re.fullmatch(self.freq_re, arg)
if f is None:
raise ValidationError("Invalid frequency string")
return int(float(f["val"]) * self.si.get(f["si_prefix"], 1))
else:
try:
return int(arg)
except ValueError as err:
raise ValidationError("Could not convert {arg} to an int") from err
def validate_output(self, arg) -> int:
try:
f = float(arg)
return int(f)
except ValueError as err:
raise ValidationError(f"Response from instrument ({arg}) could not be converted to an int") from err
class EnumValidator(Validator):
def __init__(self, enum: Enum) -> None:
self.Enum = enum
def validate_input(self, arg) -> Any:
if isinstance(arg, Enum):
return arg.value
else:
try:
return self.Enum(arg).value
except ValueError as err:
raise ValidationError(f"{arg} is not a valid {self.Enum.__name__}") from err
def validate_output(self, arg) -> Any:
try:
return self.Enum(arg)
except ValueError as err:
raise ValidationError(f"Got unexpected response {arg}") from err
class SetValidator(Validator):
def __init__(self, valid: Sequence) -> None:
dtype = type(valid[0])
if not all(isinstance(x, dtype) for x in valid):
raise ValueError("All elements of set must be of the same type.")
self.valid = valid
self.dtype = dtype
def validate_input(self, arg) -> Any:
arg = self.dtype(arg)
if arg in self.valid:
return arg
else:
raise ValidationError(f"{arg} is not in {self.valid}")
class DictValidator(Validator):
def __init__(self, arg_string: str, response_pattern: re.Pattern | str) -> None:
self.arg_string = arg_string
if isinstance(response_pattern, str):
self.pattern = re.compile(response_pattern)
else:
self.pattern = response_pattern
def validate_input(self, arg) -> str:
try:
return self.arg_string.format(**arg)
except KeyError as e:
raise ValidationError(f"Missing expected argument '{e}'") from e
def validate_output(self, arg) -> dict:
match = self.pattern.fullmatch(arg)
if match:
return match.groupdict()
else:
raise ValidationError(
"Response did not fit regex. "
f"Response: {arg} Pattern: {self.pattern.pattern}"
)
class DelimitedStrValidator(Validator):
def __init__(self, dtype: type =str , sep: str = ',') -> None:
self.dtype = dtype
self.sep = sep
def validate_input(self, arg: Sequence) -> str:
if not all(isinstance(x, self.dtype) for x in arg):
raise ValidationError("All elements must be of type {self.dtype}.")
return self.sep.join(str(x) for x in arg)
def validate_output(self, arg: str) -> list:
arg = arg.replace('"', '')
return [self.dtype(val) for val in arg.split(self.sep)]
class BooleanValidator(Validator):
truthy = ['1', 'on', 'true']
falsey = ['0', 'off', 'false']
def __init__(
self,
true_response: str | None = None,
false_response: str | None = None,
true_setting: str='1',
false_setting: str='0'
):
if true_response:
self.truthy.append(true_response.lower())
if false_response:
self.falsey.append(false_response.lower())
self.true_val = true_setting
self.false_val = false_setting
def validate_input(self, arg) -> str:
if str(arg).lower() in self.truthy:
return self.true_val
elif str(arg).lower() in self.falsey:
return self.false_val
else:
raise ValidationError('Argument must be a truthy or falsey value')
def validate_output(self, arg) -> bool:
return str(arg).lower() in self.truthy
|