Merge pull request #2487 from ranaroussi/feature/deprecate-requests-cache

Deprecate using requests_cache etc, only curl_cffi works

Author: ValueRaider

doc/source/advanced/caching.rst

@@ -1,47 +1,6 @@
 Caching
 =======
 
-Smarter Scraping
-----------------
-
-Install the `nospam` package to cache API calls and reduce spam to Yahoo:
-
-.. code-block:: bash
-
-   pip install yfinance[nospam]
-
-To use a custom `requests` session, pass a `session=` argument to
-the Ticker constructor. This allows for caching calls to the API as well as a custom way to modify requests via  the `User-agent` header.
-
-.. code-block:: python
-
-   import requests_cache
-   session = requests_cache.CachedSession('yfinance.cache')
-   session.headers['User-agent'] = 'my-program/1.0'
-   ticker = yf.Ticker('MSFT', session=session)
-   
-   # The scraped response will be stored in the cache
-   ticker.actions
-
-
-Combine `requests_cache` with rate-limiting to avoid triggering Yahoo's rate-limiter/blocker that can corrupt data.
-
-.. code-block:: python
-
-   from requests import Session
-   from requests_cache import CacheMixin, SQLiteCache
-   from requests_ratelimiter import LimiterMixin, MemoryQueueBucket
-   from pyrate_limiter import Duration, RequestRate, Limiter
-   class CachedLimiterSession(CacheMixin, LimiterMixin, Session):
-      pass
-
-   session = CachedLimiterSession(
-      limiter=Limiter(RequestRate(2, Duration.SECOND*5)),  # max 2 requests per 5 seconds
-      bucket_class=MemoryQueueBucket,
-      backend=SQLiteCache("yfinance.cache"),
-   )
-
-
 Persistent Cache
 ----------------
 

yfinance/data.py

@@ -10,7 +10,7 @@
 from . import utils, cache
 import threading
 
-from .exceptions import YFRateLimitError
+from .exceptions import YFRateLimitError, YFDataException
 
 cache_maxsize = 64
 
@@ -83,13 +83,9 @@ def __init__(self, session=None, proxy=None):
     def _set_session(self, session):
         if session is None:
             return
-        with self._cookie_lock:
-            self._session = session
-            if self._proxy is not None:
-                self._session.proxies = self._proxy
 
         try:
-            self._session.cache
+            session.cache
         except AttributeError:
             # Not caching
             self._session_is_caching = False
@@ -98,8 +94,16 @@ def _set_session(self, session):
             # Can't simply use a non-caching session to fetch cookie & crumb,
             # because then the caching-session won't have cookie.
             self._session_is_caching = True
-            from requests_cache import DO_NOT_CACHE
-            self._expire_after = DO_NOT_CACHE
+            # But since switch to curl_cffi, can't use requests_cache with it.
+            raise YFDataException("request_cache sessions don't work with curl_cffi, which is necessary now for Yahoo API. Solution: stop setting session, let YF handle.")
+
+        if not isinstance(session, requests.session.Session):
+            raise YFDataException(f"Yahoo API requires curl_cffi session not {type(session)}. Solution: stop setting session, let YF handle.")
+
+        with self._cookie_lock:
+            self._session = session
+            if self._proxy is not None:
+                self._session.proxies = self._proxy
 
     def _set_proxy(self, proxy=None):
         with self._cookie_lock: