Apache Solr open-source search software
SOLR-15920 ReleaseWizard - Upgrade 'consolemenu' dependency to v0.7.1 (#1020)
Jan Høydahldfc41eb1710d
diff --git a/dev-tools/scripts/releaseWizard.py b/dev-tools/scripts/releaseWizard.pyindex 1db3fb17f1f..e149412a92b 100755--- a/dev-tools/scripts/releaseWizard.py+++ b/dev-tools/scripts/releaseWizard.py@@ -63,7 +63,6 @@ except:import scriptutilfrom consolemenu import ConsoleMenufrom consolemenu.items import FunctionItem, SubmenuItem, ExitItem-from consolemenu.screen import Screenfrom scriptutil import BranchType, Version, download, run# Solr-to-Java version mapping@@ -675,8 +674,8 @@ class TodoGroup(SecretYamlObject):return "%s%s (%d/%d)" % (prefix, self.title, self.num_done(), self.num_applies())def get_submenu(self):- menu = UpdatableConsoleMenu(title=self.title, subtitle=self.get_subtitle, prologue_text=self.get_description(),- screen=MyScreen())+ menu = ConsoleMenu(title=self.title, subtitle=self.get_subtitle, prologue_text=self.get_description(),+ clear_screen=False)menu.exit_item = CustomExitItem("Return")for todo in self.get_todos():if todo.applies(state.release_type):@@ -684,7 +683,7 @@ class TodoGroup(SecretYamlObject):return menudef get_menu_item(self):- item = UpdatableSubmenuItem(self.get_title, self.get_submenu())+ item = SubmenuItem(self.get_title, self.get_submenu())return itemdef get_todos(self):@@ -841,7 +840,7 @@ class Todo(SecretYamlObject):print("ERROR while executing todo %s (%s)" % (self.get_title(), e))def get_menu_item(self):- return UpdatableFunctionItem(self.get_title, self.display_and_confirm)+ return FunctionItem(self.get_title, self.display_and_confirm)def clone(self):clone = Todo(self.id, self.title, description=self.description)@@ -1255,104 +1254,6 @@ def pause(fun=None):input("\nPress ENTER to continue...")-# Custom classes for ConsoleMenu, to make menu texts dynamic-# Needed until https://github.com/aegirhall/console-menu/pull/25 is released-# See https://pypi.org/project/console-menu/ for other docs--class UpdatableConsoleMenu(ConsoleMenu):-- def __repr__(self):- return "%s: %s. %d items" % (self.get_title(), self.get_subtitle(), len(self.items))-- def draw(self):- """- Refreshes the screen and redraws the menu. Should be called whenever something changes that needs to be redrawn.- """- self.screen.printf(self.formatter.format(title=self.get_title(), subtitle=self.get_subtitle(), items=self.items,- prologue_text=self.get_prologue_text(), epilogue_text=self.get_epilogue_text()))-- # Getters to get text in case method reference- def get_title(self):- return self.title() if callable(self.title) else self.title-- def get_subtitle(self):- return self.subtitle() if callable(self.subtitle) else self.subtitle-- def get_prologue_text(self):- return self.prologue_text() if callable(self.prologue_text) else self.prologue_text-- def get_epilogue_text(self):- return self.epilogue_text() if callable(self.epilogue_text) else self.epilogue_text---class UpdatableSubmenuItem(SubmenuItem):- def __init__(self, text, submenu, menu=None, should_exit=False):- """- :ivar ConsoleMenu self.submenu: The submenu to be opened when this item is selected- """- super(UpdatableSubmenuItem, self).__init__(text=text, menu=menu, should_exit=should_exit, submenu=submenu)-- if menu:- self.get_submenu().parent = menu-- def show(self, index):- return "%2d - %s" % (index + 1, self.get_text())-- # Getters to get text in case method reference- def get_text(self):- return self.text() if callable(self.text) else self.text-- def set_menu(self, menu):- """- Sets the menu of this item.- Should be used instead of directly accessing the menu attribute for this class.-- :param ConsoleMenu menu: the menu- """- self.menu = menu- self.get_submenu().parent = menu-- def action(self):- """- This class overrides this method- """- self.get_submenu().start()-- def clean_up(self):- """- This class overrides this method- """- self.get_submenu().join()- self.menu.clear_screen()- self.menu.resume()-- def get_return(self):- """- :return: The returned value in the submenu- """- return self.get_submenu().returned_value-- def get_submenu(self):- """- We unwrap the submenu variable in case it is a reference to a method that returns a submenu- """- return self.submenu if not callable(self.submenu) else self.submenu()---class UpdatableFunctionItem(FunctionItem):- def show(self, index):- return "%2d - %s" % (index + 1, self.get_text())-- # Getters to get text in case method reference- def get_text(self):- return self.text() if callable(self.text) else self.text---class MyScreen(Screen):- def clear(self):- return--class CustomExitItem(ExitItem):def show(self, index):return super(CustomExitItem, self).show(index)@@ -1367,6 +1268,13 @@ def main():global templatesprint("Solr releaseWizard v%s" % getScriptVersion())++ try:+ ConsoleMenu(clear_screen=True)+ except Exception as e:+ sys.exit("You need to install 'consolemenu' package version 0.7.1 for the Wizard to function. Please run 'pip "+ "install -r requirements.txt'")+c = parse_config()if c.dry:@@ -1422,18 +1330,18 @@ def main():solr_news_file = os.path.join(state.get_website_git_folder(), 'content', 'solr', 'solr_news',"%s-%s-available.md" % (state.get_release_date_iso(), state.release_version.replace(".", "-")))- main_menu = UpdatableConsoleMenu(title="Solr ReleaseWizard",+ main_menu = ConsoleMenu(title="Solr ReleaseWizard",subtitle=get_releasing_text,prologue_text="Welcome to the release wizard. From here you can manage the process including creating new RCs. ""All changes are persisted, so you can exit any time and continue later. Make sure to read the Help section.",epilogue_text="® 2022 The Solr project. Licensed under the Apache License 2.0\nScript version v%s)" % getScriptVersion(),- screen=MyScreen())+ clear_screen=False)- todo_menu = UpdatableConsoleMenu(title=get_releasing_text,+ todo_menu = ConsoleMenu(title=get_releasing_text,subtitle=get_subtitle,prologue_text=None,epilogue_text=None,- screen=MyScreen())+ clear_screen=False)todo_menu.exit_item = CustomExitItem("Return")for todo_group in state.todo_groups:@@ -1442,14 +1350,14 @@ def main():menu_item.set_menu(todo_menu)todo_menu.append_item(menu_item)- main_menu.append_item(UpdatableSubmenuItem(get_todo_menuitem_title, todo_menu, menu=main_menu))- main_menu.append_item(UpdatableFunctionItem(get_start_new_rc_menu_title, start_new_rc))- main_menu.append_item(UpdatableFunctionItem('Clear and restart current RC', state.clear_rc))- main_menu.append_item(UpdatableFunctionItem("Clear all state, restart the %s release" % state.release_version, reset_state))- main_menu.append_item(UpdatableFunctionItem('Start release for a different version', release_other_version))- main_menu.append_item(UpdatableFunctionItem('Generate Asciidoc guide for this release', generate_asciidoc))- # main_menu.append_item(UpdatableFunctionItem('Dump YAML', dump_yaml))- main_menu.append_item(UpdatableFunctionItem('Help', help))+ main_menu.append_item(SubmenuItem(get_todo_menuitem_title, todo_menu, menu=main_menu))+ main_menu.append_item(FunctionItem(get_start_new_rc_menu_title, start_new_rc))+ main_menu.append_item(FunctionItem('Clear and restart current RC', state.clear_rc))+ main_menu.append_item(FunctionItem("Clear all state, restart the %s release" % state.release_version, reset_state))+ main_menu.append_item(FunctionItem('Start release for a different version', release_other_version))+ main_menu.append_item(FunctionItem('Generate Asciidoc guide for this release', generate_asciidoc))+ # main_menu.append_item(FunctionItem('Dump YAML', dump_yaml))+ main_menu.append_item(FunctionItem('Help', help))main_menu.show()diff --git a/dev-tools/scripts/requirements.txt b/dev-tools/scripts/requirements.txtindex 20715e7bfe4..0617ad153f5 100644--- a/dev-tools/scripts/requirements.txt+++ b/dev-tools/scripts/requirements.txt@@ -1,8 +1,8 @@-six>=1.11.0-Jinja2>=2.10.1-PyYAML>=5.1-holidays>=0.9.10-ics>=0.4-console-menu==0.5.1-PyGithub-jira\ No newline at end of file+six~=1.16.0+Jinja2~=3.1.1+PyYAML~=6.0+holidays~=0.16+ics~=0.7.2+console-menu~=0.7.1+PyGithub~=1.56+jira~=3.4.1\ No newline at end of file