Add option to pass in existing screen.

Fixes #91

README.md

@@ -36,6 +36,7 @@
 - `indicator`: (optional) custom the selection indicator, defaults to `*`
 - `default_index`: (optional) index of item where cursor starts at by default
 - `handle_all`: (optional) define whether it is mandatory to assign all options to groups, defaults to `False`
+- `screen`: (optional), if you are using `pick` within an existing curses application set this to your existing `screen` object. It is assumed this has initialised in the standard way (e.g. via `curses.wrapper()`, or `curses.noecho(); curses.cbreak(); screen.kepad(True)`)
 
 ## Community Projects
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "groupick"
-version = "1.0.0"
+version = "1.1.0"
 description = "Assign options to groups in the terminal with a simple GUI. Based on wong2's pick"
 authors = ["Ana <[email protected]>", "wong2 <[email protected]>"]
 license = "MIT"

src/groupick/__init__.py

@@ -29,6 +29,7 @@ class Picker(Generic[OPTION_T]):
     handle_all: bool = False
     selected_indexes: Dict[str,List[int]] = field(init=False, default_factory=dict)
     index: int = field(init=False, default=0)
+    screen: Optional["curses._CursesWindow"] = None
 
     def __post_init__(self) -> None:
         if len(self.options) == 0:
@@ -118,7 +119,7 @@ def get_lines(self) -> Tuple[List, int]:
         current_line = self.index + len(title_lines) + 1
         return lines, current_line
 
-    def draw(self, screen) -> None:
+    def draw(self, screen: "curses._CursesWindow") -> None:
         """draw the curses ui on the screen, handle scroll if needed"""
         screen.clear()
 
@@ -141,7 +142,7 @@ def draw(self, screen) -> None:
 
         screen.refresh()
 
-    def run_loop(self, screen) -> Optional[Dict[str, List[PICK_RETURN_T]]]:
+    def run_loop(self, screen: "curses._CursesWindow") -> Optional[Dict[str, List[PICK_RETURN_T]]]:
         KEYS_ENTER = (curses.KEY_ENTER, ord("\n"), ord("\r"))
         KEYS_UP = (curses.KEY_UP, ord("k"))
         KEYS_DOWN = (curses.KEY_DOWN, ord("j"))
@@ -179,11 +180,19 @@ def config_curses(self) -> None:
             # Curses failed to initialize color support, eg. when TERM=vt100
             curses.initscr()
 
-    def _start(self, screen):
+    def _start(self, screen: "curses._CursesWindow"):
         self.config_curses()
         return self.run_loop(screen)
 
     def start(self):
+        if self.screen:
+            # Given an existing screen
+            # don't make any lasting changes
+            last_cur = curses.curs_set(0)
+            ret = self.run_loop(self.screen)
+            if last_cur:
+                curses.curs_set(last_cur)
+            return ret
         return curses.wrapper(self._start)
 
 
@@ -194,6 +203,7 @@ def groupick(
     indicator: str = "*",
     default_index: int = 0,
     handle_all: bool = False,
+    screen: Optional["curses._CursesWindow"] = None,
 ):
     picker: Picker = Picker(
         options,
@@ -202,5 +212,6 @@ def groupick(
         indicator,
         default_index,
         handle_all,
+        screen,
     )
     return picker.start()