Refactored quote command (#3304)

* Refactored quote command

* gotchu colin

* Test

Co-authored-by: James Maslek <jmaslek11@gmail.com>

openbb_terminal/sdk.py

@@ -1894,7 +1894,7 @@
         "model": "openbb_terminal.stocks.stocks_helper.process_candle"
     },
     "stocks.search": {"model": "openbb_terminal.stocks.stocks_helper.search"},
-    "stocks.quote": {"model": "openbb_terminal.stocks.stocks_helper.quote"},
+    "stocks.quote": {"model": "openbb_terminal.stocks.stocks_models.load_quote"},
     "stocks.tob": {"model": "openbb_terminal.stocks.cboe_model.get_top_of_book"},
     "stocks.candle": {"model": "openbb_terminal.stocks.stocks_helper.display_candle"},
     "crypto.load": {

openbb_terminal/stocks/stocks_controller.py

@@ -33,6 +33,7 @@
     translate,
 )
 from openbb_terminal.stocks import stocks_helper
+from openbb_terminal.stocks import stocks_views
 
 # pylint: disable=R1710,import-outside-toplevel,R0913,R1702,no-member
 
@@ -368,7 +369,7 @@ def call_quote(self, other_args: List[str]):
             other_args.insert(0, "-t")
         ns_parser = self.parse_known_args_and_warn(parser, other_args)
         if ns_parser:
-            stocks_helper.quote(ns_parser.s_ticker)
+            stocks_views.display_quote(ns_parser.s_ticker)
 
     @log_start_end(log=logger)
     def call_codes(self, _):

openbb_terminal/stocks/stocks_helper.py

@@ -23,7 +23,6 @@
 from requests.exceptions import ReadTimeout
 
 import yfinance as yf
-from numpy.core.fromnumeric import transpose
 from plotly.subplots import make_subplots
 from scipy import stats
 
