Merge pull request #2524 from ranaroussi/feature/expose-exceptions-v2

Improve exception handling

Author: ValueRaider

yfinance/__init__.py

@@ -32,6 +32,7 @@
 from .domain.industry import Industry
 from .domain.market import Market
 from .data import YfData
+from .config import YfConfig
 
 from .screener.query import EquityQuery, FundQuery
 from .screener.screener import screen, PREDEFINED_SCREENER_QUERIES
@@ -48,7 +49,9 @@
 
 # Config stuff:
 _NOTSET=object()
-def set_config(proxy=_NOTSET):
+def set_config(proxy=_NOTSET, hide_exceptions=_NOTSET):
     if proxy is not _NOTSET:
         YfData(proxy=proxy)
+    if hide_exceptions is not _NOTSET:
+        YfConfig(hide_exceptions=hide_exceptions)
 __all__ += ["set_config"]

yfinance/base.py

@@ -34,7 +34,8 @@
 from . import utils, cache
 from .const import _MIC_TO_YAHOO_SUFFIX
 from .data import YfData
-from .exceptions import YFEarningsDateMissing, YFRateLimitError
+from .config import YfConfig
+from .exceptions import YFDataException, YFEarningsDateMissing, YFRateLimitError
 from .live import WebSocket
 from .scrapers.analysis import Analysis
 from .scrapers.fundamentals import Fundamentals
@@ -188,6 +189,8 @@ def _fetch_ticker_tz(self, timeout):
             # Must propagate this
             raise
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             logger.error(f"Failed to get ticker '{self.ticker}' reason: {e}")
             return None
         else:
@@ -199,6 +202,8 @@ def _fetch_ticker_tz(self, timeout):
                 try:
                     return data["chart"]["result"][0]["meta"]["exchangeTimezoneName"]
                 except Exception as err:
+                    if not YfConfig().hide_exceptions:
+                        raise
                     logger.error(f"Could not get exchangeTimezoneName for ticker '{self.ticker}' reason: {err}")
                     logger.debug("Got response: ")
                     logger.debug("-------------")
@@ -628,13 +633,17 @@ def get_shares_full(self, start=None, end=None, proxy=_SENTINEL_):
             json_data = self._data.cache_get(url=shares_url)
             json_data = json_data.json()
         except (_json.JSONDecodeError, requests.exceptions.RequestException):
+            if not YfConfig().hide_exceptions:
+                raise
             logger.error(f"{self.ticker}: Yahoo web request for share count failed")
             return None
         try:
             fail = json_data["finance"]["error"]["code"] == "Bad Request"
         except KeyError:
             fail = False
         if fail:
+            if not YfConfig().hide_exceptions:
+                raise requests.exceptions.HTTPError("Yahoo web request for share count returned 'Bad Request'")
             logger.error(f"{self.ticker}: Yahoo web request for share count failed")
             return None
 
@@ -644,6 +653,8 @@ def get_shares_full(self, start=None, end=None, proxy=_SENTINEL_):
         try:
             df = pd.Series(shares_data[0]["shares_out"], index=pd.to_datetime(shares_data[0]["timestamp"], unit="s"))
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             logger.error(f"{self.ticker}: Failed to parse shares count data: {e}")
             return None
 
@@ -722,12 +733,12 @@ def get_news(self, count=10, tab="news", proxy=_SENTINEL_) -> list:
 
         data = self._data.post(url, body=payload)
         if data is None or "Will be right back" in data.text:
-            raise RuntimeError("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***\n"
-                               "Our engineers are working quickly to resolve "
-                               "the issue. Thank you for your patience.")
+            raise YFDataException("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***")
         try:
             data = data.json()
         except _json.JSONDecodeError:
+            if not YfConfig().hide_exceptions:
+                raise
             logger.error(f"{self.ticker}: Failed to retrieve the news and received faulty response instead.")
             data = {}
 

yfinance/config.py

@@ -0,0 +1,33 @@
+import threading
+
+class SingletonMeta(type):
+    """
+    Metaclass that creates a Singleton instance.
+    """
+    _instances = {}
+    _lock = threading.Lock()
+
+    def __call__(cls, *args, **kwargs):
+        with cls._lock:
+            if cls not in cls._instances:
+                instance = super().__call__(*args, **kwargs)
+                cls._instances[cls] = instance
+            else:
+                # Update the existing instance
+                if 'hide_exceptions' in kwargs or (args and len(args) > 0):
+                    hide_exceptions = kwargs.get('hide_exceptions') if 'hide_exceptions' in kwargs else args[0]
+                    cls._instances[cls]._set_hide_exceptions(hide_exceptions)
+            return cls._instances[cls]
+
+
+class YfConfig(metaclass=SingletonMeta):
+    def __init__(self, hide_exceptions=True):
+        self._hide_exceptions = hide_exceptions
+
+    def _set_hide_exceptions(self, hide_exceptions):
+        self._hide_exceptions = hide_exceptions
+
+    @property
+    def hide_exceptions(self):
+        return self._hide_exceptions
+    

