MOD: Remove or change metadata endpoints

Author: cjdsellers

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 0.10.0 - TBD
 - Renamed `Bento` class to `DBNStore`
+- Removed `metadata.list_compressions` (redundant with docs)
+- Removed `metadata.list_encodings` (redundant with docs)
+- Removed optional `start` and `end` params from `metadata.list_schemas` (redundant)
 
 ## 0.9.0 - 2023-03-10
 - Removed `record_count` property from Bento class

databento/historical/api/metadata.py

@@ -86,12 +86,7 @@ def list_datasets(
         )
         return response.json()
 
-    def list_schemas(
-        self,
-        dataset: Union[Dataset, str],
-        start_date: Optional[Union[date, str]] = None,
-        end_date: Optional[Union[date, str]] = None,
-    ) -> List[str]:
+    def list_schemas(self, dataset: Union[Dataset, str]) -> List[str]:
         """
         Request all available data schemas from Databento.
 
@@ -101,12 +96,6 @@ def list_schemas(
         ----------
         dataset : Dataset or str
             The dataset code (string identifier) for the request.
-        start_date : date or str, optional
-            The start date (UTC) for the request range.
-            If `None` then first date available.
-        end_date : date or str, optional
-            The end date (UTC) for the request range.
-            If `None` then last date available.
 
         Returns
         -------
@@ -115,8 +104,6 @@ def list_schemas(
         """
         params: List[Tuple[str, Optional[str]]] = [
             ("dataset", validate_semantic_string(dataset, "dataset")),
-            ("start_date", optional_date_to_string(start_date)),
-            ("end_date", optional_date_to_string(end_date)),
         ]
 
         response: Response = self._get(
@@ -168,40 +155,6 @@ def list_fields(
         )
         return response.json()
 
-    def list_encodings(self) -> List[str]:
-        """
-        Request all available data encodings from Databento.
-
-        Makes a `GET /metadata.list_encodings` HTTP request.
-
-        Returns
-        -------
-        List[str]
-
-        """
-        response: Response = self._get(
-            url=self._base_url + ".list_encodings",
-            basic_auth=True,
-        )
-        return response.json()
-
-    def list_compressions(self) -> List[str]:
-        """
-        Request all available data compression modes from Databento.
-
-        Makes a `GET /metadata.list_compressions` HTTP request.
-
-        Returns
-        -------
-        List[str]
-
-        """
-        response: Response = self._get(
-            url=self._base_url + ".list_compressions",
-            basic_auth=True,
-        )
-        return response.json()
-
     def list_unit_prices(
         self,
         dataset: Union[Dataset, str],

examples/historical_metadata.py

@@ -9,5 +9,3 @@
     print(client.metadata.list_datasets())
     print(client.metadata.list_schemas(dataset="GLBX.MDP3"))
     print(client.metadata.list_fields(dataset="GLBX.MDP3"))
-    print(client.metadata.list_encodings())
-    print(client.metadata.list_compressions())

notebooks/quickstart.ipynb

@@ -213,58 +213,6 @@
     "client.metadata.list_fields(dataset=\"GLBX.MDP3\", schema=\"trades\", encoding=\"csv\")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2ef363e9-7150-4ace-a2d8-dcc355d73f72",
-   "metadata": {
-    "pycharm": {
-     "name": "#%%\n"
-    },
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['dbn', 'csv', 'json']"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "client.metadata.list_encodings()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "25a67ca8-10f0-41cb-a932-95a5e8dcd5f1",
-   "metadata": {
-    "pycharm": {
-     "name": "#%%\n"
-    },
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['none', 'zstd']"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "client.metadata.list_compressions()"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "a335a762-bba0-4de5-bde3-8bce006691c9",
@@ -2088,7 +2036,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.15"
+   "version": "3.7.16"
   }
  },
  "nbformat": 4,

tests/test_historical_metadata.py

@@ -71,11 +71,7 @@ def test_list_schemas_sends_expected_request(self, mocker: MockerFixture) -> Non
         mocked_get = mocker.patch("requests.get")
 
         # Act
-        self.client.metadata.list_schemas(
-            dataset="GLBX.MDP3",
-            start_date="2018-01-01",
-            end_date="2021-01-01",
-        )
+        self.client.metadata.list_schemas(dataset="GLBX.MDP3")
 
         # Assert
         call = mocked_get.call_args.kwargs
@@ -84,8 +80,6 @@ def test_list_schemas_sends_expected_request(self, mocker: MockerFixture) -> Non
             == f"https://hist.databento.com/v{db.API_VERSION}/metadata.list_schemas"
         )
         assert ("dataset", "GLBX.MDP3") in call["params"]
-        assert ("start_date", "2018-01-01") in call["params"]
-        assert ("end_date", "2021-01-01") in call["params"]
         assert sorted(call["headers"].keys()) == ["accept", "user-agent"]
         assert call["headers"]["accept"] == "application/json"
         assert all(
@@ -123,53 +117,6 @@ def test_list_fields_sends_expected_request(self, mocker: MockerFixture) -> None
         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_encodings_sends_expected_request(self, mocker: MockerFixture) -> None:
-        # Arrange
-        mocked_get = mocker.patch("requests.get")
-
-        # Act
-        self.client.metadata.list_encodings()
-
-        # Assert
-        call = mocked_get.call_args.kwargs
-        assert (
-            call["url"]
-            == f"https://hist.databento.com/v{db.API_VERSION}/metadata.list_encodings"
-        )
-        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_compressions_sends_expected_request(
-        self,
-        mocker: MockerFixture,
-    ) -> None:
-        # Arrange
-        mocked_get = mocker.patch("requests.get")
-
-        # Act
-        self.client.metadata.list_compressions()
-
-        # Assert
-        call = mocked_get.call_args.kwargs
-        assert (
-            call["url"]
-            == f"https://hist.databento.com/v{db.API_VERSION}/metadata.list_compressions"  # noqa
-        )
-        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")
     @pytest.mark.parametrize(
         "dataset, schema, mode",