From a11810ac74dff4b2edeb0be0fc8506c9e951f092 Mon Sep 17 00:00:00 2001 From: Joseph Walker Date: Fri, 10 Feb 2023 13:21:28 -0500 Subject: [PATCH] Remove export to file now that we are returning a dataframe. Always return a dataframe even if empty. Update tests to reflect removed function arguments. Update documentation as well. --- openbb_terminal/stocks/stocks_controller.py | 4 --- openbb_terminal/stocks/stocks_helper.py | 25 ++++++------------- .../stocks/test_stocks_controller.py | 2 -- .../stocks/test_stocks_helper.py | 1 - .../content/sdk/reference/stocks/search.md | 10 +++----- 5 files changed, 11 insertions(+), 31 deletions(-) diff --git a/openbb_terminal/stocks/stocks_controller.py b/openbb_terminal/stocks/stocks_controller.py index fe0bc20eb16..e3300982362 100644 --- a/openbb_terminal/stocks/stocks_controller.py +++ b/openbb_terminal/stocks/stocks_controller.py @@ -242,10 +242,6 @@ class StocksController(StockBaseController): exchange_country=exchange, all_exchanges=ns_parser.all_exchanges, limit=ns_parser.limit, - export=ns_parser.export, - sheet_name=" ".join(ns_parser.sheet_name) - if ns_parser.sheet_name - else None, ) @log_start_end(log=logger) diff --git a/openbb_terminal/stocks/stocks_helper.py b/openbb_terminal/stocks/stocks_helper.py index 2d0a4c677b1..34856e9a527 100644 --- a/openbb_terminal/stocks/stocks_helper.py +++ b/openbb_terminal/stocks/stocks_helper.py @@ -27,7 +27,6 @@ from scipy import stats from openbb_terminal import config_terminal as cfg from openbb_terminal.helper_funcs import ( - export_data, lambda_long_number_format_y_axis, plot_autoscale, print_rich_table, @@ -106,9 +105,7 @@ def search( exchange_country: str = "", all_exchanges: bool = False, limit: int = 0, - export: str = "", - sheet_name: Optional[str] = "", -) -> Optional[pd.DataFrame]: +) -> pd.DataFrame: """Search selected query for tickers. Parameters @@ -127,13 +124,12 @@ def search( Whether to search all exchanges, without this option only the United States market is searched limit : int The limit of companies shown. - export : str - Export data Returns ------- - df: Optional[pd.DataFrame] - Dataframe of search results if any results are found + df: pd.DataFrame + Dataframe of search results. + Empty Dataframe if none are found. Examples -------- @@ -162,10 +158,10 @@ def search( console.print( "[red]No companies were found that match the given criteria.[/red]\n" ) - return + return pd.DataFrame() if not data: console.print("No companies found.\n") - return + return pd.DataFrame() if query: d = fd.search_products( @@ -185,7 +181,7 @@ def search( if not d: console.print("No companies found.\n") - return + return pd.DataFrame() df = pd.DataFrame.from_dict(d).T[ ["long_name", "short_name", "country", "sector", "industry", "exchange"] @@ -229,13 +225,6 @@ def search( headers=["Name", "Country", "Sector", "Industry", "Exchange"], title=title, ) - export_data( - export, - os.path.dirname(os.path.abspath(__file__)), - "search", - df, - sheet_name, - ) return df diff --git a/tests/openbb_terminal/stocks/test_stocks_controller.py b/tests/openbb_terminal/stocks/test_stocks_controller.py index 3316100ca58..c21086406fc 100644 --- a/tests/openbb_terminal/stocks/test_stocks_controller.py +++ b/tests/openbb_terminal/stocks/test_stocks_controller.py @@ -263,8 +263,6 @@ def test_call_func_expect_queue(expected_queue, func, queue): industry="", all_exchanges=False, exchange_country="", - export="csv", - sheet_name=None, ), ), ( diff --git a/tests/openbb_terminal/stocks/test_stocks_helper.py b/tests/openbb_terminal/stocks/test_stocks_helper.py index 7c53cee644d..811d4073b5e 100644 --- a/tests/openbb_terminal/stocks/test_stocks_helper.py +++ b/tests/openbb_terminal/stocks/test_stocks_helper.py @@ -50,7 +50,6 @@ def test_search(mocker, use_tab): exchange_country="", all_exchanges=False, limit=5, - export="", ) diff --git a/website/content/sdk/reference/stocks/search.md b/website/content/sdk/reference/stocks/search.md index a1ac3ec7415..085839cac16 100644 --- a/website/content/sdk/reference/stocks/search.md +++ b/website/content/sdk/reference/stocks/search.md @@ -10,7 +10,7 @@ Search selected query for tickers. Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L98)] ```python -openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0, export: str = "", sheet_name: Optional[str] = "") +openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0) ``` --- @@ -25,16 +25,14 @@ openbb.stocks.search(query: str = "", country: str = "", sector: str = "", indus | industry | str | Search by industry to find stocks matching the criteria | | True | | exchange_country | str | Search by exchange country to find stock matching | | True | | limit | int | The limit of companies shown. | 0 | True | -| export | str | Export data | | True | -| sheet_name | str | Sheet Name | | True | --- ## Returns -| Type | Description | -|------------------------|---------------------------------| -| Optional[pd.DataFrame] | Search results if any are found | +| Type | Description | +|--------------|----------------| +| pd.DataFrame | Search results | ---