make-selection 1.0.7__tar.gz → 1.0.9__tar.gz

{make_selection-1.0.7 → make_selection-1.0.9}/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2024 Steve Frazee
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+Copyright (c) 2024 Steve Frazee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

{make_selection-1.0.7 → make_selection-1.0.9}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: make_selection
-Version: 1.0.7
+Version: 1.0.9
 Summary: Package for interactive command line menu
 Author-email: Steven Frazee <stevefrazee123@gmail.com>
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

{make_selection-1.0.7 → make_selection-1.0.9}/README.md

@@ -1,26 +1,26 @@
-<p align="center">
-  <img src="https://github.com/steve3424/make_selection/blob/main/images/logo.png?raw=true" alt="Make selection logo">
-</p>
-
-
-## Setup
-```
-pip install make_selection
-```
-
-## Example
-#### file.py
-```python
-from make_selection import makeSelection
-
-options = ["one", "two", "three"]
-label = "choose option"
-selected = makeSelection(options, label)
-```
-
-#### Interacting with menu
-<img src="https://github.com/steve3424/make_selection/blob/main/images/using_menu.png?raw=true" alt="image of cli while using the menu">
-<br>
-
-#### After making selection
-<img src="https://github.com/steve3424/make_selection/blob/main/images/item_selected.png?raw=true" alt="image of cli after item is selected">
+<p align="center">
+  <img src="https://github.com/steve3424/make_selection/blob/main/images/logo.png?raw=true" alt="Make selection logo">
+</p>
+
+
+## Setup
+```
+pip install make_selection
+```
+
+## Example
+#### file.py
+```python
+from make_selection import makeSelection
+
+options = ["one", "two", "three"]
+label = "choose option"
+selected = makeSelection(options, label)
+```
+
+#### Interacting with menu
+<img src="https://github.com/steve3424/make_selection/blob/main/images/using_menu.png?raw=true" alt="image of cli while using the menu">
+<br>
+
+#### After making selection
+<img src="https://github.com/steve3424/make_selection/blob/main/images/item_selected.png?raw=true" alt="image of cli after item is selected">

{make_selection-1.0.7 → make_selection-1.0.9}/pyproject.toml

@@ -1,15 +1,15 @@
-[project]
-name = "make_selection"
-version = "1.0.7"
-authors = [
-  { name="Steven Frazee", email="stevefrazee123@gmail.com" },
-]
-description = "Package for interactive command line menu"
-readme = "README.md"
-requires-python = ">=3.9"
-classifiers = [
-    "License :: OSI Approved :: MIT License",
-    "Development Status :: 4 - Beta",
-    "Programming Language :: Python :: 3.9",
-    "Operating System :: Microsoft :: Windows",
-]
+[project]
+name = "make_selection"
+version = "1.0.9"
+authors = [
+  { name="Steven Frazee", email="stevefrazee123@gmail.com" },
+]
+description = "Package for interactive command line menu"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: Microsoft :: Windows",
+]

make_selection-1.0.9/src/make_selection/key_codes.py

@@ -0,0 +1,10 @@
+from enum import Enum, auto
+
+class KeyCode(Enum):
+    UP           = auto()
+    DOWN         = auto()
+    SELECT       = auto()
+    SELECT_MULTI = auto()
+    CANCEL       = auto()
+    DELETE_CHAR  = auto()
+    SEARCHABLE   = auto()

{make_selection-1.0.7 → make_selection-1.0.9}/src/make_selection/make_selection.py

