-
Notifications
You must be signed in to change notification settings - Fork 17
/
_quantities.py
1341 lines (1035 loc) · 38 KB
/
_quantities.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
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# License: MIT
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
"""Types for holding quantities with units."""
# pylint: disable=too-many-lines
from __future__ import annotations
import math
from datetime import timedelta
from typing import Any, NoReturn, Self, TypeVar, overload
QuantityT = TypeVar(
"QuantityT",
"Quantity",
"Power",
"Current",
"Voltage",
"Energy",
"Frequency",
"Percentage",
"Temperature",
)
"""Type variable for representing various quantity types."""
class Quantity:
"""A quantity with a unit.
Quantities try to behave like float and are also immutable.
"""
_base_value: float
"""The value of this quantity in the base unit."""
_exponent_unit_map: dict[int, str] | None = None
"""A mapping from the exponent of the base unit to the unit symbol.
If None, this quantity has no unit. None is possible only when using the base
class. Sub-classes must define this.
"""
def __init__(self, value: float, exponent: int = 0) -> None:
"""Initialize a new quantity.
Args:
value: The value of this quantity in a given exponent of the base unit.
exponent: The exponent of the base unit the given value is in.
"""
self._base_value = value * 10.0**exponent
@classmethod
def _new(cls, value: float, *, exponent: int = 0) -> Self:
"""Instantiate a new quantity subclass instance.
Args:
value: The value of this quantity in a given exponent of the base unit.
exponent: The exponent of the base unit the given value is in.
Returns:
A new quantity subclass instance.
"""
self = cls.__new__(cls)
self._base_value = value * 10.0**exponent
return self
def __init_subclass__(cls, exponent_unit_map: dict[int, str]) -> None:
"""Initialize a new subclass of Quantity.
Args:
exponent_unit_map: A mapping from the exponent of the base unit to the unit
symbol.
Raises:
TypeError: If the given exponent_unit_map is not a dict.
ValueError: If the given exponent_unit_map does not contain a base unit
(exponent 0).
"""
if 0 not in exponent_unit_map:
raise ValueError("Expected a base unit for the type (for exponent 0)")
cls._exponent_unit_map = exponent_unit_map
super().__init_subclass__()
_zero_cache: dict[type, Quantity] = {}
"""Cache for zero singletons.
This is a workaround for mypy getting confused when using @functools.cache and
@classmethod combined with returning Self. It believes the resulting type of this
method is Self and complains that members of the actual class don't exist in Self,
so we need to implement the cache ourselves.
"""
@classmethod
def zero(cls) -> Self:
"""Return a quantity with value 0.0.
Returns:
A quantity with value 0.0.
"""
_zero = cls._zero_cache.get(cls, None)
if _zero is None:
_zero = cls.__new__(cls)
_zero._base_value = 0.0
cls._zero_cache[cls] = _zero
assert isinstance(_zero, cls)
return _zero
@classmethod
def from_string(cls, string: str) -> Self:
"""Return a quantity from a string representation.
Args:
string: The string representation of the quantity.
Returns:
A quantity object with the value given in the string.
Raises:
ValueError: If the string does not match the expected format.
"""
split_string = string.split(" ")
if len(split_string) != 2:
raise ValueError(
f"Expected a string of the form 'value unit', got {string}"
)
assert cls._exponent_unit_map is not None
exp_map = cls._exponent_unit_map
for exponent, unit in exp_map.items():
if unit == split_string[1]:
instance = cls.__new__(cls)
try:
instance._base_value = float(split_string[0]) * 10**exponent
except ValueError as error:
raise ValueError(f"Failed to parse string '{string}'.") from error
return instance
raise ValueError(f"Unknown unit {split_string[1]}")
@property
def base_value(self) -> float:
"""Return the value of this quantity in the base unit.
Returns:
The value of this quantity in the base unit.
"""
return self._base_value
@property
def base_unit(self) -> str | None:
"""Return the base unit of this quantity.
None if this quantity has no unit.
Returns:
The base unit of this quantity.
"""
if not self._exponent_unit_map:
return None
return self._exponent_unit_map[0]
def isnan(self) -> bool:
"""Return whether this quantity is NaN.
Returns:
Whether this quantity is NaN.
"""
return math.isnan(self._base_value)
def isinf(self) -> bool:
"""Return whether this quantity is infinite.
Returns:
Whether this quantity is infinite.
"""
return math.isinf(self._base_value)
def isclose(self, other: Self, rel_tol: float = 1e-9, abs_tol: float = 0.0) -> bool:
"""Return whether this quantity is close to another.
Args:
other: The quantity to compare to.
rel_tol: The relative tolerance.
abs_tol: The absolute tolerance.
Returns:
Whether this quantity is close to another.
"""
return math.isclose(
self._base_value,
other._base_value, # pylint: disable=protected-access
rel_tol=rel_tol,
abs_tol=abs_tol,
)
def __repr__(self) -> str:
"""Return a representation of this quantity.
Returns:
A representation of this quantity.
"""
return f"{type(self).__name__}(value={self._base_value}, exponent=0)"
def __str__(self) -> str:
"""Return a string representation of this quantity.
Returns:
A string representation of this quantity.
"""
return self.__format__("")
# pylint: disable=too-many-branches
def __format__(self, __format_spec: str) -> str:
"""Return a formatted string representation of this quantity.
If specified, must be of this form: `[0].{precision}`. If a 0 is not given, the
trailing zeros will be omitted. If no precision is given, the default is 3.
The returned string will use the unit that will result in the maximum precision,
based on the magnitude of the value.
Example:
```python
from frequenz.sdk.timeseries import Current
c = Current.from_amperes(0.2345)
assert f"{c:.2}" == "234.5 mA"
c = Current.from_amperes(1.2345)
assert f"{c:.2}" == "1.23 A"
c = Current.from_milliamperes(1.2345)
assert f"{c:.6}" == "1.2345 mA"
```
Args:
__format_spec: The format specifier.
Returns:
A string representation of this quantity.
Raises:
ValueError: If the given format specifier is invalid.
"""
keep_trailing_zeros = False
if __format_spec != "":
fspec_parts = __format_spec.split(".")
if (
len(fspec_parts) != 2
or fspec_parts[0] not in ("", "0")
or not fspec_parts[1].isdigit()
):
raise ValueError(
"Invalid format specifier. Must be empty or `[0].{precision}`"
)
if fspec_parts[0] == "0":
keep_trailing_zeros = True
precision = int(fspec_parts[1])
else:
precision = 3
if not self._exponent_unit_map:
return f"{self._base_value:.{precision}f}"
if math.isinf(self._base_value) or math.isnan(self._base_value):
return f"{self._base_value} {self._exponent_unit_map[0]}"
if abs_value := abs(self._base_value):
precision_pow = 10 ** (precision)
# Prevent numbers like 999.999999 being rendered as 1000 V
# instead of 1 kV.
# This could happen because the str formatting function does
# rounding as well.
# This is an imperfect solution that works for _most_ cases.
# isclose parameters were chosen according to the observed cases
if math.isclose(abs_value, precision_pow, abs_tol=1e-4, rel_tol=0.01):
# If the value is close to the precision, round it
exponent = math.ceil(math.log10(precision_pow))
else:
exponent = math.floor(math.log10(abs_value))
else:
exponent = 0
unit_place = exponent - exponent % 3
if unit_place < min(self._exponent_unit_map):
unit = self._exponent_unit_map[min(self._exponent_unit_map.keys())]
unit_place = min(self._exponent_unit_map)
elif unit_place > max(self._exponent_unit_map):
unit = self._exponent_unit_map[max(self._exponent_unit_map.keys())]
unit_place = max(self._exponent_unit_map)
else:
unit = self._exponent_unit_map[unit_place]
value_str = f"{self._base_value / 10 ** unit_place:.{precision}f}"
if value_str in ("-0", "0"):
stripped = value_str
else:
stripped = value_str.rstrip("0").rstrip(".")
if not keep_trailing_zeros:
value_str = stripped
unit_str = unit if stripped not in ("-0", "0") else self._exponent_unit_map[0]
return f"{value_str} {unit_str}"
def __add__(self, other: Self) -> Self:
"""Return the sum of this quantity and another.
Args:
other: The other quantity.
Returns:
The sum of this quantity and another.
"""
if not type(other) is type(self):
return NotImplemented
summe = type(self).__new__(type(self))
summe._base_value = self._base_value + other._base_value
return summe
def __sub__(self, other: Self) -> Self:
"""Return the difference of this quantity and another.
Args:
other: The other quantity.
Returns:
The difference of this quantity and another.
"""
if not type(other) is type(self):
return NotImplemented
difference = type(self).__new__(type(self))
difference._base_value = self._base_value - other._base_value
return difference
@overload
def __mul__(self, scalar: float, /) -> Self:
"""Scale this quantity by a scalar.
Args:
scalar: The scalar by which to scale this quantity.
Returns:
The scaled quantity.
"""
@overload
def __mul__(self, percent: Percentage, /) -> Self:
"""Scale this quantity by a percentage.
Args:
percent: The percentage by which to scale this quantity.
Returns:
The scaled quantity.
"""
def __mul__(self, value: float | Percentage, /) -> Self:
"""Scale this quantity by a scalar or percentage.
Args:
value: The scalar or percentage by which to scale this quantity.
Returns:
The scaled quantity.
"""
match value:
case float():
return type(self)._new(self._base_value * value)
case Percentage():
return type(self)._new(self._base_value * value.as_fraction())
case _:
return NotImplemented
@overload
def __truediv__(self, other: float, /) -> Self:
"""Divide this quantity by a scalar.
Args:
other: The scalar or percentage to divide this quantity by.
Returns:
The divided quantity.
"""
@overload
def __truediv__(self, other: Self, /) -> float:
"""Return the ratio of this quantity to another.
Args:
other: The other quantity.
Returns:
The ratio of this quantity to another.
"""
def __truediv__(self, value: float | Self, /) -> Self | float:
"""Divide this quantity by a scalar or another quantity.
Args:
value: The scalar or quantity to divide this quantity by.
Returns:
The divided quantity or the ratio of this quantity to another.
"""
match value:
case float():
return type(self)._new(self._base_value / value)
case Quantity() if type(value) is type(self):
return self._base_value / value._base_value
case _:
return NotImplemented
def __gt__(self, other: Self) -> bool:
"""Return whether this quantity is greater than another.
Args:
other: The other quantity.
Returns:
Whether this quantity is greater than another.
"""
if not type(other) is type(self):
return NotImplemented
return self._base_value > other._base_value
def __ge__(self, other: Self) -> bool:
"""Return whether this quantity is greater than or equal to another.
Args:
other: The other quantity.
Returns:
Whether this quantity is greater than or equal to another.
"""
if not type(other) is type(self):
return NotImplemented
return self._base_value >= other._base_value
def __lt__(self, other: Self) -> bool:
"""Return whether this quantity is less than another.
Args:
other: The other quantity.
Returns:
Whether this quantity is less than another.
"""
if not type(other) is type(self):
return NotImplemented
return self._base_value < other._base_value
def __le__(self, other: Self) -> bool:
"""Return whether this quantity is less than or equal to another.
Args:
other: The other quantity.
Returns:
Whether this quantity is less than or equal to another.
"""
if not type(other) is type(self):
return NotImplemented
return self._base_value <= other._base_value
def __eq__(self, other: object) -> bool:
"""Return whether this quantity is equal to another.
Args:
other: The other quantity.
Returns:
Whether this quantity is equal to another.
"""
if not type(other) is type(self):
return NotImplemented
# The above check ensures that both quantities are the exact same type, because
# `isinstance` returns true for subclasses and superclasses. But the above check
# doesn't help mypy identify the type of other, so the below line is necessary.
assert isinstance(other, self.__class__)
return self._base_value == other._base_value
def __neg__(self) -> Self:
"""Return the negation of this quantity.
Returns:
The negation of this quantity.
"""
negation = type(self).__new__(type(self))
negation._base_value = -self._base_value
return negation
def __abs__(self) -> Self:
"""Return the absolute value of this quantity.
Returns:
The absolute value of this quantity.
"""
absolute = type(self).__new__(type(self))
absolute._base_value = abs(self._base_value)
return absolute
class _NoDefaultConstructible(type):
"""A metaclass that disables the default constructor."""
def __call__(cls, *_args: Any, **_kwargs: Any) -> NoReturn:
"""Raise a TypeError when the default constructor is called.
Args:
*_args: ignored positional arguments.
**_kwargs: ignored keyword arguments.
Raises:
TypeError: Always.
"""
raise TypeError(
"Use of default constructor NOT allowed for "
f"{cls.__module__}.{cls.__qualname__}, "
f"use one of the `{cls.__name__}.from_*()` methods instead."
)
class Temperature(
Quantity,
metaclass=_NoDefaultConstructible,
exponent_unit_map={
0: "°C",
},
):
"""A temperature quantity (in degrees Celsius)."""
@classmethod
def from_celsius(cls, value: float) -> Self:
"""Initialize a new temperature quantity.
Args:
value: The temperature in degrees Celsius.
Returns:
A new temperature quantity.
"""
return cls._new(value)
def as_celsius(self) -> float:
"""Return the temperature in degrees Celsius.
Returns:
The temperature in degrees Celsius.
"""
return self._base_value
class Power(
Quantity,
metaclass=_NoDefaultConstructible,
exponent_unit_map={
-3: "mW",
0: "W",
3: "kW",
6: "MW",
},
):
"""A power quantity.
Objects of this type are wrappers around `float` values and are immutable.
The constructors accept a single `float` value, the `as_*()` methods return a
`float` value, and each of the arithmetic operators supported by this type are
actually implemented using floating-point arithmetic.
So all considerations about floating-point arithmetic apply to this type as well.
"""
@classmethod
def from_watts(cls, watts: float) -> Self:
"""Initialize a new power quantity.
Args:
watts: The power in watts.
Returns:
A new power quantity.
"""
return cls._new(watts)
@classmethod
def from_milliwatts(cls, milliwatts: float) -> Self:
"""Initialize a new power quantity.
Args:
milliwatts: The power in milliwatts.
Returns:
A new power quantity.
"""
return cls._new(milliwatts, exponent=-3)
@classmethod
def from_kilowatts(cls, kilowatts: float) -> Self:
"""Initialize a new power quantity.
Args:
kilowatts: The power in kilowatts.
Returns:
A new power quantity.
"""
return cls._new(kilowatts, exponent=3)
@classmethod
def from_megawatts(cls, megawatts: float) -> Self:
"""Initialize a new power quantity.
Args:
megawatts: The power in megawatts.
Returns:
A new power quantity.
"""
return cls._new(megawatts, exponent=6)
def as_watts(self) -> float:
"""Return the power in watts.
Returns:
The power in watts.
"""
return self._base_value
def as_kilowatts(self) -> float:
"""Return the power in kilowatts.
Returns:
The power in kilowatts.
"""
return self._base_value / 1e3
def as_megawatts(self) -> float:
"""Return the power in megawatts.
Returns:
The power in megawatts.
"""
return self._base_value / 1e6
# We need the ignore here because otherwise mypy will give this error:
# > Overloaded operator methods can't have wider argument types in overrides
# The problem seems to be when the other type implements an **incompatible**
# __rmul__ method, which is not the case here, so we should be safe.
# Please see this example:
# https://github.com/python/mypy/blob/c26f1297d4f19d2d1124a30efc97caebb8c28616/test-data/unit/check-overloading.test#L4738C1-L4769C55
# And a discussion in a mypy issue here:
# https://github.com/python/mypy/issues/4985#issuecomment-389692396
@overload # type: ignore[override]
def __mul__(self, scalar: float, /) -> Self:
"""Scale this power by a scalar.
Args:
scalar: The scalar by which to scale this power.
Returns:
The scaled power.
"""
@overload
def __mul__(self, percent: Percentage, /) -> Self:
"""Scale this power by a percentage.
Args:
percent: The percentage by which to scale this power.
Returns:
The scaled power.
"""
@overload
def __mul__(self, other: timedelta, /) -> Energy:
"""Return an energy from multiplying this power by the given duration.
Args:
other: The duration to multiply by.
Returns:
The calculated energy.
"""
def __mul__(self, other: float | Percentage | timedelta, /) -> Self | Energy:
"""Return a power or energy from multiplying this power by the given value.
Args:
other: The scalar, percentage or duration to multiply by.
Returns:
A power or energy.
"""
match other:
case float() | Percentage():
return super().__mul__(other)
case timedelta():
return Energy._new(self._base_value * other.total_seconds() / 3600.0)
case _:
return NotImplemented
# See the comment for Power.__mul__ for why we need the ignore here.
@overload # type: ignore[override]
def __truediv__(self, other: float, /) -> Self:
"""Divide this power by a scalar.
Args:
other: The scalar to divide this power by.
Returns:
The divided power.
"""
@overload
def __truediv__(self, other: Self, /) -> float:
"""Return the ratio of this power to another.
Args:
other: The other power.
Returns:
The ratio of this power to another.
"""
@overload
def __truediv__(self, current: Current, /) -> Voltage:
"""Return a voltage from dividing this power by the given current.
Args:
current: The current to divide by.
Returns:
A voltage from dividing this power by the a current.
"""
@overload
def __truediv__(self, voltage: Voltage, /) -> Current:
"""Return a current from dividing this power by the given voltage.
Args:
voltage: The voltage to divide by.
Returns:
A current from dividing this power by a voltage.
"""
def __truediv__(
self, other: float | Self | Current | Voltage, /
) -> Self | float | Voltage | Current:
"""Return a current or voltage from dividing this power by the given value.
Args:
other: The scalar, power, current or voltage to divide by.
Returns:
A current or voltage from dividing this power by the given value.
"""
match other:
case float():
return super().__truediv__(other)
case Power():
return self._base_value / other._base_value
case Current():
return Voltage._new(self._base_value / other._base_value)
case Voltage():
return Current._new(self._base_value / other._base_value)
case _:
return NotImplemented
class Current(
Quantity,
metaclass=_NoDefaultConstructible,
exponent_unit_map={
-3: "mA",
0: "A",
},
):
"""A current quantity.
Objects of this type are wrappers around `float` values and are immutable.
The constructors accept a single `float` value, the `as_*()` methods return a
`float` value, and each of the arithmetic operators supported by this type are
actually implemented using floating-point arithmetic.
So all considerations about floating-point arithmetic apply to this type as well.
"""
@classmethod
def from_amperes(cls, amperes: float) -> Self:
"""Initialize a new current quantity.
Args:
amperes: The current in amperes.
Returns:
A new current quantity.
"""
return cls._new(amperes)
@classmethod
def from_milliamperes(cls, milliamperes: float) -> Self:
"""Initialize a new current quantity.
Args:
milliamperes: The current in milliamperes.
Returns:
A new current quantity.
"""
return cls._new(milliamperes, exponent=-3)
def as_amperes(self) -> float:
"""Return the current in amperes.
Returns:
The current in amperes.
"""
return self._base_value
def as_milliamperes(self) -> float:
"""Return the current in milliamperes.
Returns:
The current in milliamperes.
"""
return self._base_value * 1e3
# See comment for Power.__mul__ for why we need the ignore here.
@overload # type: ignore[override]
def __mul__(self, scalar: float, /) -> Self:
"""Scale this current by a scalar.
Args:
scalar: The scalar by which to scale this current.
Returns:
The scaled current.
"""
@overload
def __mul__(self, percent: Percentage, /) -> Self:
"""Scale this current by a percentage.
Args:
percent: The percentage by which to scale this current.
Returns:
The scaled current.
"""
@overload
def __mul__(self, other: Voltage, /) -> Power:
"""Multiply the current by a voltage to get a power.
Args:
other: The voltage.
Returns:
The calculated power.
"""
def __mul__(self, other: float | Percentage | Voltage, /) -> Self | Power:
"""Return a current or power from multiplying this current by the given value.
Args:
other: The scalar, percentage or voltage to multiply by.
Returns:
A current or power.
"""
match other:
case float() | Percentage():
return super().__mul__(other)
case Voltage():
return Power._new(self._base_value * other._base_value)
case _:
return NotImplemented
class Voltage(
Quantity,
metaclass=_NoDefaultConstructible,
exponent_unit_map={0: "V", -3: "mV", 3: "kV"},
):
"""A voltage quantity.
Objects of this type are wrappers around `float` values and are immutable.
The constructors accept a single `float` value, the `as_*()` methods return a
`float` value, and each of the arithmetic operators supported by this type are
actually implemented using floating-point arithmetic.
So all considerations about floating-point arithmetic apply to this type as well.
"""
@classmethod
def from_volts(cls, volts: float) -> Self:
"""Initialize a new voltage quantity.
Args:
volts: The voltage in volts.
Returns:
A new voltage quantity.
"""
return cls._new(volts)
@classmethod
def from_millivolts(cls, millivolts: float) -> Self:
"""Initialize a new voltage quantity.
Args:
millivolts: The voltage in millivolts.
Returns:
A new voltage quantity.
"""
return cls._new(millivolts, exponent=-3)
@classmethod
def from_kilovolts(cls, kilovolts: float) -> Self:
"""Initialize a new voltage quantity.
Args:
kilovolts: The voltage in kilovolts.
Returns:
A new voltage quantity.
"""
return cls._new(kilovolts, exponent=3)
def as_volts(self) -> float:
"""Return the voltage in volts.
Returns:
The voltage in volts.
"""
return self._base_value
def as_millivolts(self) -> float:
"""Return the voltage in millivolts.
Returns:
The voltage in millivolts.
"""
return self._base_value * 1e3
def as_kilovolts(self) -> float:
"""Return the voltage in kilovolts.
Returns:
The voltage in kilovolts.
"""
return self._base_value / 1e3
# See comment for Power.__mul__ for why we need the ignore here.
@overload # type: ignore[override]
def __mul__(self, scalar: float, /) -> Self:
"""Scale this voltage by a scalar.
Args:
scalar: The scalar by which to scale this voltage.
Returns:
The scaled voltage.
"""
@overload
def __mul__(self, percent: Percentage, /) -> Self:
"""Scale this voltage by a percentage.
Args:
percent: The percentage by which to scale this voltage.
Returns:
The scaled voltage.
"""
@overload
def __mul__(self, other: Current, /) -> Power:
"""Multiply the voltage by the current to get the power.
Args:
other: The current to multiply the voltage with.
Returns:
The calculated power.
"""
def __mul__(self, other: float | Percentage | Current, /) -> Self | Power:
"""Return a voltage or power from multiplying this voltage by the given value.
Args:
other: The scalar, percentage or current to multiply by.