Minor refactoring

added __str__ to CaptureFile

Author: bertbarabas

CaptureFile/CaptureFile.py

@@ -109,6 +109,13 @@ def __post_init__(
             self._new_file(initial_metadata)
         self.open(to_write)
 
+    def __str__(self):
+        if self._file:
+            status = f'opened for {"writing" if self.to_write else "reading"}'
+        else:
+            status = "currently closed but last seen"
+        return f'"{self._file_name}" {status} with {self._record_count:,} records'
+
     def open(self, to_write: bool = False):
         """Opens this CaptureFile instance for reading or writing, depending on
         the value of `to_write`.
@@ -655,10 +662,11 @@ def record_at(self, record_number: int, /) -> Record:
         )
 
         # skip nodes as long as path follows rightmost nodes.
-        while (child_index := next(root_to_leaf_path)) == len(
-            (current_rightmost_node := next(root_to_leaf_rightmost_nodes)).children
+        for child_index, current_rightmost_node in zip(
+            root_to_leaf_path, root_to_leaf_rightmost_nodes
         ):
-            pass
+            if child_index != len(current_rightmost_node.children):
+                break
 
         # get first persistent child's data cooridnates. This child will refer
         # to either the record or the root of a perfect sub-tree of which no
@@ -1393,9 +1401,7 @@ def leaf_to_root_path(position: int, height: int, fan_out: int, /) -> List[int]:
     root."""
 
     path = [0] * height
-
     for i in range(height):
-        position, child_index = divmod(position, fan_out)
-        path[i] = child_index
+        position, path[i] = divmod(position, fan_out)
 
     return path

tests/test_captureFile.py

@@ -16,6 +16,16 @@ def test_new_file():
     assert cf.record_count() == 0
     cf.close()
 
+def test_str():
+    with CaptureFile(file_name_1, to_write=True, force_new_empty_file=True) as cf:
+        for i in range(1, 10001):
+            cf.add_record(f"Hey this is my record {i:,}")
+        LOGGER.info(str(cf))
+        cf.close()
+        LOGGER.info(str(cf))
+        cf.open()
+        LOGGER.info(str(cf))
+        
 
 def test_record_out_of_range():
     cf = CaptureFile(file_name_1, to_write=True, force_new_empty_file=True)