MOD: Revert to metadata.get_dataset_condition

Author: cjdsellers

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
 ## 0.9.0 - TBD
-- Renamed `metadata.get_dataset_condition` to `metadata.list_dataset_conditions`
+- Changed `metadata.get_dataset_condition` response to a list of condition per date
 
 ## 0.8.1 - 2023-03-05
 - Fixed bug in `Bento` iteration where multiple readers were created

databento/historical/api/metadata.py

@@ -242,7 +242,7 @@ def list_unit_prices(
         )
         return response.json()
 
-    def list_dataset_conditions(
+    def get_dataset_condition(
         self,
         dataset: Union[Dataset, str],
         start_date: Optional[Union[date, str]] = None,
@@ -251,7 +251,7 @@ def list_dataset_conditions(
         """
         Get the per date dataset conditions from Databento.
 
-        Makes a `GET /metadata.list_dataset_conditions` HTTP request.
+        Makes a `GET /metadata.get_dataset_condition` HTTP request.
 
         Use this method to discover data availability and quality.
 
@@ -278,7 +278,7 @@ def list_dataset_conditions(
         ]
 
         response: Response = self._get(
-            url=self._base_url + ".list_dataset_conditions",
+            url=self._base_url + ".get_dataset_condition",
             params=params,
             basic_auth=True,
         )

…ical_metadata_list_dataset_conditions.py …orical_metadata_get_dataset_condition.pyexamples/historical_metadata_list_dataset_conditions.py renamed to examples/historical_metadata_get_dataset_condition.py examples/historical_metadata_list_dataset_conditions.py renamed to examples/historical_metadata_get_dataset_condition.py

@@ -7,6 +7,6 @@
     key = "YOUR_API_KEY"
     client = Historical(key=key)
 
-    conditions = client.metadata.list_dataset_conditions(dataset="XNAS.ITCH")
+    condition = client.metadata.get_dataset_condition(dataset="XNAS.ITCH")
 
-    pprint(conditions)
+    pprint(condition)

tests/test_historical_metadata.py

@@ -215,15 +215,15 @@ def test_list_unit_price_sends_expected_request(
         assert isinstance(call["auth"], requests.auth.HTTPBasicAuth)
 
     @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
-    def test_list_dataset_conditions_sends_expected_request(
+    def test_get_dataset_condition_sends_expected_request(
         self,
         mocker: MockerFixture,
     ) -> None:
         # Arrange
         mocked_get = mocker.patch("requests.get")
 
         # Act
-        self.client.metadata.list_dataset_conditions(
+        self.client.metadata.get_dataset_condition(
             dataset="GLBX.MDP3",
             start_date="2018-01-01",
             end_date="2020-01-01",
@@ -233,7 +233,7 @@ def test_list_dataset_conditions_sends_expected_request(
         call = mocked_get.call_args.kwargs
         assert (
             call["url"]
-            == f"https://hist.databento.com/v{db.API_VERSION}/metadata.list_dataset_conditions"  # noqa
+            == f"https://hist.databento.com/v{db.API_VERSION}/metadata.get_dataset_condition"  # noqa
         )
         assert ("dataset", "GLBX.MDP3") in call["params"]
         assert ("start_date", "2018-01-01") in call["params"]