@@ -1,271 +1,288 @@
-"""
-Module for interactive command line menu. Simply accepts a list of str-able objects
-and allows user to select using arrow keys.
-
-Ansi escape codes are used as described here: https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
-"""
-# TODO: work on all platforms
-# TODO: multi_select: Maintain original index for re-insertion.
-# TODO: multi_select: TAB switches to delete mode.
-import sys
-if sys.platform != "win32":
-    raise NotImplementedError("This module is only available on Windows.")
-import msvcrt
-import ctypes
-from typing import Any
-from copy import copy
-from enum import Enum
-
-stdout = -11
-enable_ansi_codes = 7
-kernel32 = ctypes.windll.kernel32
-kernel32.SetConsoleMode(kernel32.GetStdHandle(stdout), enable_ansi_codes)
-
-ANSI_MOVE_CURSOR             = "\x1b[{up}F\r\x1b[{right}C"
-ANSI_HIGHLIGHT               = "\x1b[30;47m"
-ANSI_HIGHLIGHT_SEARCH_STRING = "\x1b[95;47m"
-ANSI_YELLOW                  = "\x1b[93m"
-ANSI_BLUE                    = "\x1b[94m"
-ANSI_MAGENTA                 = "\x1b[95m"
-ANSI_GREEN                   = "\x1b[92m"
-ANSI_RESET                   = "\x1b[0m"
-
-SPECIAL_KEY = 224
-UP_ARROW    = 72
-DOWN_ARROW  = 80
-ENTER_KEY   = 13
-CTL_C       = 3
-BACKSPACE   = 8
-SPACEBAR    = 32
-CTL_RIGHT   = 116
-
-class Mode(Enum):
-    NORMAL = 0
-    MULTI_SELECT = 1
-    MULTI_DELETE = 2
-
-class Option:
-    def __init__(self, obj: Any, sub_string_start: int=0) -> None:
-        self.value = obj
-        self.sub_string_start = sub_string_start
-
-class Menu:
-    def __init__(self, options: list, label: str, window_size: int=10, multi_select: bool=False) -> None:
-        assert options
-        assert label
-        assert 1 <= window_size and window_size <= 25
-        window_size = min((len(options)), window_size)
-
-        self.options_original = [Option(op) for op in options]
-        self.options_current = copy(self.options_original)
-        self.options_selected = []
-        self.search_string = ""
-        self.label = label
-        self.selected_index = 0
-        self.window_top = 0
-        self.window_size_original = window_size
-        self.window_size_current = window_size
-        self.help_string_multi_select = "Enter: Select, Ctl+C: Cancel, Ctl\u2192: Done"
-        self.help_string_normal = "Enter: Select, Ctl+C: Cancel"
-        if multi_select:
-            self.mode = Mode.MULTI_SELECT
-            self.help_string = self.help_string_multi_select
-        else:
-            self.mode = Mode.NORMAL
-            self.help_string = self.help_string_normal
-
-    def show(self):
-        self.printMenu()
-        while True:
-            something_changed = False
-            char = self.getChar()
-            if char == SPECIAL_KEY:
-                char = self.getChar()
-                if char == CTL_RIGHT:
-                    if self.mode == Mode.MULTI_SELECT:
-                        self.printSelected()
-                        return self.multiSelectGetValues(self.options_selected)
-                elif 1 < len(self.options_current):
-                    # NOTE: Update selected index
-                    if char == UP_ARROW:
-                        self.selected_index = (self.selected_index - 1) % len(self.options_current)
-                        something_changed = True
-                    elif char == DOWN_ARROW:
-                        self.selected_index = (self.selected_index + 1) % len(self.options_current)
-                        something_changed = True
-                
-                    # NOTE: Update window
-                    if something_changed:
-                        bottom = self.window_top + self.window_size_current
-                        if self.selected_index < self.window_top:
-                            self.window_top = self.selected_index
-                        elif bottom <= self.selected_index:
-                            self.window_top = self.selected_index - self.window_size_current + 1
-            elif self.isSearchableChar(char):
-                char = chr(char)
-                self.search_string = f"{self.search_string}{char}".lstrip()
-                if self.search_string:
-                    print(char, end="", flush=True, file=sys.stderr)
-                    self.search(self.options_current)
-                    something_changed = True
-            elif char == BACKSPACE and 0 < len(self.search_string):
-                self.search_string = self.search_string[:-1]
-                # NOTE: Move left once ([1D), print space, move left again
-                print("\x1b[1D \x1b[1D", end="", flush=True, file=sys.stderr)
-                self.search(self.options_original)
-                something_changed = True
-            elif char == ENTER_KEY and self.options_current:
-                if self.mode == Mode.MULTI_SELECT:
-                    self.multiSelectAdd()
-                    something_changed = True
-                elif self.mode == Mode.NORMAL:
-                    self.printSelected()
-                    return self.options_current[self.selected_index].value
-            elif char == CTL_C:
-                self.clearMenu()
-                print("cancelled", file=sys.stderr)
-                return None
-
-            if something_changed:
-                self.clearMenu()
-                self.printMenu()
-
-    def search(self, search_list: list) -> None:
-        found_options = []
-        for o in search_list:
-            found_i = str(o.value).lower().find(self.search_string.lower())
-            if found_i != -1:
-                o.sub_string_start = found_i
-                found_options.append(o)
-        self.options_current = found_options
-        self.resetWindow()
-
-    def multiSelectAdd(self) -> None:
-        selected_option = self.options_current[self.selected_index]
-        self.options_current.remove(selected_option)
-        self.options_original.remove(selected_option)
-        self.options_selected.append(selected_option)
-        self.resetWindowMultiSelect()
-
-    def multiSelectGetValues(self, options: list[Option]) -> list[Any]:
-        return [op.value for op in options]
-
-    def getChar(self) -> int:
-        return ord(msvcrt.getch())
-
-    def isSearchableChar(self, char):
-        return (32 <= char and char <= 126)
-    
-    def resetWindow(self):
-        self.window_top = 0
-        self.selected_index = 0
-        self.window_size_current = min((len(self.options_current), self.window_size_original))
-
-    def resetWindowMultiSelect(self):
-        """
-        After selecting item and shrinking the list we try would like to keep
-        the selected_index and window the same. This visually looks like the
-        list is being pulled up and the selected index goes to the next item.
-
-        First we will try and shift the window up, keeping the selected index
-        the same. Visually this looks a bit weird as the selected index looks
-        to be moving down the list, but the behavior I think is good because
-        the index goes to the next item in the list. If we kept the index static
-        on the screen it would be moving to the previous item instead of the next
-        which I don't think I want.
-
-        If we can't keep the list the same or shift the window up, that means the
-        list is too small and we will just shrink the window.
-        """
-        window_bottom_current = self.window_top + self.window_size_current
-        if len(self.options_current) < window_bottom_current:
-            if 0 < self.window_top:
-                self.window_top -= 1
-            else:
-                self.window_size_current -= 1
-            # NOTE: this must be calculated after we change top/size above
-            window_bottom_new = self.window_top + self.window_size_current
-            if window_bottom_new <= self.selected_index:
-                self.selected_index -= 1
-
-    def clearMenu(self):
-        """
-        Clears from beginning of current line to end of screen (not end of line).
-        This assumes the cursor is on the top line (label), which is currently always true.
-
-        [0G move cursor to column 0.
-        [J clears to end of screen (not end of line).
-        """
-        print("\x1b[0G\x1b[J", end="", flush=True, file=sys.stderr)
-
-    def printMenu(self):
-        header = f"{ANSI_BLUE}{self.label}>{ANSI_RESET}{self.search_string}"
-        header_num_lines = 1
-        if self.mode == Mode.MULTI_SELECT:
-            header += f"\n{ANSI_GREEN}{len(self.options_selected)} items selected!{ANSI_RESET}"
-            header_num_lines = 2
-        print(header, file=sys.stderr)
-
-        bottom = self.window_top + self.window_size_current
-        if not self.options_current:
-            print(f"{ANSI_BLUE}no matches found{ANSI_RESET}", file=sys.stderr)
-            # NOTE: window size is 0 here after empty search, but we are printing 1 line
-            #       so we need to set it so the footer prints correctly
-            self.window_size_current = 1
-        else:
-            for i in range(self.window_top, bottom):
-                option_to_print = str(self.options_current[i].value)
-                highlight_beg = self.options_current[i].sub_string_start
-                highlight_end = highlight_beg + len(self.search_string)
-                opt_beg = option_to_print[0 : highlight_beg]
-                opt_mid = option_to_print[highlight_beg : highlight_end]
-                opt_end = option_to_print[highlight_end :]
-                if i == self.selected_index:
-                    option_to_print = f"{ANSI_HIGHLIGHT}{opt_beg}{ANSI_HIGHLIGHT_SEARCH_STRING}{opt_mid}{ANSI_HIGHLIGHT}{opt_end}{ANSI_RESET}"
-                else:
-                    option_to_print = f"{opt_beg}{ANSI_MAGENTA}{opt_mid}{ANSI_RESET}{opt_end}"
-                print(option_to_print, file=sys.stderr)
-
-        footer = f"{ANSI_YELLOW}{self.help_string}{ANSI_RESET}\n"
-        footer_num_lines = 1
-        print(f"{footer}{ANSI_MOVE_CURSOR.format(up=self.window_size_current + header_num_lines + footer_num_lines, right=len(self.label) + len(self.search_string) + 1)}", end="", flush=True, file=sys.stderr)
-
-    def printSelected(self):
-        self.clearMenu()
-        if self.mode == Mode.MULTI_SELECT:
-            if len(self.options_selected) == 0:
-                print(f"{self.label}> (0 items) []", file=sys.stderr)
-            elif len(self.options_selected) == 1:
-                print(f"{self.label}> (1 item) {self.multiSelectGetValues(self.options_selected)}", file=sys.stderr)
-            else:
-                print(f"{self.label}> ({len(self.options_selected)} items) [{self.options_selected[0].value}, ...]", file=sys.stderr)
-        else:
-            print(f"{self.label}> {self.options_current[self.selected_index].value}", file=sys.stderr)
-
-def makeSelection(options: list[Any], label: str, window_size: int=None, multi_select: bool=False) -> Any:
-    """
-    Entry point for menu selection.
-
-    Parameters
-    ----------
-    options
-        List of str-able objects.
-    label
-        Label to describe the items being selected.
-    window_size
-        Max number of items to show at once.
-    multi_select
-        Select list of items.
-
-    Returns
-    -------
-    Selected value or list of selected values.
-    """
-    if window_size:
-       return Menu(options, label, window_size=window_size, multi_select=multi_select).show()
-    else:
-       return Menu(options, label, multi_select=multi_select).show()
-
-if __name__ == "__main__":
-    print(f"Returns: '{makeSelection(['interactive', 'cli', 'menu'], 'make_selection')}'", file=sys.stderr)
-    print(f"Returns: '{makeSelection(['interactive', 'cli', 'menu'], 'make_selection', multi_select=True)}'", file=sys.stderr)
+"""
+Module for interactive command line menu. Simply accepts a list of str-able objects
+and allows user to select using arrow keys.
+
+Ansi escape codes are used as described here: https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
+"""
+# TODO: multi_select: Maintain original index for re-insertion.
+# TODO: multi_select: TAB switches to delete mode.
+import sys
+if sys.platform == "win32":
+    from mappings.windows import getChar
+    multi_select_modifier_string = "Ctl"
+elif sys.platform == "darwin":
+    from mappings.mac import getChar
+    multi_select_modifier_string = "Cmd"
+else:
+    raise NotImplementedError(f"Platform '{sys.platform}' not supported!")
+from typing import Any
+from copy import copy
+from enum import Enum
+from key_codes import KeyCode
+
+ANSI_MOVE_CURSOR             = "\x1b[{up}F\r\x1b[{right}C"
+ANSI_HIGHLIGHT               = "\x1b[30;47m"
+ANSI_HIGHLIGHT_SEARCH_STRING = "\x1b[95;47m"
+ANSI_YELLOW                  = "\x1b[93m"
+ANSI_BLUE                    = "\x1b[94m"
+ANSI_MAGENTA                 = "\x1b[95m"
+ANSI_GREEN                   = "\x1b[92m"
+ANSI_RED                     = "\x1b[91m"
+ANSI_RESET                   = "\x1b[0m"
+
+class Mode(Enum):
+    NORMAL = 0
+    MULTI_SELECT = 1
+    MULTI_DELETE = 2
+
+class Option:
+    def __init__(self, obj: Any, sub_string_start: int=0) -> None:
+        self.value = obj
+        self.sub_string_start = sub_string_start
+
+class Menu:
+    def __init__(self, options: list, label: str, window_size: int=10, multi_select: bool=False) -> None:
+        assert options
+        assert label
+        assert 1 <= window_size and window_size <= 25
+        window_size = min((len(options)), window_size)
+
+        self.options_original = [Option(op) for op in options]
+        self.options_current = copy(self.options_original)
+        self.options_selected = []
+        self.search_string = ""
+        self.label = label
+        self.selected_index = 0
+        self.window_top = 0
+        self.window_size_original = window_size
+        self.window_size_current = window_size
+        self.help_string_multi_select = f"Enter: Select, Ctl+C: Cancel, {multi_select_modifier_string}\u2192: Done"
+        self.help_string_normal = "Enter: Select, Ctl+C: Cancel"
+        if multi_select:
+            self.mode = Mode.MULTI_SELECT
+            self.help_string = self.help_string_multi_select
+        else:
+            self.mode = Mode.NORMAL
+            self.help_string = self.help_string_normal
+
+    def show(self):
+        self.printMenu()
+        while True:
+            something_changed = False
+            key_code, char = getChar()
+            if key_code in (KeyCode.UP, KeyCode.DOWN) and 1 < len(self.options_current):
+                window_shift = 1 if key_code == KeyCode.DOWN else -1
+                self.selected_index = (self.selected_index + window_shift) % len(self.options_current)
+                bottom = self.window_top + self.window_size_current
+                if self.selected_index < self.window_top:
+                    self.window_top = self.selected_index
+                elif bottom <= self.selected_index:
+                    self.window_top = self.selected_index - self.window_size_current + 1
+                something_changed = True
+            elif key_code == KeyCode.SELECT and self.options_current:
+                if self.mode == Mode.MULTI_SELECT:
+                    self.multiSelectAdd()
+                    something_changed = True
+                elif self.mode == Mode.NORMAL:
+                    self.printSelected()
+                    return self.options_current[self.selected_index].value
+            elif key_code == KeyCode.SEARCHABLE:
+                self.search_string = f"{self.search_string}{char}".lstrip()
+                if self.search_string:
+                    print(char, end="", flush=True, file=sys.stderr)
+                    self.search(self.options_current)
+                    something_changed = True
+            elif key_code == KeyCode.DELETE_CHAR and 0 < len(self.search_string):
+                self.search_string = self.search_string[:-1]
+                # NOTE: Move left once ([1D), print space, move left again
+                print("\x1b[1D \x1b[1D", end="", flush=True, file=sys.stderr)
+                self.search(self.options_original)
+                something_changed = True
+            elif key_code == KeyCode.CANCEL:
+                self.clearMenu()
+                print("cancelled", file=sys.stderr)
+                return None
+            elif key_code == KeyCode.SELECT_MULTI and self.mode == Mode.MULTI_SELECT:
+                    self.printSelected()
+                    return self.multiSelectGetValues(self.options_selected)
+
+            if something_changed:
+                self.clearMenu()
+                self.printMenu()
+
+    def search(self, search_list: list) -> None:
+        found_options = []
+        for o in search_list:
+            found_i = str(o.value).lower().find(self.search_string.lower())
+            if found_i != -1:
+                o.sub_string_start = found_i
+                found_options.append(o)
+        self.options_current = found_options
+        self.resetWindow()
+
+    def multiSelectAdd(self) -> None:
+        selected_option = self.options_current[self.selected_index]
+        self.options_current.remove(selected_option)
+        self.options_original.remove(selected_option)
+        self.options_selected.append(selected_option)
+        self.resetWindowMultiSelect()
+
+    def multiSelectGetValues(self, options: list[Option]) -> list[Any]:
+        return [op.value for op in options]
+
+    def resetWindow(self):
+        self.window_top = 0
+        self.selected_index = 0
+        self.window_size_current = min((len(self.options_current), self.window_size_original))
+
+    def resetWindowMultiSelect(self):
+        """
+        After selecting item and shrinking the list we try would like to keep
+        the selected_index and window the same. This visually looks like the
+        list is being pulled up and the selected index goes to the next item.
+
+        First we will try and shift the window up, keeping the selected index
+        the same. Visually this looks a bit weird as the selected index looks
+        to be moving down the list, but the behavior I think is good because
+        the index goes to the next item in the list. If we kept the index static
+        on the screen it would be moving to the previous item instead of the next
+        which I don't think I want.
+
+        If we can't keep the list the same or shift the window up, that means the
+        list is too small and we will just shrink the window.
+        """
+        window_bottom_current = self.window_top + self.window_size_current
+        if len(self.options_current) < window_bottom_current:
+            if 0 < self.window_top:
+                self.window_top -= 1
+            else:
+                self.window_size_current -= 1
+            # NOTE: this must be calculated after we change top/size above
+            window_bottom_new = self.window_top + self.window_size_current
+            if window_bottom_new <= self.selected_index:
+                self.selected_index -= 1
+
+    def clearMenu(self):
+        """
+        Clears from beginning of current line to end of screen (not end of line).
+        This assumes the cursor is on the top line (label), which is currently always true.
+
+        [0G move cursor to column 0.
+        [J clears to end of screen (not end of line).
+        """
+        print("\x1b[0G\x1b[J", end="", flush=True, file=sys.stderr)
+
+    def printMenu(self):
+        header = f"{ANSI_BLUE}{self.label}>{ANSI_RESET}{self.search_string}"
+        header_num_lines = 1
+        if self.mode == Mode.MULTI_SELECT:
+            header += f"\n{ANSI_GREEN}{len(self.options_selected)} items selected!{ANSI_RESET}"
+            header_num_lines = 2
+        print(header, file=sys.stderr)
+
+        bottom = self.window_top + self.window_size_current
+        if not self.options_current:
+            print(f"{ANSI_BLUE}no matches found{ANSI_RESET}", file=sys.stderr)
+            # NOTE: window size is 0 here after empty search, but we are printing 1 line
+            #       so we need to set it so the footer prints correctly
+            self.window_size_current = 1
+        else:
+            for i in range(self.window_top, bottom):
+                option_to_print = str(self.options_current[i].value)
+                highlight_beg = self.options_current[i].sub_string_start
+                highlight_end = highlight_beg + len(self.search_string)
+                opt_beg = option_to_print[0 : highlight_beg]
+                opt_mid = option_to_print[highlight_beg : highlight_end]
+                opt_end = option_to_print[highlight_end :]
+                if i == self.selected_index:
+                    option_to_print = f"{ANSI_HIGHLIGHT}{opt_beg}{ANSI_HIGHLIGHT_SEARCH_STRING}{opt_mid}{ANSI_HIGHLIGHT}{opt_end}{ANSI_RESET}"
+                else:
+                    option_to_print = f"{opt_beg}{ANSI_MAGENTA}{opt_mid}{ANSI_RESET}{opt_end}"
+                print(option_to_print, file=sys.stderr)
+
+        footer = f"{ANSI_YELLOW}{self.help_string}{ANSI_RESET}\n"
+        footer_num_lines = 1
+        print(f"{footer}{ANSI_MOVE_CURSOR.format(up=self.window_size_current + header_num_lines + footer_num_lines, right=len(self.label) + len(self.search_string) + 1)}", end="", flush=True, file=sys.stderr)
+
+    def printSelected(self):
+        self.clearMenu()
+        if self.mode == Mode.MULTI_SELECT:
+            if len(self.options_selected) == 0:
+                print(f"{self.label}> (0 items) []", file=sys.stderr)
+            elif len(self.options_selected) == 1:
+                print(f"{self.label}> (1 item) {self.multiSelectGetValues(self.options_selected)}", file=sys.stderr)
+            else:
+                print(f"{self.label}> ({len(self.options_selected)} items) [{self.options_selected[0].value}, ...]", file=sys.stderr)
+        else:
+            print(f"{self.label}> {self.options_current[self.selected_index].value}", file=sys.stderr)
+
+def makeSelection(options: list[Any], label: str, window_size: int=None, multi_select: bool=False) -> Any:
+    """
+    Entry point for menu selection.
+
+    Parameters
+    ----------
+    options
+        List of str-able objects.
+    label
+        Label to describe the items being selected.
+    window_size
+        Max number of items to show at once.
+    multi_select
+        Select list of items.
+
+    Returns
+    -------
+    Selected value or list of selected values.
+    """
+    if window_size:
+       return Menu(options, label, window_size=window_size, multi_select=multi_select).show()
+    else:
+       return Menu(options, label, multi_select=multi_select).show()
+
+if __name__ == "__main__":
+    import argparse
+    def showcase():
+        print(f"Returns: '{makeSelection(['interactive', 'cli', 'menu'], 'make_selection')}'", file=sys.stderr)
+        print(f"Returns: '{makeSelection(['interactive', 'cli', 'menu'], 'make_selection', multi_select=True)}'", file=sys.stderr)
+    
+    def test_input():
+        print(f"{ANSI_YELLOW}Testing keyboard interactively!{ANSI_RESET}")
+        test_cases = [
+            ("Press up arrow \u2191",    (KeyCode.UP, None)),
+            ("Press down arrow \u2193",  (KeyCode.DOWN, None)),
+            ("Press right arrow \u2192", (None, None)),
+            ("Press left arrow \u2190",  (None, None)),
+            ("Press enter \u21B5",       (KeyCode.SELECT, None)),
+            (f"Press {multi_select_modifier_string}+right", (KeyCode.SELECT_MULTI, None)),
+            ("Press backspace \u232b",   (KeyCode.DELETE_CHAR, None)),
+            ("Press lowercase a",        (KeyCode.SEARCHABLE, 'a')),
+            ("Press uppercase A",        (KeyCode.SEARCHABLE, 'A')),
+            ("Press number 7",           (KeyCode.SEARCHABLE, '7')),
+            ("Press pound #",            (KeyCode.SEARCHABLE, '#')),
+            ("Press ctl+c",              (KeyCode.CANCEL, None)),
+        ]
+        num_errors = 0
+        for msg, expected in test_cases:
+            print(msg, end="", flush=True)
+            if getChar() == expected:
+                print(" [\u2705]")
+            else:
+                num_errors += 1
+                print(" [\u274C]")
+        if num_errors == 0:
+            print(f"{ANSI_GREEN}Working :){ANSI_RESET}")
+        else:
+            print(f"{ANSI_RED}not working :({ANSI_RESET}")
+
+    arg_parser = argparse.ArgumentParser(description="Interactive testing.")
+    sub_parsers = arg_parser.add_subparsers(required=True)
+
+    arg_parser_showcase = sub_parsers.add_parser("showcase", help="Interactive example.", formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    arg_parser_showcase.set_defaults(func=showcase)
+
+    arg_parser_test_keys = sub_parsers.add_parser("test_keys", help="Test keyboard input.", formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    arg_parser_test_keys.set_defaults(func=test_input)
+
+    args_main = arg_parser.parse_args()
+    args_main.func()

make_selection-1.0.9/src/make_selection/mappings/mac.py

@@ -0,0 +1,51 @@
+import os
+import sys
+import termios
+import tty
+from key_codes import KeyCode
+
+ARROW_UP   = b"\x1b[A"
+ARROW_DOWN = b"\x1b[B"
+CMD_RIGHT  = b"\x05"
+CTL_C      = b"\x03"
+ENTER_PATTERNS     = b"\r\n"
+BACKSPACE_PATTERNS = b"\x08\x7f"
+
+def _is_searchable(key_press: bytes) -> bool:
+    try:
+        key_press = ord(key_press.decode())
+        return (32 <= key_press and key_press <= 126)
+    except:
+        return False
+
+def _read_key_press() -> bytes:
+    try:
+        fd = sys.stdin.fileno()
+        old_settings = termios.tcgetattr(fd)
+        tty.setraw(fd)
+        # NOTE: Read up to 3 bytes for escape sequences.
+        return os.read(fd, 3)
+    finally:
+        termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
+
+def getChar() -> tuple[KeyCode|None, str|None]:
+    key_press: bytes = _read_key_press()
+
+    key_code = None
+    char = None
+    if key_press == ARROW_UP:
+        key_code = KeyCode.UP
+    elif key_press == ARROW_DOWN:
+        key_code = KeyCode.DOWN
+    elif key_press in ENTER_PATTERNS:
+        key_code = KeyCode.SELECT
+    elif key_press == CMD_RIGHT:
+        key_code = KeyCode.SELECT_MULTI
+    elif key_press == CTL_C:
+        key_code = KeyCode.CANCEL
+    elif key_press in BACKSPACE_PATTERNS:
+        key_code = KeyCode.DELETE_CHAR
+    elif _is_searchable(key_press):
+        key_code = KeyCode.SEARCHABLE
+        char = key_press.decode()
+    return key_code, char

make_selection-1.0.9/src/make_selection/mappings/windows.py

@@ -0,0 +1,43 @@
+import msvcrt
+import ctypes
+from key_codes import KeyCode
+
+stdout = -11
+enable_ansi_codes = 7
+kernel32 = ctypes.windll.kernel32
+kernel32.SetConsoleMode(kernel32.GetStdHandle(stdout), enable_ansi_codes)
+
+SPECIAL_KEY = 224
+ARROW_UP    = 72
+ARROW_DOWN  = 80
+ENTER       = 13
+CTL_C       = 3
+CTL_RIGHT   = 116
+BACKSPACE   = 8
+
+def isSearchable(char: int) -> bool:
+    return (32 <= char and char <= 126)
+    
+def getChar() -> tuple[KeyCode|None, str|None]:
+    key_code = None
+    char = None
+
+    key_press = ord(msvcrt.getch())
+    if key_press == SPECIAL_KEY:
+        key_press = ord(msvcrt.getch())
+        if key_press == ARROW_UP:
+            key_code = KeyCode.UP
+        elif key_press == ARROW_DOWN:
+            key_code = KeyCode.DOWN
+        elif key_press == CTL_RIGHT:
+            key_code = KeyCode.SELECT_MULTI
+    elif key_press == ENTER:
+        key_code = KeyCode.SELECT
+    elif key_press == CTL_C:
+        key_code = KeyCode.CANCEL
+    elif key_press == BACKSPACE:
+        key_code = KeyCode.DELETE_CHAR
+    elif isSearchable(key_press):
+        key_code = KeyCode.SEARCHABLE
+        char = chr(key_press)
+    return key_code, char

{make_selection-1.0.7 → make_selection-1.0.9}/src/make_selection.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: make_selection
-Version: 1.0.7
+Version: 1.0.9
 Summary: Package for interactive command line menu
 Author-email: Steven Frazee <stevefrazee123@gmail.com>
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

{make_selection-1.0.7 → make_selection-1.0.9}/src/make_selection.egg-info/SOURCES.txt

@@ -2,8 +2,12 @@ LICENSE
 README.md
 pyproject.toml
 src/make_selection/__init__.py
+src/make_selection/key_codes.py
 src/make_selection/make_selection.py
 src/make_selection.egg-info/PKG-INFO
 src/make_selection.egg-info/SOURCES.txt
 src/make_selection.egg-info/dependency_links.txt
-src/make_selection.egg-info/top_level.txt
+src/make_selection.egg-info/top_level.txt
+src/make_selection/mappings/mac.py
+src/make_selection/mappings/windows.py
+test/test_windows.py

make_selection-1.0.9/test/test_windows.py

@@ -0,0 +1,62 @@
+import sys
+import os
+sys.path.append(os.path.dirname(os.path.realpath(__file__)) + "/../src/make_selection")
+
+import unittest
+import mappings.windows as windows
+from key_codes import KeyCode
+from unittest.mock import patch, MagicMock
+
+
+class TestWindowsMappings(unittest.TestCase):
+    @patch("msvcrt.getch")
+    def test_up(self, getch_mock: MagicMock):
+        getch_mock.side_effect = [chr(windows.SPECIAL_KEY), chr(windows.ARROW_UP)]
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.UP)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch")
+    def test_down(self, getch_mock: MagicMock):
+        getch_mock.side_effect = [chr(windows.SPECIAL_KEY), chr(windows.ARROW_DOWN)]
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.DOWN)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch")
+    def test_select_multi(self, getch_mock: MagicMock):
+        getch_mock.side_effect = [chr(windows.SPECIAL_KEY), chr(windows.CTL_RIGHT)]
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.SELECT_MULTI)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch", return_value=chr(windows.ENTER))
+    def test_select(self, getch_mock: MagicMock):
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.SELECT)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch", return_value=chr(windows.CTL_C))
+    def test_cancel(self, getch_mock: MagicMock):
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.CANCEL)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch", return_value=chr(windows.BACKSPACE))
+    def test_delete_char(self, getch_mock: MagicMock):
+        key_code, char = windows.getChar()
+        self.assertEqual(key_code, KeyCode.DELETE_CHAR)
+        self.assertEqual(char, None)
+
+    @patch("msvcrt.getch")
+    def test_searchables(self, getch_mock: MagicMock):
+        test_cases = [chr(i) for i in range(32, 127)]
+        for expected_char in test_cases:
+            getch_mock.return_value = expected_char
+            with self.subTest(value=expected_char):
+                key_code, char = windows.getChar()
+                self.assertEqual(key_code, KeyCode.SEARCHABLE)
+                self.assertEqual(char, expected_char)
+
+if __name__ == '__main__':
+    unittest.main()