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
|
"""Units tools."""
from __future__ import annotations
from collections.abc import Callable
from enum import StrEnum
from functools import lru_cache
from asusrouter.error import AsusRouterError
class UnitOfData(StrEnum):
"""Units of data."""
# Base unit
BIT = "b"
BYTE = "B"
# Base 10
KILOBIT = "kb"
MEGABIT = "Mb"
GIGABIT = "Gb"
TERABIT = "Tb"
KILOBYTE = "KB"
MEGABYTE = "MB"
GIGABYTE = "GB"
TERABYTE = "TB"
# Base 2 (native Asus Type)
KIBIBIT = "Kib"
MEBIBIT = "Mib"
GIBIBIT = "Gib"
TEBIBIT = "Tib"
KIBIBYTE = "KiB"
MEBIBYTE = "MiB"
GIBIBYTE = "GiB"
TEBIBYTE = "TiB"
class UnitOfDataRate(StrEnum):
"""Units of data rate."""
# Base unit
BIT_PER_SECOND = "bps"
BYTE_PER_SECOND = "Bps"
# Base 10
KILOBIT_PER_SECOND = "kbps"
MEGABIT_PER_SECOND = "Mbps"
GIGABIT_PER_SECOND = "Gbps"
TERABIT_PER_SECOND = "Tbps"
KILOBYTE_PER_SECOND = "KBps"
MEGABYTE_PER_SECOND = "MBps"
GIGABYTE_PER_SECOND = "GBps"
TERABYTE_PER_SECOND = "TBps"
# Base 2 (native Asus Type)
KIBIBIT_PER_SECOND = "Kibps"
MEBIBIT_PER_SECOND = "Mibps"
GIBIBIT_PER_SECOND = "Gibps"
TEBIBIT_PER_SECOND = "Tibps"
KIBIBYTE_PER_SECOND = "KiBps"
MEBIBYTE_PER_SECOND = "MiBps"
GIBIBYTE_PER_SECOND = "GiBps"
TEBIBYTE_PER_SECOND = "TiBps"
class UnitConverterBase:
"""AsusRouter Unit Converter."""
UNIT_CLASS: str
UNIT_BASE: StrEnum
VALUE_UNITS: set[StrEnum]
_UNIT_RATIO: dict[StrEnum, float]
@classmethod
def _validate_unit(cls, unit: StrEnum) -> None:
"""Validate that a unit is supported."""
if not isinstance(unit, StrEnum) or unit not in cls.VALUE_UNITS:
raise AsusRouterError(
f"Unknown unit `{unit}` encountered during "
f"conversion of `{cls.UNIT_CLASS}`"
)
@classmethod
def convert(
cls, value: float, from_unit: StrEnum, to_unit: StrEnum
) -> float:
"""Convert a value from one unit to another."""
cls._validate_unit(from_unit)
cls._validate_unit(to_unit)
return cls.converter_factory(from_unit, to_unit)(value)
@classmethod
def convert_to_base(cls, value: float, from_unit: StrEnum) -> float:
"""Convert a value to the base unit."""
cls._validate_unit(from_unit)
if from_unit == cls.UNIT_BASE:
return value
return cls.converter_factory(from_unit, cls.UNIT_BASE)(value)
@classmethod
@lru_cache
def converter_factory(
cls, from_unit: StrEnum, to_unit: StrEnum
) -> Callable[[float], float]:
"""Create a conversion function from one unit to another."""
if from_unit == to_unit:
return lambda value: value
from_ratio, to_ratio = cls._get_ratios(from_unit, to_unit)
return lambda value: (value * from_ratio) / to_ratio
@classmethod
def _get_ratios(
cls, from_unit: StrEnum, to_unit: StrEnum
) -> tuple[float, float]:
"""Get the conversion ratios for two units."""
unit_ratios = cls._UNIT_RATIO
try:
return unit_ratios[from_unit], unit_ratios[to_unit]
except KeyError as ex:
raise AsusRouterError(
f"Unknown unit `{ex.args[0]}` encountered during "
f"conversion of `{cls.UNIT_CLASS}`"
)
@classmethod
@lru_cache
def get_unit_ratio(cls, from_unit: StrEnum, to_unit: StrEnum) -> float:
"""Get unit ratio between units of measurement."""
from_ratio, to_ratio = cls._get_ratios(from_unit, to_unit)
return from_ratio / to_ratio
class DataUnitConverter(UnitConverterBase):
"""Data Unit Converter."""
UNIT_CLASS = "data"
UNIT_BASE = UnitOfData.BIT
VALUE_UNITS = set(UnitOfData)
_UNIT_RATIO = {
UnitOfData.BIT: 1,
UnitOfData.BYTE: 8,
UnitOfData.KILOBIT: 1e3,
UnitOfData.MEGABIT: 1e6,
UnitOfData.GIGABIT: 1e9,
UnitOfData.TERABIT: 1e12,
UnitOfData.KIBIBIT: 2**10,
UnitOfData.MEBIBIT: 2**20,
UnitOfData.GIBIBIT: 2**30,
UnitOfData.TEBIBIT: 2**40,
UnitOfData.KILOBYTE: 8e3,
UnitOfData.MEGABYTE: 8e6,
UnitOfData.GIGABYTE: 8e9,
UnitOfData.TERABYTE: 8e12,
UnitOfData.KIBIBYTE: 2**13,
UnitOfData.MEBIBYTE: 2**23,
UnitOfData.GIBIBYTE: 2**33,
UnitOfData.TEBIBYTE: 2**43,
}
class DataRateUnitConverter(UnitConverterBase):
"""Data Rate Unit Converter."""
UNIT_CLASS = "data_rate"
UNIT_BASE = UnitOfDataRate.BIT_PER_SECOND
VALUE_UNITS = set(UnitOfDataRate)
_UNIT_RATIO = {
UnitOfDataRate.BIT_PER_SECOND: 1,
UnitOfDataRate.BYTE_PER_SECOND: 8,
UnitOfDataRate.KILOBIT_PER_SECOND: 1e3,
UnitOfDataRate.MEGABIT_PER_SECOND: 1e6,
UnitOfDataRate.GIGABIT_PER_SECOND: 1e9,
UnitOfDataRate.TERABIT_PER_SECOND: 1e12,
UnitOfDataRate.KIBIBIT_PER_SECOND: 2**10,
UnitOfDataRate.MEBIBIT_PER_SECOND: 2**20,
UnitOfDataRate.GIBIBIT_PER_SECOND: 2**30,
UnitOfDataRate.TEBIBIT_PER_SECOND: 2**40,
UnitOfDataRate.KILOBYTE_PER_SECOND: 8e3,
UnitOfDataRate.MEGABYTE_PER_SECOND: 8e6,
UnitOfDataRate.GIGABYTE_PER_SECOND: 8e9,
UnitOfDataRate.TERABYTE_PER_SECOND: 8e12,
UnitOfDataRate.KIBIBYTE_PER_SECOND: 2**13,
UnitOfDataRate.MEBIBYTE_PER_SECOND: 2**23,
UnitOfDataRate.GIBIBYTE_PER_SECOND: 2**33,
UnitOfDataRate.TEBIBYTE_PER_SECOND: 2**43,
}
|
