Update console-menu stubs for v0.8 (#9845)

This commit is contained in:
Alex Waygood
2023-03-06 17:25:37 +00:00
committed by GitHub
parent 635493a8f6
commit 4118b5fc6e
6 changed files with 30 additions and 6 deletions

View File

@@ -1 +1 @@
version = "0.7.*"
version = "0.8.*"

View File

@@ -34,6 +34,7 @@ class ConsoleMenu:
clear_screen: bool = ...,
show_exit_option: bool = ...,
exit_option_text: str = ...,
exit_menu_char: str | None = None,
) -> None: ...
@property
def current_item(self) -> MenuItem | None: ...
@@ -71,7 +72,14 @@ class MenuItem:
menu: ConsoleMenu | None
should_exit: bool
index_item_separator: str
def __init__(self, text: str | Callable[[], str], menu: ConsoleMenu | None = ..., should_exit: bool = ...) -> None: ...
menu_char: str | None
def __init__(
self,
text: str | Callable[[], str],
menu: ConsoleMenu | None = None,
should_exit: bool = False,
menu_char: str | None = None,
) -> None: ...
def show(self, index: int) -> str: ...
def set_up(self) -> None: ...
def action(self) -> None: ...
@@ -81,7 +89,9 @@ class MenuItem:
def get_text(self) -> str: ...
class ExitItem(MenuItem):
def __init__(self, text: str | Callable[[], str] = ..., menu: ConsoleMenu | None = ...) -> None: ...
def __init__(
self, text: str | Callable[[], str] = "Exit", menu: ConsoleMenu | None = None, menu_char: str | None = None
) -> None: ...
def show(self, index: int, available_width: None = ...) -> str: ...
def clear_terminal() -> None: ...

View File

@@ -6,7 +6,13 @@ class CommandItem(ExternalItem):
arguments: list[str]
exit_status: int | None
def __init__(
self, text: str, command: str, arguments: list[str] | None = ..., menu: ConsoleMenu | None = ..., should_exit: bool = ...
self,
text: str,
command: str,
arguments: list[str] | None = None,
menu: ConsoleMenu | None = None,
should_exit: bool = False,
menu_char: str | None = None,
) -> None: ...
def action(self) -> None: ...
def get_return(self) -> int: ...

View File

@@ -18,6 +18,7 @@ class FunctionItem(ExternalItem):
kwargs: Mapping[str, Any] | None = ...,
menu: ConsoleMenu | None = ...,
should_exit: bool = ...,
menu_char: str | None = None,
) -> None: ...
def action(self) -> None: ...
def clean_up(self) -> None: ...

View File

@@ -5,5 +5,7 @@ from consolemenu.items import MenuItem as MenuItem
class SelectionItem(MenuItem):
index: int
def __init__(self, text: str | Callable[[], str], index: int, menu: ConsoleMenu | None = ...) -> None: ...
def __init__(
self, text: str | Callable[[], str], index: int, menu: ConsoleMenu | None = None, menu_char: str | None = None
) -> None: ...
def get_return(self) -> int: ...

View File

@@ -6,7 +6,12 @@ from consolemenu.items import MenuItem as MenuItem
class SubmenuItem(MenuItem):
submenu: ConsoleMenu
def __init__(
self, text: str | Callable[[], str], submenu: ConsoleMenu, menu: ConsoleMenu | None = ..., should_exit: bool = ...
self,
text: str | Callable[[], str],
submenu: ConsoleMenu,
menu: ConsoleMenu | None = None,
should_exit: bool = False,
menu_char: str | None = None,
) -> None: ...
menu: ConsoleMenu
def set_menu(self, menu: ConsoleMenu) -> None: ...