Projects/worblehat
4
1
Fork 0
Code Issues 12 Pull Requests Activity

cli: replace prompt_utils with libdib

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2025-03-19 13:39:54 +01:00
parent 22481da4fa
commit d3bb47036c
8 changed files with 114 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/worblehat/cli/main.py
View File

@@ -6,6 +6,12 @@ from sqlalchemy import (
)
from sqlalchemy.orm import Session
from libdib.repl import (
NumberedCmd,
InteractiveItemSelector,
prompt_yes_no,
)
from worblehat.services import (
create_bookcase_item_from_isbn,
is_valid_isbn,
@@ -13,7 +19,6 @@ from worblehat.services import (
from worblehat.models import *
from .prompt_utils import *
from .subclis import (
AdvancedOptionsCli,
BookcaseItemCli,
@@ -268,4 +273,4 @@ class WorblehatCli(NumberedCmd):
'f': do_exit,
'doc': 'Exit',
},
}
}

213
src/worblehat/cli/prompt_utils.py
View File

@@ -1,213 +0,0 @@
from cmd import Cmd
from datetime import datetime
from typing import Any, Callable
from sqlalchemy import select
from sqlalchemy.orm import Session
def prompt_yes_no(question: str, default: bool | None = None) -> bool:
prompt = {
None: '[y/n]',
True: '[Y/n]',
False: '[y/N]',
}[default]
while not any([
(answer := input(f'{question} {prompt} ').lower()) in ('y','n'),
(default != None and answer.strip() == '')
]):
pass
return {
'y': True,
'n': False,
'': default,
}[answer]
def format_date(date: datetime):
return date.strftime("%a %b %d, %Y")
class InteractiveItemSelector(Cmd):
def __init__(
self,
cls: type,
sql_session: Session,
execute_selection: Callable[[Session, type, str], list[Any]] = lambda session, cls, arg: session.scalars(
select(cls)
.where(cls.name == arg),
).all(),
complete_selection: Callable[[Session, type, str], list[str]] = lambda session, cls, text: session.scalars(
select(cls.name)
.where(cls.name.ilike(f'{text}%')),
).all(),
default: Any | None = None,
):
"""
This is a utility class for prompting the user to select an
item from the database. The default functions assumes that
the item has a name attribute, and that the name is unique.
However, this can be overridden by passing in custom functions.
"""
super().__init__()
self.cls = cls
self.sql_session = sql_session
self.execute_selection = execute_selection
self.complete_selection = complete_selection
self.default_item = default
self.result = None
if default is not None:
self.prompt = f'Select {cls.__name__} [{default.name}]> '
else:
self.prompt = f'Select {cls.__name__}> '
def emptyline(self) -> bool:
if self.default_item is not None:
self.result = self.default_item
return True
def default(self, arg: str):
result = self.execute_selection(self.sql_session, self.cls, arg)
if len(result) != 1:
print(f'No such {self.cls.__name__} found: {arg}')
return
self.result = result[0]
return True
# TODO: Override this function to not act as an argument completer
# but to complete the entire value name
def completedefault(self, text: str, line: str, *_) -> list[str]:
return []
def completenames(self, text: str, *_) -> list[str]:
x = self.complete_selection(self.sql_session, self.cls, text)
return x
class NumberedCmd(Cmd):
"""
This is a utility class for creating a numbered command line.
It will automatically generate a prompt that lists all the
available commands, and will automatically call the correct
function based on the user input.
If the user input is not a number, it will call the default
function, which can be overridden by the subclass.
Example:
```
class MyCmd(NumberedCmd):
def __init__(self):
super().__init__()
def do_foo(self, arg: str):
pass
def do_bar(self, arg: str):
pass
funcs = {
1: {
'f': do_foo,
'doc': 'do foo',
},
2: {
'f': do_bar,
'doc': 'do bar',
},
}
```
"""
prompt_header: str | None = None
funcs: dict[int, dict[str, str | Callable[[Any, str], bool | None]]]
def __init__(self):
super().__init__()
def _generate_usage_list(self) -> str:
result = ''
for i, func in self.funcs.items():
if i == 0:
i = '*'
result += f'{i}) {func["doc"]}\n'
return result
def _default(self, arg: str):
try:
i = int(arg)
self.funcs[i]
except (ValueError, KeyError):
return
return self.funcs[i]['f'](self, arg)
def default(self, arg: str):
return self._default(arg)
def _postcmd(self, stop: bool, _: str) -> bool:
if not stop:
print()
print('-----------------')
print()
return stop
def postcmd(self, stop: bool, line: str) -> bool:
return self._postcmd(stop, line)
@property
def prompt(self):
result = ''
if self.prompt_header != None:
result += self.prompt_header + '\n'
result += self._generate_usage_list()
if self.lastcmd == '':
result += f'> '
else:
result += f'[{self.lastcmd}]> '
return result
class NumberedItemSelector(NumberedCmd):
def __init__(
self,
items: list[Any],
stringify: Callable[[Any], str] = lambda x: str(x),
):
super().__init__()
self.items = items
self.stringify = stringify
self.result = None
self.funcs = {
i: {
'f': self._select_item,
'doc': self.stringify(item),
}
for i, item in enumerate(items, start=1)
}
def _select_item(self, *a):
self.result = self.items[int(self.lastcmd)-1]
return True

4
src/worblehat/cli/subclis/advanced_options.py
View File

@@ -1,7 +1,7 @@
from sqlalchemy import select
from sqlalchemy.orm import Session
from worblehat.cli.prompt_utils import (
from libdib.repl import (
InteractiveItemSelector,
NumberedCmd,
format_date,
@@ -132,4 +132,4 @@ class AdvancedOptionsCli(NumberedCmd):
'f': do_done,
'doc': 'Done',
},
}
}

3
src/worblehat/cli/subclis/bookcase_item.py
View File

@@ -4,7 +4,7 @@ from sqlalchemy import select
from sqlalchemy.orm import Session
from worblehat.cli.prompt_utils import (
from libdib.repl import (
InteractiveItemSelector,
NumberedCmd,
NumberedItemSelector,
@@ -393,4 +393,3 @@ class EditBookcaseCli(NumberedCmd):
'doc': 'Done',
},
}

5
src/worblehat/cli/subclis/bookcase_shelf_selector.py
View File

@@ -1,7 +1,8 @@
from sqlalchemy import select
from sqlalchemy.orm import Session
from worblehat.cli.prompt_utils import InteractiveItemSelector
from libdib.repl import InteractiveItemSelector
from worblehat.models import (
Bookcase,
BookcaseShelf,
@@ -42,4 +43,4 @@ def select_bookcase_shelf(
)
bookcase_shelf_selector.cmdloop()
return bookcase_shelf_selector.result
return bookcase_shelf_selector.result

4
src/worblehat/cli/subclis/search.py
View File

@@ -2,7 +2,7 @@ from sqlalchemy import select
from sqlalchemy.orm import Session
from worblehat.cli.prompt_utils import (
from libdib.repl import (
NumberedCmd,
NumberedItemSelector,
)
@@ -143,4 +143,4 @@ class SearchCli(NumberedCmd):
'f': do_done,
'doc': 'Done',
},
}
}