@@ -721,65 +720,6 @@ def display_candle(
         return data
 
 
-def quote(symbol: str) -> pd.DataFrame:
-    """Ticker quote.
-
-    Parameters
-    ----------
-    symbol : str
-        Ticker
-    """
-    ticker = yf.Ticker(symbol)
-
-    try:
-        quote_df = pd.DataFrame(
-            [
-                {
-                    "Symbol": ticker.info["symbol"],
-                    "Name": ticker.info["shortName"],
-                    "Price": ticker.info["regularMarketPrice"],
-                    "Open": ticker.info["regularMarketOpen"],
-                    "High": ticker.info["dayHigh"],
-                    "Low": ticker.info["dayLow"],
-                    "Previous Close": ticker.info["previousClose"],
-                    "Volume": ticker.info["volume"],
-                    "52 Week High": ticker.info["fiftyTwoWeekHigh"],
-                    "52 Week Low": ticker.info["fiftyTwoWeekLow"],
-                }
-            ]
-        )
-
-        quote_df["Change"] = quote_df["Price"] - quote_df["Previous Close"]
-        quote_df["Change %"] = quote_df.apply(
-            lambda x: f'{((x["Change"] / x["Previous Close"]) * 100):.2f}%',
-            axis="columns",
-        )
-        for c in [
-            "Price",
-            "Open",
-            "High",
-            "Low",
-            "Previous Close",
-            "52 Week High",
-            "52 Week Low",
-            "Change",
-        ]:
-            quote_df[c] = quote_df[c].apply(lambda x: f"{x:.2f}")
-        quote_df["Volume"] = quote_df["Volume"].apply(lambda x: f"{x:,}")
-
-        quote_df = quote_df.set_index("Symbol")
-
-        quote_data = transpose(quote_df)
-
-        print_rich_table(quote_data, title="Ticker Quote", show_index=True)
-        return quote_data
-
-    except KeyError:
-        logger.exception("Invalid stock ticker")
-        console.print(f"Invalid stock ticker: {symbol}")
-        return ""
-
-
 def load_ticker(
     ticker: str, start_date: Union[str, datetime], end_date: Union[str, datetime] = ""
 ) -> pd.DataFrame:

openbb_terminal/stocks/stocks_models.py

@@ -1,18 +1,21 @@
 import os
 from datetime import datetime
 
+import logging
 import pyEX
 import requests
 import pandas as pd
 import yfinance as yf
 from alpha_vantage.timeseries import TimeSeries
-from openbb_terminal.decorators import check_api_key
 
+from openbb_terminal.decorators import check_api_key
 from openbb_terminal.rich_config import console
 from openbb_terminal import config_terminal as cfg
 
 # pylint: disable=unsupported-assignment-operation,no-member
 
+logger = logging.getLogger(__name__)
+
 
 def load_stock_av(
     symbol: str, start_date: datetime, end_date: datetime
@@ -225,3 +228,61 @@ def load_stock_polygon(
     df_stock_candidate = df_stock_candidate.sort_values(by="date")
     df_stock_candidate = df_stock_candidate.set_index("date")
     return df_stock_candidate
+
+
+def load_quote(symbol: str) -> pd.DataFrame:
+    """Ticker quote.  [Source: YahooFinance]
+
+    Parameters
+    ----------
+    symbol : str
+        Ticker
+    """
+    ticker = yf.Ticker(symbol)
+
+    try:
+        quote_df = pd.DataFrame(
+            [
+                {
+                    "Symbol": ticker.info["symbol"],
+                    "Name": ticker.info["shortName"],
+                    "Price": ticker.info["regularMarketPrice"],
+                    "Open": ticker.info["regularMarketOpen"],
+                    "High": ticker.info["dayHigh"],
+                    "Low": ticker.info["dayLow"],
+                    "Previous Close": ticker.info["previousClose"],
+                    "Volume": ticker.info["volume"],
+                    "52 Week High": ticker.info["fiftyTwoWeekHigh"],
+                    "52 Week Low": ticker.info["fiftyTwoWeekLow"],
+                }
+            ]
+        )
+
+        quote_df["Change"] = quote_df["Price"] - quote_df["Previous Close"]
+        quote_df["Change %"] = quote_df.apply(
+            lambda x: f'{((x["Change"] / x["Previous Close"]) * 100):.2f}%',
+            axis="columns",
+        )
+        for c in [
+            "Price",
+            "Open",
+            "High",
+            "Low",
+            "Previous Close",
+            "52 Week High",
+            "52 Week Low",
+            "Change",
+        ]:
+            quote_df[c] = quote_df[c].apply(lambda x: f"{x:.2f}")
+        quote_df["Volume"] = quote_df["Volume"].apply(lambda x: f"{x:,}")
+
+        quote_df = quote_df.set_index("Symbol")
+
+        quote_data = quote_df.T
+
+        return quote_data
+
+    except KeyError:
+        logger.exception("Invalid stock ticker")
+        console.print(f"Invalid stock ticker: {symbol}")
+        return pd.DataFrame()

openbb_terminal/stocks/stocks_views.py

@@ -0,0 +1,14 @@
+import pandas as pd
+from openbb_terminal.stocks import stocks_models
+from openbb_terminal.helper_funcs import print_rich_table
+
+
+def display_quote(symbol: str) -> pd.DataFrame:
+    """Display quote from YahooFinance"""
+    quote_data = stocks_models.load_quote(symbol)
+    if quote_data is None:
+        return pd.DataFrame()
+    if quote_data.empty:
+        return pd.DataFrame()
+    print_rich_table(quote_data, title="Ticker Quote", show_index=True)
+    return quote_data

tests/openbb_terminal/stocks/test_stocks_controller.py

@@ -268,7 +268,7 @@ def test_call_func_expect_queue(expected_queue, func, queue):
         (
             "call_quote",
             [],
-            "stocks_helper.quote",
+            "stocks_views.display_quote",
             [],
             dict(),
         ),

tests/openbb_terminal/stocks/test_stocks_helper.py

@@ -7,6 +7,7 @@
 
 # IMPORTATION INTERNAL
 from openbb_terminal.stocks import stocks_helper
+from openbb_terminal.stocks import stocks_views
 from openbb_terminal import helper_funcs
 
 
@@ -26,7 +27,7 @@ def vcr_config():
 
 @pytest.mark.vcr
 def test_quote():
-    stocks_helper.quote("GME")
+    stocks_views.display_quote("GME")
 
 
 @pytest.mark.default_cassette("test_search")