From 77f538c4deb528e5e775ec999a34c55c5db45133 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Wed, 7 Dec 2022 18:03:21 +0000 Subject: [PATCH] Fixes portfolio/bench (#3725) * fix benchmark * fix integration test --- .../scripts/portfolio/test_portfolio.openbb | 4 +- .../portfolio/portfolio_controller.py | 39 ++-- openbb_terminal/portfolio/statics.py | 202 +++++++++--------- 3 files changed, 117 insertions(+), 128 deletions(-) diff --git a/openbb_terminal/miscellaneous/scripts/portfolio/test_portfolio.openbb b/openbb_terminal/miscellaneous/scripts/portfolio/test_portfolio.openbb index b456bb372dd..6fc6c3e2be8 100644 --- a/openbb_terminal/miscellaneous/scripts/portfolio/test_portfolio.openbb +++ b/openbb_terminal/miscellaneous/scripts/portfolio/test_portfolio.openbb @@ -1,7 +1,7 @@ portfolio load -f Public_Equity_Orderbook.xlsx show -bench SPDR S&P 500 ETF Trust (SPY) +bench QQQ alloc assets -t -l 4 alloc sectors -t -l 4 alloc countries -t -l 4 @@ -110,4 +110,4 @@ es -p 50 om om --start 0.05 --end 0.2 q -exit \ No newline at end of file +exit diff --git a/openbb_terminal/portfolio/portfolio_controller.py b/openbb_terminal/portfolio/portfolio_controller.py index 32dec3cad80..d469340b401 100644 --- a/openbb_terminal/portfolio/portfolio_controller.py +++ b/openbb_terminal/portfolio/portfolio_controller.py @@ -151,7 +151,7 @@ class PortfolioController(BaseController): self.portfolio_name: str = "" self.benchmark_name: str = "" - self.original_benchmark_name = "" + self.original_benchmark_ticker = "" self.risk_free_rate = 0 self.portlist: List[str] = os.listdir(self.DEFAULT_HOLDINGS_PATH) self.portfolio = None @@ -269,8 +269,8 @@ class PortfolioController(BaseController): objects_to_reload = ["portfolio"] if self.portfolio_name: objects_to_reload.append(f"load {self.portfolio_name}") - if self.original_benchmark_name: - objects_to_reload.append(f'bench "{self.original_benchmark_name}"') + if self.original_benchmark_ticker: + objects_to_reload.append(f'bench "{self.original_benchmark_ticker}"') return objects_to_reload @log_start_end(log=logger) @@ -334,7 +334,8 @@ class PortfolioController(BaseController): dest="risk_free_rate", help="Set the risk free rate.", ) - + if other_args and "-" not in other_args[0][0]: + other_args.insert(0, "-f") ns_parser = self.parse_known_args_and_warn(parser, other_args) if ns_parser and ns_parser.file: @@ -364,7 +365,7 @@ class PortfolioController(BaseController): self.benchmark_name = "SPDR S&P 500 ETF Trust (SPY)" console.print( - f"[bold][param]Benchmark:[/param][/bold] {self.benchmark_name}\n" + f"[bold][param]Benchmark:[/param][/bold] {self.benchmark_name}" ) @log_start_end(log=logger) @@ -404,11 +405,10 @@ class PortfolioController(BaseController): "--benchmark", type=str, default="SPY", - nargs="+", dest="benchmark", required="-h" not in other_args, help="Set the benchmark for the portfolio. By default, this is SPDR S&P 500 ETF Trust (SPY).", - choices={c: {} for c in statics.BENCHMARK_LIST}, + choices={c: {} for c in statics.BENCHMARK_CHOICES}, metavar="BENCHMARK", ) parser.add_argument( @@ -423,26 +423,15 @@ class PortfolioController(BaseController): other_args.insert(0, "-b") ns_parser = self.parse_known_args_and_warn(parser, other_args) - if ns_parser and self.portfolio is not None: - # Needs to be checked since we want to use the start date of the portfolio when comparing with benchmark - if self.portfolio_name: - chosen_benchmark = " ".join(ns_parser.benchmark) - - if chosen_benchmark in statics.BENCHMARK_LIST: - benchmark_ticker = statics.BENCHMARK_LIST[chosen_benchmark] - self.original_benchmark_name = chosen_benchmark - else: - benchmark_ticker = chosen_benchmark - - self.portfolio.set_benchmark(benchmark_ticker, ns_parser.full_shares) - - self.benchmark_name = chosen_benchmark - - else: + if ns_parser: + if self.portfolio is None: console.print( - "[red]Please first load transactions file using 'load'[/red]\n" + "[red]Please first load transactions file using 'load'[/red]" ) - console.print() + else: + self.benchmark_name = statics.BENCHMARK_CHOICES.get(ns_parser.benchmark) + self.original_benchmark_ticker = ns_parser.benchmark + self.portfolio.set_benchmark(ns_parser.benchmark, ns_parser.full_shares) @log_start_end(log=logger) def call_alloc(self, other_args: List[str]): diff --git a/openbb_terminal/portfolio/statics.py b/openbb_terminal/portfolio/statics.py index 264b43134e4..1df548edb95 100644 --- a/openbb_terminal/portfolio/statics.py +++ b/openbb_terminal/portfolio/statics.py @@ -1,107 +1,107 @@ """Statics""" __docformat__ = "numpy" -BENCHMARK_LIST = { - "SPDR S&P 500 ETF Trust (SPY)": "SPY", - "iShares Core S&P 500 ETF (IVV)": "IVV", - "Vanguard Total Stock Market ETF (VTI)": "VTI", - "Vanguard S&P 500 ETF (VOO)": "VOO", - "Invesco QQQ Trust (QQQ)": "QQQ", - "Vanguard Value ETF (VTV)": "VTV", - "Vanguard FTSE Developed Markets ETF (VEA)": "VEA", - "iShares Core MSCI EAFE ETF (IEFA)": "IEFA", - "iShares Core U.S. Aggregate Bond ETF (AGG)": "AGG", - "Vanguard Total Bond Market ETF (BND)": "BND", - "Vanguard FTSE Emerging Markets ETF (VWO)": "VWO", - "Vanguard Growth ETF (VUG)": "VUG", - "iShares Core MSCI Emerging Markets ETF (IEMG)": "IEMG", - "iShares Core S&P Small-Cap ETF (IJR)": "IJR", - "SPDR Gold Shares (GLD)": "GLD", - "iShares Russell 1000 Growth ETF (IWF)": "IWF", - "iShares Core S&P Mid-Cap ETF (IJH)": "IJH", - "Vanguard Dividend Appreciation ETF (VIG)": "VIG", - "iShares Russell 2000 ETF (IWM)": "IWM", - "iShares Russell 1000 Value ETF (IWD)": "IWD", - "Vanguard Mid-Cap ETF (VO)": "VO", - "iShares MSCI EAFE ETF (EFA)": "EFA", - "Vanguard Total International Stock ETF (VXUS)": "VXUS", - "Vanguard Information Technology ETF (VGT)": "VGT", - "Vanguard High Dividend Yield Index ETF (VYM)": "VYM", - "Vanguard Total International Bond ETF (BNDX)": "BNDX", - "Vanguard Real Estate ETF (VNQ)": "VNQ", - "Vanguard Small Cap ETF (VB)": "VB", - "Technology Select Sector SPDR Fund (XLK)": "XLK", - "iShares Core S&P Total U.S. Stock Market ETF (ITOT)": "ITOT", - "Vanguard Intermediate-Term Corporate Bond ETF (VCIT)": "VCIT", - "Vanguard Short-Term Corporate Bond ETF (VCSH)": "VCSH", - "Energy Select Sector SPDR Fund (XLE)": "XLE", - "Health Care Select Sector SPDR Fund (XLV)": "XLV", - "Vanguard Short-Term Bond ETF (BSV)": "BSV", - "Financial Select Sector SPDR Fund (XLF)": "XLF", - "Schwab US Dividend Equity ETF (SCHD)": "SCHD", - "Invesco S&P 500® Equal Weight ETF (RSP)": "RSP", - "iShares iBoxx $ Investment Grade Corporate Bond ETF (LQD)": "LQD", - "iShares S&P 500 Growth ETF (IVW)": "IVW", - "Vanguard FTSE All-World ex-US Index Fund (VEU)": "VEU", - "iShares TIPS Bond ETF (TIP)": "TIP", - "iShares Gold Trust (IAU)": "IAU", - "Schwab U.S. Large-Cap ETF (SCHX)": "SCHX", - "iShares Core MSCI Total International Stock ETF (IXUS)": "IXUS", - "iShares Russell Midcap ETF (IWR)": "IWR", - "iShares Russell 1000 ETF (IWB)": "IWB", - "SPDR Dow Jones Industrial Average ETF Trust (DIA)": "DIA", - "iShares MSCI Emerging Markets ETF (EEM)": "EEM", - "iShares MSCI USA Min Vol Factor ETF (USMV)": "USMV", - "Schwab International Equity ETF (SCHF)": "SCHF", - "iShares S&P 500 Value ETF (IVE)": "IVE", - "iShares National Muni Bond ETF (MUB)": "MUB", - "Vanguard Large Cap ETF (VV)": "VV", - "Vanguard Small Cap Value ETF (VBR)": "VBR", - "iShares ESG Aware MSCI USA ETF (ESGU)": "ESGU", - "Vanguard Total World Stock ETF (VT)": "VT", - "iShares Core Dividend Growth ETF (DGRO)": "DGRO", - "iShares 1-3 Year Treasury Bond ETF (SHY)": "SHY", - "iShares Select Dividend ETF (DVY)": "DVY", - "iShares MSCI USA Quality Factor ETF (QUAL)": "QUAL", - "Schwab U.S. Broad Market ETF (SCHB)": "SCHB", - "iShares MBS ETF (MBB)": "MBB", - "SPDR S&P Dividend ETF (SDY)": "SDY", - "iShares 1-5 Year Investment Grade Corporate Bond ETF (IGSB)": "IGSB", - "Vanguard Short-Term Inflation-Protected Securities ETF (VTIP)": "VTIP", - "JPMorgan Ultra-Short Income ETF (JPST)": "JPST", - "iShares 20+ Year Treasury Bond ETF (TLT)": "TLT", - "iShares MSCI ACWI ETF (ACWI)": "ACWI", - "SPDR S&P Midcap 400 ETF Trust (MDY)": "MDY", - "iShares Core Total USD Bond Market ETF (IUSB)": "IUSB", - "iShares Short Treasury Bond ETF (SHV)": "SHV", - "Vanguard FTSE Europe ETF (VGK)": "VGK", - "Consumer Discretionary Select Sector SPDR Fund (XLY)": "XLY", - "SPDR Bloomberg 1-3 Month T-Bill ETF (BIL)": "BIL", - "iShares U.S. Treasury Bond ETF (GOVT)": "GOVT", - "Vanguard Health Care ETF (VHT)": "VHT", - "Vanguard Mid-Cap Value ETF (VOE)": "VOE", - "Consumer Staples Select Sector SPDR Fund (XLP)": "XLP", - "Schwab U.S. TIPS ETF (SCHP)": "SCHP", - "iShares 7-10 Year Treasury Bond ETF (IEF)": "IEF", - "iShares Preferred & Income Securities ETF (PFF)": "PFF", - "Utilities Select Sector SPDR Fund (XLU)": "XLU", - "Vanguard Tax-Exempt Bond ETF (VTEB)": "VTEB", - "iShares MSCI EAFE Value ETF (EFV)": "EFV", - "Schwab U.S. Large-Cap Growth ETF (SCHG)": "SCHG", - "iShares J.P. Morgan USD Emerging Markets Bond ETF (EMB)": "EMB", - "Dimensional U.S. Core Equity 2 ETF (DFAC)": "DFAC", - "Schwab U.S. Small-Cap ETF (SCHA)": "SCHA", - "VanEck Gold Miners ETF (GDX)": "GDX", - "Vanguard Mortgage-Backed Securities ETF (VMBS)": "VMBS", - "ProShares UltraPro QQQ (TQQQ)": "TQQQ", - "Vanguard Short-Term Treasury ETF (VGSH)": "VGSH", - "iShares iBoxx $ High Yield Corporate Bond ETF (HYG)": "HYG", - "Industrial Select Sector SPDR Fund (XLI)": "XLI", - "iShares Russell Mid-Cap Value ETF (IWS)": "IWS", - "Vanguard Extended Market ETF (VXF)": "VXF", - "SPDR Portfolio S&P 500 ETF (SPLG)": "SPLG", - "SPDR Portfolio S&P 500 Value ETF (SPYV)": "SPYV", - "iShares Russell 2000 Value ETF (IWN)": "IWN", +BENCHMARK_CHOICES = { + "SPY": "SPDR S&P 500 ETF Trust (SPY)", + "IVV": "iShares Core S&P 500 ETF (IVV)", + "VTI": "Vanguard Total Stock Market ETF (VTI)", + "VOO": "Vanguard S&P 500 ETF (VOO)", + "QQQ": "Invesco QQQ Trust (QQQ)", + "VTV": "Vanguard Value ETF (VTV)", + "VEA": "Vanguard FTSE Developed Markets ETF (VEA)", + "IEFA": "iShares Core MSCI EAFE ETF (IEFA)", + "AGG": "iShares Core U.S. Aggregate Bond ETF (AGG)", + "BND": "Vanguard Total Bond Market ETF (BND)", + "VWO": "Vanguard FTSE Emerging Markets ETF (VWO)", + "VUG": "Vanguard Growth ETF (VUG)", + "IEMG": "iShares Core MSCI Emerging Markets ETF (IEMG)", + "IJR": "iShares Core S&P Small-Cap ETF (IJR)", + "GLD": "SPDR Gold Shares (GLD)", + "IWF": "iShares Russell 1000 Growth ETF (IWF)", + "IJH": "iShares Core S&P Mid-Cap ETF (IJH)", + "VIG": "Vanguard Dividend Appreciation ETF (VIG)", + "IWM": "iShares Russell 2000 ETF (IWM)", + "IWD": "iShares Russell 1000 Value ETF (IWD)", + "VO": "Vanguard Mid-Cap ETF (VO)", + "EFA": "iShares MSCI EAFE ETF (EFA)", + "VXUS": "Vanguard Total International Stock ETF (VXUS)", + "VGT": "Vanguard Information Technology ETF (VGT)", + "VYM": "Vanguard High Dividend Yield Index ETF (VYM)", + "BNDX": "Vanguard Total International Bond ETF (BNDX)", + "VNQ": "Vanguard Real Estate ETF (VNQ)", + "VB": "Vanguard Small Cap ETF (VB)", + "XLK": "Technology Select Sector SPDR Fund (XLK)", + "ITOT": "iShares Core S&P Total U.S. Stock Market ETF (ITOT)", + "VCIT": "Vanguard Intermediate-Term Corporate Bond ETF (VCIT)", + "VCSH": "Vanguard Short-Term Corporate Bond ETF (VCSH)", + "XLE": "Energy Select Sector SPDR Fund (XLE)", + "XLV": "Health Care Select Sector SPDR Fund (XLV)", + "BSV": "Vanguard Short-Term Bond ETF (BSV)", + "XLF": "Financial Select Sector SPDR Fund (XLF)", + "SCHD": "Schwab US Dividend Equity ETF (SCHD)", + "RSP": "Invesco S&P 500® Equal Weight ETF (RSP)", + "LQD": "iShares iBoxx $ Investment Grade Corporate Bond ETF (LQD)", + "IVW": "iShares S&P 500 Growth ETF (IVW)", + "VEU": "Vanguard FTSE All-World ex-US Index Fund (VEU)", + "TIP": "iShares TIPS Bond ETF (TIP)", + "IAU": "iShares Gold Trust (IAU)", + "SCHX": "Schwab U.S. Large-Cap ETF (SCHX)", + "IXUS": "iShares Core MSCI Total International Stock ETF (IXUS)", + "IWR": "iShares Russell Midcap ETF (IWR)", + "IWB": "iShares Russell 1000 ETF (IWB)", + "DIA": "SPDR Dow Jones Industrial Average ETF Trust (DIA)", + "EEM": "iShares MSCI Emerging Markets ETF (EEM)", + "USMV": "iShares MSCI USA Min Vol Factor ETF (USMV)", + "SCHF": "Schwab International Equity ETF (SCHF)", + "IVE": "iShares S&P 500 Value ETF (IVE)", + "MUB": "iShares National Muni Bond ETF (MUB)", + "VV": "Vanguard Large Cap ETF (VV)", + "VBR": "Vanguard Small Cap Value ETF (VBR)", + "ESGU": "iShares ESG Aware MSCI USA ETF (ESGU)", + "VT": "Vanguard Total World Stock ETF (VT)", + "DGRO": "iShares Core Dividend Growth ETF (DGRO)", + "SHY": "iShares 1-3 Year Treasury Bond ETF (SHY)", + "DVY": "iShares Select Dividend ETF (DVY)", + "QUAL": "iShares MSCI USA Quality Factor ETF (QUAL)", + "SCHB": "Schwab U.S. Broad Market ETF (SCHB)", + "MBB": "iShares MBS ETF (MBB)", + "SDY": "SPDR S&P Dividend ETF (SDY)", + "IGSB": "iShares 1-5 Year Investment Grade Corporate Bond ETF (IGSB)", + "VTIP": "Vanguard Short-Term Inflation-Protected Securities ETF (VTIP)", + "JPST": "JPMorgan Ultra-Short Income ETF (JPST)", + "TLT": "iShares 20+ Year Treasury Bond ETF (TLT)", + "ACWI": "iShares MSCI ACWI ETF (ACWI)", + "MDY": "SPDR S&P Midcap 400 ETF Trust (MDY)", + "IUSB": "iShares Core Total USD Bond Market ETF (IUSB)", + "SHV": "iShares Short Treasury Bond ETF (SHV)", + "VGK": "Vanguard FTSE Europe ETF (VGK)", + "XLY": "Consumer Discretionary Select Sector SPDR Fund (XLY)", + "BIL": "SPDR Bloomberg 1-3 Month T-Bill ETF (BIL)", + "GOVT": "iShares U.S. Treasury Bond ETF (GOVT)", + "VHT": "Vanguard Health Care ETF (VHT)", + "VOE": "Vanguard Mid-Cap Value ETF (VOE)", + "XLP": "Consumer Staples Select Sector SPDR Fund (XLP)", + "SCHP": "Schwab U.S. TIPS ETF (SCHP)", + "IEF": "iShares 7-10 Year Treasury Bond ETF (IEF)", + "PFF": "iShares Preferred & Income Securities ETF (PFF)", + "XLU": "Utilities Select Sector SPDR Fund (XLU)", + "VTEB": "Vanguard Tax-Exempt Bond ETF (VTEB)", + "EFV": "iShares MSCI EAFE Value ETF (EFV)", + "SCHG": "Schwab U.S. Large-Cap Growth ETF (SCHG)", + "EMB": "iShares J.P. Morgan USD Emerging Markets Bond ETF (EMB)", + "DFAC": "Dimensional U.S. Core Equity 2 ETF (DFAC)", + "SCHA": "Schwab U.S. Small-Cap ETF (SCHA)", + "GDX": "VanEck Gold Miners ETF (GDX)", + "VMBS": "Vanguard Mortgage-Backed Securities ETF (VMBS)", + "TQQQ": "ProShares UltraPro QQQ (TQQQ)", + "VGSH": "Vanguard Short-Term Treasury ETF (VGSH)", + "HYG": "iShares iBoxx $ High Yield Corporate Bond ETF (HYG)", + "XLI": "Industrial Select Sector SPDR Fund (XLI)", + "IWS": "iShares Russell Mid-Cap Value ETF (IWS)", + "VXF": "Vanguard Extended Market ETF (VXF)", + "SPLG": "SPDR Portfolio S&P 500 ETF (SPLG)", + "SPYV": "SPDR Portfolio S&P 500 Value ETF (SPYV)", + "IWN": "iShares Russell 2000 Value ETF (IWN)", } PERIODS = ["mtd", "qtd", "ytd", "3m", "6m", "1y", "3y", "5y", "10y", "all"]