MOD: Rename get_dataset_condition endpoint

Author: cjdsellers

databento/historical/api/metadata.py

@@ -81,46 +81,6 @@ def list_datasets(
         )
         return response.json()
 
-    def list_dataset_conditions(
-        self,
-        dataset: Union[Dataset, str],
-        start_date: Union[date, str],
-        end_date: Union[date, str],
-    ) -> Dict[str, Any]:
-        """
-        Request the dataset conditions per date from Databento.
-
-        Makes a `GET /metadata.list_dataset_conditions` HTTP request.
-
-        Use this method to discover data availability and qualility.
-
-        Parameters
-        ----------
-        dataset : Dataset or str
-            The dataset code (string identifier) for the request.
-        start_date : date or str
-            The start date (UTC) for the request range.
-        end_date : date or str
-            The end date (UTC) for the request range.
-
-        Returns
-        -------
-        Dict[str, Any]
-
-        """
-        params: List[Tuple[str, Optional[str]]] = [
-            ("dataset", enum_or_str_uppercase(dataset, "dataset")),
-            ("start_date", str(pd.to_datetime(start_date).date())),
-            ("end_date", str(pd.to_datetime(end_date).date())),
-        ]
-
-        response: Response = self._get(
-            url=self._base_url + ".list_dataset_conditions",
-            params=params,
-            basic_auth=True,
-        )
-        return response.json()
-
     def list_schemas(
         self,
         dataset: Optional[Union[Dataset, str]] = None,
@@ -281,6 +241,46 @@ def list_unit_prices(
         )
         return response.json()
 
+    def get_dataset_condition(
+        self,
+        dataset: Union[Dataset, str],
+        start_date: Union[date, str],
+        end_date: Union[date, str],
+    ) -> Dict[str, Any]:
+        """
+        Get the dataset condition from Databento.
+
+        Makes a `GET /metadata.get_dataset_condition` HTTP request.
+
+        Use this method to discover data availability and qualility.
+
+        Parameters
+        ----------
+        dataset : Dataset or str
+            The dataset code (string identifier) for the request.
+        start_date : date or str
+            The start date (UTC) for the request range.
+        end_date : date or str
+            The end date (UTC) for the request range.
+
+        Returns
+        -------
+        Dict[str, Any]
+
+        """
+        params: List[Tuple[str, Optional[str]]] = [
+            ("dataset", enum_or_str_uppercase(dataset, "dataset")),
+            ("start_date", str(pd.to_datetime(start_date).date())),
+            ("end_date", str(pd.to_datetime(end_date).date())),
+        ]
+
+        response: Response = self._get(
+            url=self._base_url + ".get_dataset_condition",
+            params=params,
+            basic_auth=True,
+        )
+        return response.json()
+
     def get_record_count(
         self,
         dataset: Union[Dataset, str],

tests/test_historical_metadata.py

@@ -64,37 +64,6 @@ def test_list_datasets_sends_expected_request(self, mocker: MockerFixture) -> No
         assert call["timeout"] == (100, 100)
         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(
-        self, mocker: MockerFixture
-    ) -> None:
-        # Arrange
-        mocked_get = mocker.patch("requests.get")
-
-        # Act
-        self.client.metadata.list_dataset_conditions(
-            dataset="GLBX.MDP3",
-            start_date="2018-01-01",
-            end_date="2020-01-01",
-        )
-
-        # Assert
-        call = mocked_get.call_args.kwargs
-        assert (
-            call["url"]
-            == f"https://hist.databento.com/v{db.API_VERSION}/metadata.list_dataset_conditions"  # noqa
-        )
-        assert ("dataset", "GLBX.MDP3") in call["params"]
-        assert ("start_date", "2018-01-01") in call["params"]
-        assert ("end_date", "2020-01-01") in call["params"]
-        assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
-        assert call["headers"]["accept"] == "application/json"
-        assert all(
-            v in call["headers"]["user-agent"] for v in ("Databento/", "Python/")
-        )
-        assert call["timeout"] == (100, 100)
-        assert isinstance(call["auth"], requests.auth.HTTPBasicAuth)
-
     @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
     def test_list_schemas_sends_expected_request(self, mocker: MockerFixture) -> None:
         # Arrange
@@ -243,6 +212,37 @@ def test_list_unit_price_sends_expected_request(
         assert call["timeout"] == (100, 100)
         assert isinstance(call["auth"], requests.auth.HTTPBasicAuth)
 
+    @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
+    def test_get_dataset_condition_sends_expected_request(
+        self, mocker: MockerFixture
+    ) -> None:
+        # Arrange
+        mocked_get = mocker.patch("requests.get")
+
+        # Act
+        self.client.metadata.get_dataset_condition(
+            dataset="GLBX.MDP3",
+            start_date="2018-01-01",
+            end_date="2020-01-01",
+        )
+
+        # Assert
+        call = mocked_get.call_args.kwargs
+        assert (
+            call["url"]
+            == 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"]
+        assert ("end_date", "2020-01-01") in call["params"]
+        assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
+        assert call["headers"]["accept"] == "application/json"
+        assert all(
+            v in call["headers"]["user-agent"] for v in ("Databento/", "Python/")
+        )
+        assert call["timeout"] == (100, 100)
+        assert isinstance(call["auth"], requests.auth.HTTPBasicAuth)
+
     @pytest.mark.skipif(sys.version_info < (3, 8), reason="incompatible mocking")
     def test_get_record_count_sends_expected_request(
         self, mocker: MockerFixture