DEL: Deprecate mode param in get_cost

Author: robertmaierle

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 0.65.0 - TBD
 
+#### Deprecations
+- Deprecated `mode` parameter in `metadata.get_cost`, which will be removed in a future release
+
 #### Enhancements
 - Added export of `CBBOMsg` and `BBOMsg` from `databento_dbn` to the root `databento` package
 

databento/common/parsing.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import warnings
 from collections.abc import Iterable
 from datetime import date
 from datetime import datetime
@@ -277,13 +276,13 @@ def datetime_to_string(value: pd.Timestamp | datetime | date | str | int) -> str
         return pd.to_datetime(value).isoformat()
 
 
-def date_to_string(value: pd.Timestamp | date | str | int) -> str:
+def date_to_string(value: date | str) -> str:
     """
     Return a valid date string from the given value.
 
     Parameters
     ----------
-    value : pd.Timestamp, date, str, or int
+    value : date or str
         The value to parse.
 
     Returns
@@ -293,32 +292,10 @@ def date_to_string(value: pd.Timestamp | date | str | int) -> str:
     """
     if isinstance(value, str):
         return value
-    elif isinstance(value, date):
+    elif type(value) is date:
         return value.isoformat()
-    elif isinstance(value, int):
-        warnings.warn(
-            "Passing an int to `start_date` or `end_date` is deprecated and will be removed in v0.59.0."
-            "Use a date or str instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return str(value)
-    elif isinstance(value, pd.Timestamp):
-        warnings.warn(
-            "Passing a pandas Timestamp to `start_date` or `end_date` is deprecated and will be removed in v0.59.0."
-            "Use a date or str instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return pd.to_datetime(value).date().isoformat()
     else:
-        warnings.warn(
-            f"Passing a {type(value)} to `start_date` or `end_date` is deprecated and will be removed in v0.59.0."
-            "Use a date or str instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return pd.to_datetime(value).date().isoformat()
+        raise TypeError(f"`{type(value)} is not supported. Only `date` and `str` are supported.")
 
 
 def optional_datetime_to_string(

databento/historical/api/metadata.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import warnings
 from collections.abc import Iterable
 from datetime import date
 from datetime import datetime
@@ -19,6 +20,7 @@
 from databento.common.parsing import optional_datetime_to_string
 from databento.common.parsing import optional_symbols_list_to_list
 from databento.common.publishers import Dataset
+from databento.common.types import Default
 from databento.common.validation import validate_enum
 from databento.common.validation import validate_semantic_string
 
@@ -399,7 +401,7 @@ def get_cost(
         dataset: Dataset | str,
         start: pd.Timestamp | datetime | date | str | int,
         end: pd.Timestamp | datetime | date | str | int | None = None,
-        mode: FeedMode | str = "historical-streaming",
+        mode: FeedMode | str | Default[None] = Default[None](None),
         symbols: Iterable[str | int] | str | int | None = None,
         schema: Schema | str = "trades",
         stype_in: SType | str = "raw_symbol",
@@ -425,8 +427,8 @@ def get_cost(
             Assumes UTC as timezone unless otherwise specified.
             If an integer is passed, then this represents nanoseconds since the UNIX epoch.
             Defaults to the forward filled value of `start` based on the resolution provided.
-        mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, default 'historical-streaming'
-            The data feed mode for the request.
+        mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, default `None`
+            The data feed mode for the request. This parameter has been deprecated.
         symbols : Iterable[str | int] or str or int, optional
             The instrument symbols to filter for. Takes up to 2,000 symbols per request.
             If 'ALL_SYMBOLS' or `None` then will select **all** symbols.
@@ -443,6 +445,13 @@ def get_cost(
             The cost in US dollars.
 
         """
+        if not isinstance(mode, Default):
+            warnings.warn(
+                "The `mode` parameter is deprecated and will be removed in a future release.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
         stype_in_valid = validate_enum(stype_in, SType, "stype_in")
         symbols_list = optional_symbols_list_to_list(symbols, stype_in_valid)
         data: dict[str, str | None] = {
@@ -453,7 +462,6 @@ def get_cost(
             "schema": str(validate_enum(schema, Schema, "schema")),
             "stype_in": str(stype_in_valid),
             "stype_out": str(SType.INSTRUMENT_ID),
-            "mode": validate_enum(mode, FeedMode, "mode"),
         }
 
         if limit is not None:

tests/test_historical_bento.py

@@ -561,7 +561,7 @@ def test_to_df_with_pretty_ts_converts_timestamps_as_expected(
 
     # Assert
     index0 = df.index[0]
-    event0 = df["ts_event"][0]
+    event0 = df["ts_event"].iloc[0]
     assert isinstance(index0, pd.Timestamp)
     assert isinstance(event0, pd.Timestamp)
     assert index0 == pd.Timestamp("2020-12-28 00:00:00.000000000+0000", tz="UTC")

tests/test_historical_metadata.py

@@ -292,7 +292,6 @@ def test_get_cost_sends_expected_request(
         "schema": "mbo",
         "stype_in": "raw_symbol",
         "stype_out": "instrument_id",
-        "mode": "historical-streaming",
         "limit": "1000000",
     }
     assert call["timeout"] == (100, 100)