rename: use_cache -> enable_cache; reset_cache -> refresh_cache

Author: geetu040

openml/_api/clients/http.py

@@ -550,8 +550,8 @@ def request(  # noqa: PLR0913, C901
         method: str,
         path: str,
         *,
-        use_cache: bool = False,
-        reset_cache: bool = False,
+        enable_cache: bool = False,
+        refresh_cache: bool = False,
         use_api_key: bool = False,
         md5_checksum: str | None = None,
         **request_kwargs: Any,
@@ -565,10 +565,11 @@ def request(  # noqa: PLR0913, C901
             HTTP method to use.
         path : str
             API path relative to the base URL.
-        use_cache : bool, optional
-            Whether to load/store responses from cache.
-        reset_cache : bool, optional
-            If True, bypass existing cache entries.
+        enable_cache : bool, optional
+            Whether to load/store response from cache.
+        refresh_cache : bool, optional
+            Only used when `enable_cache=True`. If True, ignore any existing
+            cached response and overwrite it with a fresh one.
         use_api_key : bool, optional
             Whether to include the API key in query parameters.
         md5_checksum : str or None, optional
@@ -607,7 +608,7 @@ def request(  # noqa: PLR0913, C901
 
         files = request_kwargs.pop("files", None)
 
-        if use_cache and not reset_cache:
+        if enable_cache and not refresh_cache:
             cache_key = self.cache.get_key(url, params)
             try:
                 return self.cache.load(cache_key)
@@ -646,7 +647,7 @@ def request(  # noqa: PLR0913, C901
         if md5_checksum is not None:
             self._verify_checksum(response, md5_checksum)
 
-        if use_cache:
+        if enable_cache:
             cache_key = self.cache.get_key(url, params)
             self.cache.save(cache_key, response)
 
@@ -680,8 +681,8 @@ def get(
         self,
         path: str,
         *,
-        use_cache: bool = False,
-        reset_cache: bool = False,
+        enable_cache: bool = False,
+        refresh_cache: bool = False,
         use_api_key: bool = False,
         md5_checksum: str | None = None,
         **request_kwargs: Any,
@@ -693,9 +694,9 @@ def get(
         ----------
         path : str
             API path relative to the base URL.
-        use_cache : bool, optional
+        enable_cache : bool, optional
             Whether to use the response cache.
-        reset_cache : bool, optional
+        refresh_cache : bool, optional
             Whether to ignore existing cached entries.
         use_api_key : bool, optional
             Whether to include the API key.
@@ -712,8 +713,8 @@ def get(
         return self.request(
             method="GET",
             path=path,
-            use_cache=use_cache,
-            reset_cache=reset_cache,
+            enable_cache=enable_cache,
+            refresh_cache=refresh_cache,
             use_api_key=use_api_key,
             md5_checksum=md5_checksum,
             **request_kwargs,
@@ -746,7 +747,7 @@ def post(
         return self.request(
             method="POST",
             path=path,
-            use_cache=False,
+            enable_cache=False,
             use_api_key=use_api_key,
             **request_kwargs,
         )
@@ -774,7 +775,7 @@ def delete(
         return self.request(
             method="DELETE",
             path=path,
-            use_cache=False,
+            enable_cache=False,
             use_api_key=True,
             **request_kwargs,
         )

tests/test_api/test_http.py

@@ -77,7 +77,7 @@ def test_get(self):
 
     @pytest.mark.uses_test_server()
     def test_get_with_cache_creates_cache(self):
-        response = self.http_client.get("task/1", use_cache=True)
+        response = self.http_client.get("task/1", enable_cache=True)
 
         self.assertEqual(response.status_code, 200)
         self.assertTrue(self.cache.path.exists())
@@ -96,26 +96,26 @@ def test_get_with_cache_creates_cache(self):
     @pytest.mark.uses_test_server()
     def test_get_uses_cached_response(self):
         # first request populates cache
-        response1 = self.http_client.get("task/1", use_cache=True)
+        response1 = self.http_client.get("task/1", enable_cache=True)
 
         # second request should load from cache
-        response2 = self.http_client.get("task/1", use_cache=True)
+        response2 = self.http_client.get("task/1", enable_cache=True)
 
         self.assertEqual(response1.content, response2.content)
         self.assertEqual(response1.status_code, response2.status_code)
 
     @pytest.mark.uses_test_server()
-    def test_get_reset_cache(self):
+    def test_get_refresh_cache(self):
         path = "task/1"
 
         url = self._prepare_url(path=path)
         key = self.cache.get_key(url, {})
         cache_path = self.cache._key_to_path(key) / "meta.json"
 
-        response1 = self.http_client.get(path, use_cache=True)
+        response1 = self.http_client.get(path, enable_cache=True)
         response1_cache_time_stamp = cache_path.stat().st_ctime
 
-        response2 = self.http_client.get(path, use_cache=True, reset_cache=True)
+        response2 = self.http_client.get(path, enable_cache=True, refresh_cache=True)
         response2_cache_time_stamp = cache_path.stat().st_ctime
 
         self.assertNotEqual(response1_cache_time_stamp, response2_cache_time_stamp)