mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
0d49294f1a
* First few * Rest of stock controllers * Other context controllers Co-authored-by: James Maslek <james@macbook-pro.myfiosgateway.com>
335 lines
8.6 KiB
Python
335 lines
8.6 KiB
Python
#!/usr/bin/env python
|
|
"""Main Terminal Module"""
|
|
__docformat__ = "numpy"
|
|
|
|
import argparse
|
|
import difflib
|
|
import sys
|
|
|
|
from prompt_toolkit.completion import NestedCompleter
|
|
|
|
from gamestonk_terminal import config_terminal
|
|
from gamestonk_terminal import feature_flags as gtff
|
|
from gamestonk_terminal.helper_funcs import (
|
|
get_flair,
|
|
system_clear,
|
|
MENU_RESET,
|
|
MENU_GO_BACK,
|
|
MENU_QUIT,
|
|
)
|
|
from gamestonk_terminal.menu import session
|
|
from gamestonk_terminal.terminal_helper import (
|
|
about_us,
|
|
bootup,
|
|
check_api_keys,
|
|
print_goodbye,
|
|
reset,
|
|
update_terminal,
|
|
)
|
|
|
|
# pylint: disable=too-many-public-methods,import-outside-toplevel
|
|
|
|
|
|
class TerminalController:
|
|
"""Terminal Controller class"""
|
|
|
|
CHOICES = [
|
|
"cls",
|
|
"?",
|
|
"help",
|
|
"q",
|
|
"quit",
|
|
]
|
|
|
|
CHOICES_COMMANDS = [
|
|
"reset",
|
|
"update",
|
|
"about",
|
|
"keys",
|
|
]
|
|
|
|
CHOICES_SHORTHAND_MENUS = ["s", "e", "c", "p", "f", "rp", "rs"]
|
|
CHOICES_MENUS = [
|
|
"stocks",
|
|
"economy",
|
|
"crypto",
|
|
"portfolio",
|
|
"forex",
|
|
"etf",
|
|
"reports",
|
|
"resources",
|
|
]
|
|
|
|
CHOICES += CHOICES_COMMANDS
|
|
CHOICES += CHOICES_MENUS
|
|
CHOICES += CHOICES_SHORTHAND_MENUS
|
|
|
|
def __init__(self):
|
|
"""Constructor"""
|
|
self.update_succcess = False
|
|
self.t_parser = argparse.ArgumentParser(add_help=False, prog="terminal")
|
|
self.t_parser.add_argument(
|
|
"cmd",
|
|
choices=self.CHOICES,
|
|
)
|
|
self.completer = NestedCompleter.from_nested_dict(
|
|
{c: None for c in self.CHOICES}
|
|
)
|
|
|
|
def print_help(self):
|
|
"""Print help"""
|
|
help_text = """
|
|
What do you want to do?
|
|
cls clear screen
|
|
?/help show this menu again
|
|
update update terminal from remote
|
|
keys check for defined api keys
|
|
reset reset terminal and reload configs
|
|
about about us
|
|
q(uit) to abandon the program
|
|
|
|
>> stocks
|
|
>> crypto
|
|
>> etf
|
|
>> economy
|
|
>> forex
|
|
>> portfolio
|
|
>> reports
|
|
>> resources
|
|
"""
|
|
print(help_text)
|
|
|
|
def switch(self, an_input: str):
|
|
"""Process and dispatch input
|
|
|
|
Returns
|
|
-------
|
|
True, False or None
|
|
False - quit the menu
|
|
True - quit the program
|
|
None - continue in the menu
|
|
"""
|
|
|
|
# Empty command
|
|
if not an_input:
|
|
print("")
|
|
return None
|
|
|
|
(known_args, other_args) = self.t_parser.parse_known_args(an_input.split())
|
|
|
|
# Help menu again
|
|
if known_args.cmd == "?":
|
|
self.print_help()
|
|
return None
|
|
|
|
# Clear screen
|
|
if known_args.cmd == "cls":
|
|
system_clear()
|
|
return None
|
|
|
|
return getattr(
|
|
self, "call_" + known_args.cmd, lambda: "Command not recognized!"
|
|
)(other_args)
|
|
|
|
def call_help(self, _):
|
|
"""Process Help command"""
|
|
self.print_help()
|
|
|
|
def call_quit(self, _):
|
|
"""Process Quit command - quit the program"""
|
|
return True
|
|
|
|
def call_q(self, _):
|
|
"""Process Quit command - quit the program"""
|
|
return True
|
|
|
|
# COMMANDS
|
|
def call_reset(self, _):
|
|
"""Process reset command"""
|
|
return True
|
|
|
|
def call_update(self, _):
|
|
"""Process update command"""
|
|
self.update_succcess = not update_terminal()
|
|
return True
|
|
|
|
def call_keys(self, _):
|
|
"""Process keys command"""
|
|
check_api_keys()
|
|
|
|
def call_about(self, _):
|
|
"""Process about command"""
|
|
about_us()
|
|
|
|
# MENUS
|
|
def call_stocks(self, _):
|
|
"""Process stocks command"""
|
|
from gamestonk_terminal.stocks import stocks_controller
|
|
|
|
return stocks_controller.menu()
|
|
|
|
def call_s(self, _):
|
|
"""Process stocks command"""
|
|
return self.call_stocks(_)
|
|
|
|
def call_crypto(self, _):
|
|
"""Process crypto command"""
|
|
from gamestonk_terminal.cryptocurrency import crypto_controller
|
|
|
|
return crypto_controller.menu()
|
|
|
|
def call_c(self, _):
|
|
"""Process crypto command"""
|
|
return self.call_crypto(_)
|
|
|
|
def call_economy(self, _):
|
|
"""Process economy command"""
|
|
from gamestonk_terminal.economy import economy_controller
|
|
|
|
return economy_controller.menu()
|
|
|
|
def call_e(self, _):
|
|
"""Process economy command"""
|
|
return self.call_economy(_)
|
|
|
|
def call_etf(self, _):
|
|
"""Process etf command"""
|
|
from gamestonk_terminal.etf import etf_controller
|
|
|
|
return etf_controller.menu()
|
|
|
|
def call_forex(self, _):
|
|
"""Process forex command"""
|
|
from gamestonk_terminal.forex import forex_controller
|
|
|
|
return forex_controller.menu()
|
|
|
|
def call_f(self, _):
|
|
"""Process forex command"""
|
|
return self.call_forex(_)
|
|
|
|
def call_reports(self, _):
|
|
"""Process reports command"""
|
|
from gamestonk_terminal.reports import reports_controller
|
|
|
|
return reports_controller.menu()
|
|
|
|
def call_rp(self, _):
|
|
"""Process reports command"""
|
|
return self.call_reports(_)
|
|
|
|
def call_resources(self, _):
|
|
"""Process resources command"""
|
|
from gamestonk_terminal.resources import resources_controller
|
|
|
|
return resources_controller.menu()
|
|
|
|
def call_rs(self, _):
|
|
"""Process resources command"""
|
|
return self.call_resources(_)
|
|
|
|
def call_portfolio(self, _):
|
|
"""Process portfolio command"""
|
|
from gamestonk_terminal.portfolio import portfolio_controller
|
|
|
|
return portfolio_controller.menu()
|
|
|
|
def call_p(self, _):
|
|
"""Process portfolio command"""
|
|
return self.call_portfolio(_)
|
|
|
|
|
|
def terminal(menu_prior_to_reset=""):
|
|
"""Terminal Menu"""
|
|
|
|
bootup()
|
|
process_input = False
|
|
t_controller = TerminalController()
|
|
|
|
if config_terminal.DEFAULT_CONTEXT or menu_prior_to_reset:
|
|
if (
|
|
config_terminal.DEFAULT_CONTEXT in t_controller.CHOICES_MENUS
|
|
or menu_prior_to_reset in t_controller.CHOICES_MENUS
|
|
):
|
|
try:
|
|
print("")
|
|
process_input = t_controller.switch(
|
|
menu_prior_to_reset or config_terminal.DEFAULT_CONTEXT.lower()
|
|
)
|
|
# Check if the user wants to reset application
|
|
if process_input == MENU_RESET:
|
|
ret_code = reset(menu_prior_to_reset)
|
|
if ret_code != 0:
|
|
print_goodbye()
|
|
|
|
except SystemExit:
|
|
print("")
|
|
else:
|
|
print("\nInvalid DEFAULT_CONTEXT config selected!", "\n")
|
|
|
|
if process_input not in (MENU_QUIT, MENU_RESET):
|
|
t_controller.print_help()
|
|
|
|
while True:
|
|
if gtff.ENABLE_QUICK_EXIT:
|
|
print("Quick exit enabled")
|
|
break
|
|
|
|
if session and gtff.USE_PROMPT_TOOLKIT:
|
|
an_input = session.prompt(
|
|
f"{get_flair()}> ", completer=t_controller.completer
|
|
)
|
|
|
|
else:
|
|
an_input = input(f"{get_flair()}> ")
|
|
|
|
# Is command empty
|
|
if not an_input:
|
|
print("")
|
|
continue
|
|
|
|
# Process list of commands selected by user
|
|
try:
|
|
process_input = t_controller.switch(an_input)
|
|
# MENU_GO_BACK - Show main context menu again
|
|
# MENU_QUIT - Quit terminal
|
|
# MENU_RESET - Reset terminal and go back to same previous menu
|
|
|
|
if process_input == MENU_GO_BACK:
|
|
t_controller.print_help()
|
|
elif process_input in (MENU_QUIT, MENU_RESET):
|
|
break
|
|
|
|
except SystemExit:
|
|
print("The command selected doesn't exist\n")
|
|
similar_cmd = difflib.get_close_matches(
|
|
an_input, t_controller.CHOICES, n=1, cutoff=0.7
|
|
)
|
|
|
|
if similar_cmd:
|
|
print(f"Did you mean '{similar_cmd[0]}'?\n")
|
|
|
|
continue
|
|
|
|
if not gtff.ENABLE_QUICK_EXIT:
|
|
# Check if the user wants to reset application
|
|
if (
|
|
an_input == "reset"
|
|
or t_controller.update_succcess
|
|
or process_input == MENU_RESET
|
|
):
|
|
ret_code = reset(an_input if an_input != "reset" else "")
|
|
if ret_code != 0:
|
|
print_goodbye()
|
|
else:
|
|
print_goodbye()
|
|
else:
|
|
print_goodbye()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
if len(sys.argv) > 1:
|
|
terminal(sys.argv[1])
|
|
else:
|
|
terminal()
|