MOD: Rename to SlowReaderBehavior

Author: nmacholl

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 #### Enhancements
 - Added `slow_reader_behavior` field to `AuthenticationRequest` message
-- Added `SlowReadBehavior` enum
+- Added `SlowReaderBehavior` enum
 - Upgraded `databento-dbn` to 0.49.0:
   - Added support for decompressing Zstd in the Python `DBNDecoder` and new optional `compression` parameter
 

databento/common/enums.py

@@ -260,7 +260,7 @@ class JobState(StringyMixin, str, Enum):
 
 
 @unique
-class SlowReadBehavior(StringyMixin, str, Enum):
+class SlowReaderBehavior(StringyMixin, str, Enum):
     """
     Live session parameter which controls gateway behavior when the client
     falls behind real time.

databento/live/client.py

@@ -21,7 +21,7 @@
 from databento.common.constants import ALL_SYMBOLS
 from databento.common.cram import BUCKET_ID_LENGTH
 from databento.common.enums import ReconnectPolicy
-from databento.common.enums import SlowReadBehavior
+from databento.common.enums import SlowReaderBehavior
 from databento.common.error import BentoError
 from databento.common.parsing import optional_datetime_to_unix_nanoseconds
 from databento.common.publishers import Dataset
@@ -87,7 +87,7 @@ def __init__(
         ts_out: bool = False,
         heartbeat_interval_s: int | None = None,
         reconnect_policy: ReconnectPolicy | str = ReconnectPolicy.NONE,
-        slow_reader_behavior: SlowReadBehavior | str | None = None,
+        slow_reader_behavior: SlowReaderBehavior | str | None = None,
     ) -> None:
         if key is None:
             key = os.environ.get("DATABENTO_API_KEY")

databento/live/gateway.py

@@ -11,7 +11,7 @@
 from databento_dbn import Schema
 from databento_dbn import SType
 
-from databento.common.enums import SlowReadBehavior
+from databento.common.enums import SlowReaderBehavior
 from databento.common.publishers import Dataset
 from databento.common.system import USER_AGENT
 
@@ -119,12 +119,12 @@ class AuthenticationRequest(GatewayControl):
     details: str | None = None
     ts_out: str = "0"
     heartbeat_interval_s: int | None = None
-    slow_reader_behavior: SlowReadBehavior | str | None = None
+    slow_reader_behavior: SlowReaderBehavior | str | None = None
     client: str = USER_AGENT
 
     def __post_init__(self) -> None:
         # Temporary work around for LSG support
-        if self.slow_reader_behavior in [SlowReadBehavior.SKIP, "skip"]:
+        if self.slow_reader_behavior in [SlowReaderBehavior.SKIP, "skip"]:
             self.slow_reader_behavior = "drop"
 
 

databento/live/protocol.py

@@ -16,7 +16,7 @@
 
 from databento.common import cram
 from databento.common.constants import ALL_SYMBOLS
-from databento.common.enums import SlowReadBehavior
+from databento.common.enums import SlowReaderBehavior
 from databento.common.error import BentoError
 from databento.common.iterator import chunk
 from databento.common.parsing import optional_datetime_to_unix_nanoseconds
@@ -74,7 +74,7 @@ def __init__(
         dataset: Dataset | str,
         ts_out: bool = False,
         heartbeat_interval_s: int | None = None,
-        slow_reader_behavior: SlowReadBehavior | str | None = None,
+        slow_reader_behavior: SlowReaderBehavior | str | None = None,
     ) -> None:
         self.__api_key = api_key
         self.__transport: asyncio.Transport | None = None
@@ -83,7 +83,7 @@ def __init__(
         self._dataset = validate_semantic_string(dataset, "dataset")
         self._ts_out = ts_out
         self._heartbeat_interval_s = heartbeat_interval_s
-        self._slow_reader_behavior: SlowReadBehavior | str | None = slow_reader_behavior
+        self._slow_reader_behavior: SlowReaderBehavior | str | None = slow_reader_behavior
 
         self._dbn_decoder = databento_dbn.DBNDecoder(
             upgrade_policy=VersionUpgradePolicy.UPGRADE_TO_V3,

databento/live/session.py

@@ -20,7 +20,7 @@
 
 from databento.common.constants import ALL_SYMBOLS
 from databento.common.enums import ReconnectPolicy
-from databento.common.enums import SlowReadBehavior
+from databento.common.enums import SlowReaderBehavior
 from databento.common.error import BentoError
 from databento.common.publishers import Dataset
 from databento.common.types import ClientRecordCallback
@@ -206,7 +206,7 @@ def __init__(
         metadata: SessionMetadata,
         ts_out: bool = False,
         heartbeat_interval_s: int | None = None,
-        slow_reader_behavior: SlowReadBehavior | str | None = None,
+        slow_reader_behavior: SlowReaderBehavior | str | None = None,
     ):
         super().__init__(api_key, dataset, ts_out, heartbeat_interval_s, slow_reader_behavior)
 
@@ -315,7 +315,7 @@ def __init__(
         user_gateway: str | None = None,
         user_port: int = DEFAULT_REMOTE_PORT,
         reconnect_policy: ReconnectPolicy | str = ReconnectPolicy.NONE,
-        slow_reader_behavior: SlowReadBehavior | str | None = None,
+        slow_reader_behavior: SlowReaderBehavior | str | None = None,
     ) -> None:
         self._dbn_queue = DBNQueue()
         self._lock = threading.RLock()

tests/test_live_client.py

@@ -24,7 +24,7 @@
 from databento.common.constants import SCHEMA_STRUCT_MAP
 from databento.common.cram import BUCKET_ID_LENGTH
 from databento.common.dbnstore import DBNStore
-from databento.common.enums import SlowReadBehavior
+from databento.common.enums import SlowReaderBehavior
 from databento.common.error import BentoError
 from databento.common.publishers import Dataset
 from databento.live import client
@@ -334,12 +334,12 @@ async def test_live_connect_auth_with_heartbeat_interval(
 
 @pytest.mark.parametrize(
     "slow_reader_behavior",
-    [b for b in SlowReadBehavior],
+    [b for b in SlowReaderBehavior],
 )
 async def test_live_connect_auth_with_slow_reader_behavior(
     mock_live_server: MockLiveServerInterface,
     test_live_api_key: str,
-    slow_reader_behavior: SlowReadBehavior,
+    slow_reader_behavior: SlowReaderBehavior,
 ) -> None:
     """
     Test that setting `slow_reader_behavior` on a Live client sends that field
@@ -370,7 +370,7 @@ async def test_live_connect_auth_with_slow_reader_behavior(
     assert message.encoding == Encoding.DBN
 
     # Temporary handling of renamed variant
-    if slow_reader_behavior == SlowReadBehavior.SKIP:
+    if slow_reader_behavior == SlowReaderBehavior.SKIP:
         assert message.slow_reader_behavior == "drop"
     else:
         assert message.slow_reader_behavior == slow_reader_behavior