VER: Release 0.8.1

## 0.8.1 - 2023-03-05

- Fixed bug in `Bento` iteration where multiple readers were created
- Added `from_dbn` convenience alias for loading DBN files

Author: cjdsellers

CHANGELOG.md

@@ -1,7 +1,11 @@
 # Changelog
 
+## 0.8.1 - 2023-03-05
+- Fixed bug in `Bento` iteration where multiple readers were created
+- Added `from_dbn` convenience alias for loading DBN files
+
 ## 0.8.0 - 2023-03-03
-- Integrate DBN encoding `0.3.2`
+- Integrated DBN encoding `0.3.2`
 - Renamed `timeseries.stream` to `timeseries.get_range`
 - Renamed `timeseries.stream_async` to `timeseries.get_range_async`
 - Deprecated `timeseries.stream(...)` method

databento/__init__.py

@@ -54,3 +54,6 @@
 
 # Set to either 'DEBUG' or 'INFO', controls console logging
 log: Optional[str] = None
+
+# Convenience imports
+from_dbn = Bento.from_file

databento/common/bento.py

@@ -346,11 +346,10 @@ def __init__(self, data_source: DataSource) -> None:
         ] = {}
 
     def __iter__(self) -> Generator[np.void, None, None]:
+        reader = self.reader
         for _ in range(self.record_count):
-            raw = self.reader.read(self.record_size)
+            raw = reader.read(self.record_size)
             rec = np.frombuffer(raw, dtype=STRUCT_MAP[self.schema])
-            if rec.size == 0:
-                raise StopIteration
             yield rec[0]
 
     def _apply_pretty_ts(self, df: pd.DataFrame) -> pd.DataFrame:

databento/version.py

@@ -1 +1 @@
-__version__ = "0.8.0"
+__version__ = "0.8.1"

requirements_dev.txt

@@ -1,4 +1,4 @@
-mypy>=0.991
+mypy>=1.0.1
 pytest>=7.2.0
 pytest-mock>=3.10.0
 types-requests

tests/test_historical_bento.py

@@ -1,8 +1,10 @@
+import collections
 import datetime as dt
 import sys
 from pathlib import Path
 from typing import List, Tuple, Union
 
+import databento
 import numpy as np
 import pandas as pd
 import pytest
@@ -184,6 +186,18 @@ def test_to_ndarray_with_stub_data_returns_expected_array() -> None:
     )
 
 
+def test_iterator_produces_expected_data() -> None:
+    # Arrange
+    stub_data = get_test_data(schema=Schema.MBO)
+    data = Bento.from_bytes(data=stub_data)
+
+    # Act (consume iterator)
+    handler = collections.deque(data)
+
+    # Assert
+    assert len(handler) == 2
+
+
 def test_replay_with_stub_data_record_passes_to_callback() -> None:
     # Arrange
     stub_data = get_test_data(schema=Schema.MBO)
@@ -372,14 +386,28 @@ def test_to_df_with_pretty_px_with_various_schemas_converts_prices_as_expected(
 def test_from_file_given_various_paths_returns_expected_metadata(
     expected_schema: Schema,
 ) -> None:
-    # Arrange, Act
+    # Arrange
     path = get_test_data_path(schema=expected_schema)
+
+    # Act
     data = Bento.from_file(path=path)
 
     # Assert
     assert data.schema == expected_schema
 
 
+def test_from_dbn_alias() -> None:
+    # Arrange
+    path = get_test_data_path(schema=Schema.MBO)
+
+    # Act
+    data = databento.from_dbn(path=path)
+
+    # Assert
+    assert data.schema == Schema.MBO
+    assert data.record_count == 2
+
+
 def test_mbo_to_csv_writes_expected_file_to_disk(tmp_path: Path) -> None:
     # Arrange
     test_data_path = get_test_data_path(schema=Schema.MBO)
@@ -621,9 +649,9 @@ def test_bento_iterable() -> None:
         "22993, 1170352)"
     )
     assert (
-        str(record_list[1]) == "(14, 160, 1, 5482, 1609160400000429831, 647784973705, "
-        "3722750000000, 1, -128, 0, b'C', b'A', 1609160400000704060, "
-        "22993, 1170352)"
+        str(record_list[1]) == "(14, 160, 1, 5482, 1609160400000431665, 647784973631, "
+        "3723000000000, 1, -128, 0, b'C', b'A', 1609160400000711344, "
+        "19621, 1170353)"
     )
 
 
@@ -651,14 +679,14 @@ def test_bento_iterable_parallel() -> None:
         "22993, 1170352)"
     )
     assert (
-        str(next(second)) == "(14, 160, 1, 5482, 1609160400000429831, 647784973705, "
-        "3722750000000, 1, -128, 0, b'C', b'A', 1609160400000704060, "
-        "22993, 1170352)"
+        str(next(second)) == "(14, 160, 1, 5482, 1609160400000431665, 647784973631, "
+        "3723000000000, 1, -128, 0, b'C', b'A', 1609160400000711344, "
+        "19621, 1170353)"
     )
     assert (
-        str(next(first)) == "(14, 160, 1, 5482, 1609160400000429831, 647784973705, "
-        "3722750000000, 1, -128, 0, b'C', b'A', 1609160400000704060, "
-        "22993, 1170352)"
+        str(next(first)) == "(14, 160, 1, 5482, 1609160400000431665, 647784973631, "
+        "3723000000000, 1, -128, 0, b'C', b'A', 1609160400000711344, "
+        "19621, 1170353)"
     )