TR updates

Author: gahjelle

python-range/float_range.py

@@ -1,11 +1,13 @@
-import math
 from dataclasses import dataclass, field
+from math import ceil, isclose
 
 
 @dataclass
 class FloatRange:
+    """Range of numbers that allows floating point numbers."""
+
     start: float | int
-    stop: float | int = None
+    stop: float | int | None = None
     step: float | int = 1.0
 
     def __post_init__(self):
@@ -20,7 +22,7 @@ def __post_init__(self):
             raise ValueError("'start' must be a floating point number")
         if not isinstance(self.stop, float | int):
             raise ValueError("'stop' must be a floating point number")
-        if not isinstance(self.step, float | int) or self.step == 0:
+        if not isinstance(self.step, float | int) or isclose(self.step, 0):
             raise ValueError("'step' must be a non-zero floating point number")
 
     def __iter__(self):
@@ -35,21 +37,23 @@ def __contains__(self, element):
         offset = (element - self.start) % self.step
         if self.step > 0:
             return self.start <= element < self.stop and (
-                math.isclose(offset, 0) or math.isclose(offset, self.step)
+                isclose(offset, 0) or isclose(offset, self.step)
             )
         else:
             return self.stop < element <= self.start and (
-                math.isclose(offset, 0) or math.isclose(offset, self.step)
+                isclose(offset, 0) or isclose(offset, self.step)
             )
 
     def __len__(self):
         """Calculate the number of elements in the range."""
         if any(
-            self.step > 0 and self.stop <= self.start,
-            self.step < 0 and self.stop >= self.start,
+            [
+                self.step > 0 and self.stop <= self.start,
+                self.step < 0 and self.stop >= self.start,
+            ]
         ):
             return 0
-        return math.ceil((self.stop - self.start) / self.step)
+        return ceil((self.stop - self.start) / self.step)
 
     def __getitem__(self, index):
         """Get an element in the range based on its index."""
@@ -58,7 +62,11 @@ def __getitem__(self, index):
         return self.start + index * self.step
 
     def __reversed__(self):
-        """Create a FloatRange with elements in the reverse order."""
+        """Create a FloatRange with elements in the reverse order.
+
+        Any number 0 < x < self.step can be used as offset. Use 0.1 when
+        possible as an "esthetically nice" offset.
+        """
         cls = type(self)
         offset = (1 if self.step > 0 else -1) * min(0.1, abs(self.step) / 2)
         return cls(
@@ -80,17 +88,25 @@ def index(self, element):
 
 @dataclass
 class _FloatRangeIterator:
-    start: int
-    stop: int
-    step: int
+    """Non-public iterator. Should only be initialized by FloatRange."""
+
+    start: float | int
+    stop: float | int
+    step: float | int
     _num_steps: int = field(default=0, init=False)
 
+    def __iter__(self):
+        """Initialize the iterator."""
+        return self
+
     def __next__(self):
         """Calculate the next element in the iteration."""
         element = self.start + self._num_steps * self.step
         if any(
-            self.step > 0 and element >= self.stop,
-            self.step < 0 and element <= self.stop,
+            [
+                self.step > 0 and element >= self.stop,
+                self.step < 0 and element <= self.stop,
+            ]
         ):
             raise StopIteration
         self._num_steps += 1