yfinance/data.py

@@ -11,7 +11,7 @@
 from . import utils, cache
 import threading
 
-from .exceptions import YFRateLimitError, YFDataException
+from .exceptions import YFException, YFDataException, YFRateLimitError
 
 cache_maxsize = 64
 
@@ -198,8 +198,10 @@ def _get_cookie_basic(self, timeout=30):
                 url='https://fc.yahoo.com',
                 timeout=timeout,
                 allow_redirects=True)
-        except requests.exceptions.DNSError:
-            # Possible because url on some privacy/ad blocklists
+        except requests.exceptions.DNSError as e:
+            # Possible because url on some privacy/ad blocklists.
+            # Can ignore because have second strategy.
+            utils.get_yf_logger().debug("Handling DNS error on cookie fetch: " + str(e))
             return False
         self._save_cookie_curlCffi()
         return True
@@ -397,7 +399,7 @@ def _make_request(self, url, request_method, body=None, params=None, timeout=30)
         if params is None:
             params = {}
         if 'crumb' in params:
-            raise Exception("Don't manually add 'crumb' to params dict, let data.py handle it")
+            raise YFException("Don't manually add 'crumb' to params dict, let data.py handle it")
 
         crumb, strategy = self._get_cookie_and_crumb()
         if crumb is not None:

yfinance/domain/industry.py

@@ -5,6 +5,7 @@
 import warnings
 
 from .. import utils
+from ..config import YfConfig
 from ..const import _SENTINEL_
 from ..data import YfData
 
@@ -147,6 +148,8 @@ def _fetch_and_parse(self) -> None:
 
             return result
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             logger = utils.get_yf_logger()
             logger.error(f"Failed to get industry data for '{self._key}' reason: {e}")
             logger.debug("Got response: ")

yfinance/domain/market.py

@@ -2,8 +2,10 @@
 import json as _json
 import warnings
 
+from ..config import YfConfig
 from ..const import _QUERY1_URL_, _SENTINEL_
 from ..data import utils, YfData
+from ..exceptions import YFDataException
 
 class Market:
     def __init__(self, market:'str', session=None, proxy=_SENTINEL_, timeout=30):
@@ -24,12 +26,12 @@ def __init__(self, market:'str', session=None, proxy=_SENTINEL_, timeout=30):
     def _fetch_json(self, url, params):
         data = self._data.cache_get(url=url, params=params, timeout=self.timeout)
         if data is None or "Will be right back" in data.text:
-            raise RuntimeError("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***\n"
-                               "Our engineers are working quickly to resolve "
-                               "the issue. Thank you for your patience.")
+            raise YFDataException("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***")
         try:
             return data.json()
         except _json.JSONDecodeError:
+            if not YfConfig().hide_exceptions:
+                raise
             self._logger.error(f"{self.market}: Failed to retrieve market data and recieved faulty data.")
             return {}
 
@@ -66,6 +68,8 @@ def _parse_data(self):
             self._summary = self._summary['marketSummaryResponse']['result']
             self._summary = {x['exchange']:x for x in self._summary}
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             self._logger.error(f"{self.market}: Failed to parse market summary")
             self._logger.debug(f"{type(e)}: {e}")
 
@@ -75,18 +79,22 @@ def _parse_data(self):
             self._status = self._status['finance']['marketTimes'][0]['marketTime'][0]
             self._status['timezone'] = self._status['timezone'][0]
             del self._status['time']  # redundant
-            try:
-                self._status.update({
-                    "open": dt.datetime.fromisoformat(self._status["open"]),
-                    "close": dt.datetime.fromisoformat(self._status["close"]),
-                    "tz": dt.timezone(dt.timedelta(hours=int(self._status["timezone"]["gmtoffset"]))/1000, self._status["timezone"]["short"])
-                })
-            except Exception as e:
-                self._logger.error(f"{self.market}: Failed to update market status")
-                self._logger.debug(f"{type(e)}: {e}")
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             self._logger.error(f"{self.market}: Failed to parse market status")
             self._logger.debug(f"{type(e)}: {e}")
+        try:
+            self._status.update({
+                "open": dt.datetime.fromisoformat(self._status["open"]),
+                "close": dt.datetime.fromisoformat(self._status["close"]),
+                "tz": dt.timezone(dt.timedelta(hours=int(self._status["timezone"]["gmtoffset"]))/1000, self._status["timezone"]["short"])
+            })
+        except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
+            self._logger.error(f"{self.market}: Failed to update market status")
+            self._logger.debug(f"{type(e)}: {e}")
 
 
 

yfinance/domain/sector.py

@@ -4,6 +4,7 @@
 from typing import Dict, Optional
 import warnings
 
+from ..config import YfConfig
 from ..const import SECTOR_INDUSTY_MAPPING_LC, _SENTINEL_
 from ..data import YfData
 from ..utils import dynamic_docstring, generate_list_table_from_dict, get_yf_logger
@@ -148,6 +149,8 @@ def _fetch_and_parse(self) -> None:
             self._industries = self._parse_industries(data.get('industries', {}))
 
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             logger = get_yf_logger()
             logger.error(f"Failed to get sector data for '{self._key}' reason: {e}")
             logger.debug("Got response: ")

yfinance/live.py

@@ -7,6 +7,7 @@
 from websockets.asyncio.client import connect as async_connect
 
 from yfinance import utils
+from yfinance.config import YfConfig
 from yfinance.pricing_pb2 import PricingData
 from google.protobuf.json_format import MessageToDict
 
@@ -27,6 +28,8 @@ def _decode_message(self, base64_message: str) -> dict:
             pricing_data.ParseFromString(decoded_bytes)
             return MessageToDict(pricing_data, preserving_proto_field_name=True)
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             self.logger.error("Failed to decode message: %s", e, exc_info=True)
             if self.verbose:
                 print("Failed to decode message: %s", e)
@@ -61,6 +64,8 @@ async def _connect(self):
                 if self.verbose:
                     print("Connected to WebSocket.")
         except Exception as e:
+            if not YfConfig().hide_exceptions:
+                raise
             self.logger.error("Failed to connect to WebSocket: %s", e, exc_info=True)
             if self.verbose:
                 print(f"Failed to connect to WebSocket: {e}")
@@ -79,6 +84,8 @@ async def _periodic_subscribe(self):
                     if self.verbose:
                         print(f"Heartbeat subscription sent for symbols: {self._subscriptions}")
             except Exception as e:
+                if not YfConfig().hide_exceptions:
+                    raise
                 self.logger.error("Error in heartbeat subscription: %s", e, exc_info=True)
                 if self.verbose:
                     print(f"Error in heartbeat subscription: {e}")
@@ -162,6 +169,8 @@ async def listen(self, message_handler=None):
                             else:
                                 self._message_handler(decoded_message)
                         except Exception as handler_exception:
+                            if not YfConfig().hide_exceptions:
+                                raise
                             self.logger.error("Error in message handler: %s", handler_exception, exc_info=True)
                             if self.verbose:
                                 print("Error in message handler:", handler_exception)
@@ -176,6 +185,8 @@ async def listen(self, message_handler=None):
                 break
 
             except Exception as e:
+                if not YfConfig().hide_exceptions:
+                    raise
                 self.logger.error("Error while listening to messages: %s", e, exc_info=True)
                 if self.verbose:
                     print("Error while listening to messages: %s", e)
@@ -301,6 +312,8 @@ def listen(self, message_handler: Optional[Callable[[dict], None]] = None):
                     try:
                         message_handler(decoded_message)
                     except Exception as handler_exception:
+                        if not YfConfig().hide_exceptions:
+                            raise
                         self.logger.error("Error in message handler: %s", handler_exception, exc_info=True)
                         if self.verbose:
                             print("Error in message handler:", handler_exception)
@@ -314,6 +327,8 @@ def listen(self, message_handler: Optional[Callable[[dict], None]] = None):
                 break
 
             except Exception as e:
+                if not YfConfig().hide_exceptions:
+                    raise
                 self.logger.error("Error while listening to messages: %s", e, exc_info=True)
                 if self.verbose:
                     print("Error while listening to messages: %s", e)

yfinance/lookup.py

@@ -24,9 +24,10 @@
 import warnings
 
 from . import utils
+from .config import YfConfig
 from .const import _QUERY1_URL_, _SENTINEL_
 from .data import YfData
-from .exceptions import YFException
+from .exceptions import YFDataException
 
 LOOKUP_TYPES = ["all", "equity", "mutualfund", "etf", "index", "future", "currency", "cryptocurrency"]
 
@@ -81,18 +82,19 @@ def _fetch_lookup(self, lookup_type="all", count=25) -> dict:
 
         data = self._data.get(url=url, params=params, timeout=self.timeout)
         if data is None or "Will be right back" in data.text:
-            raise RuntimeError("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***\n"
-                               "Our engineers are working quickly to resolve "
-                               "the issue. Thank you for your patience.")
+            raise YFDataException("*** YAHOO! FINANCE IS CURRENTLY DOWN! ***")
         try:
             data = data.json()
         except _json.JSONDecodeError:
-            self._logger.error(f"{self.query}: Failed to retrieve lookup results and received faulty response instead.")
+            if not YfConfig().hide_exceptions:
+                raise
+            self._logger.error(f"{self.ticker}: 'lookup' fetch received faulty data")
             data = {}
 
         # Error returned
         if data.get("finance", {}).get("error", {}):
-            raise YFException(data.get("finance", {}).get("error", {}))
+            error = data.get("finance", {}).get("error", {})
+            raise YFDataException(f"{self.ticker}: 'lookup' fetch returned error: {error}")
 
         self._cache[cache_key] = data
         return data