Refactoring DbEngine

This commit is contained in:
2025-05-10 20:40:03 +02:00
parent 2daff83e67
commit e1c10183eb
12 changed files with 515 additions and 210 deletions

View File

@@ -13,8 +13,9 @@ add_stuff_app, rt = fast_app()
@rt(Routes.AddRepository)
def get(session):
repositories_instance = InstanceManager.get(session, Repositories.create_component_id(session))
return repositories_instance.request_new_repository()
_id = Repositories.create_component_id(session) # there is only one instance of Repositories
instance = InstanceManager.get(session, _id)
return instance.request_new_repository()
@rt(Routes.AddRepository)
@@ -25,6 +26,18 @@ def post(session, _id: str, tab_id: str, form_id: str, repository: str, table: s
return instance.add_new_repository(tab_id, form_id, repository, table)
@rt(Routes.AddTable)
def get(session, _id: str, repository_name: str):
instance = InstanceManager.get(session, _id)
return instance.request_new_table(repository_name)
@rt(Routes.AddTable)
def post(session, _id: str, tab_id: str, form_id: str, repository_name: str, table_name: str):
instance = InstanceManager.get(session, _id)
return instance.add_new_table(tab_id, form_id, repository_name, table_name)
@rt(Routes.SelectRepository)
def put(session, _id: str, repository: str):
logger.debug(f"Entering {Routes.SelectRepository} with args {debug_session(session)}, {_id=}, {repository=}")

View File

@@ -0,0 +1,23 @@
from components.addstuff.constants import ROUTE_ROOT, Routes
class Commands:
def __init__(self, owner):
self._owner = owner
self._id = owner.get_id()
def request_add_table(self, repository_name):
return {
"hx-get": f"{ROUTE_ROOT}{Routes.AddTable}",
"hx-target": f"#{self._owner.tabs_manager.get_id()}",
"hx-swap": "outerHTML",
"hx-vals": f'{{"_id": "{self._id}", "repository_name": "{repository_name}"}}',
}
def add_table(self):
return {
"hx-post": f"{ROUTE_ROOT}{Routes.AddTable}",
"hx-target": f"#{self._owner.tabs_manager.get_id()}",
"hx-swap": "outerHTML",
# The repository_name and the table_name will be given by the form
}

View File

@@ -2,7 +2,7 @@ from fasthtml.components import *
from components.BaseComponent import BaseComponent
from components.addstuff.constants import ADD_STUFF_INSTANCE_ID, ROUTE_ROOT, Routes
from components.addstuff.settings import AddStuffSettingsManager
from components.addstuff.settings import RepositoriesDbManager
class AddStuffMenu(BaseComponent):
@@ -10,7 +10,7 @@ class AddStuffMenu(BaseComponent):
super().__init__(session, _id)
self.tabs_manager = tabs_manager # MyTabs component id
self.mappings = {} # to keep track of when element is displayed on which tab
self.settings = AddStuffSettingsManager(session, settings_manager)
self.settings = RepositoriesDbManager(session, settings_manager)
def __ft__(self):
return Div(

View File

@@ -5,8 +5,9 @@ from fasthtml.xtend import Script
from components.BaseComponent import BaseComponent
from components.addstuff.assets.icons import icon_database, icon_table
from components.addstuff.commands import Commands
from components.addstuff.constants import REPOSITORIES_INSTANCE_ID, ROUTE_ROOT, Routes
from components.addstuff.settings import AddStuffSettingsManager, MyTable, Repository
from components.addstuff.settings import RepositoriesDbManager, Repository
from components.datagrid_new.components.DataGrid import DataGrid
from components.form.components.MyForm import MyForm, FormField
from components_helpers import mk_icon, mk_ellipsis, mk_tooltip_container
@@ -19,9 +20,10 @@ class Repositories(BaseComponent):
def __init__(self, session: dict, _id: str, settings_manager=None, tabs_manager=None):
super().__init__(session, _id)
self._settings_manager = settings_manager
self.repo_settings_manager = AddStuffSettingsManager(session, settings_manager)
self.db = RepositoriesDbManager(session, settings_manager)
self.tabs_manager = tabs_manager
self._contents = {} # ket tracks of already displayed contents
self._commands = Commands(self)
def request_new_repository(self):
# request for a new tab_id
@@ -34,6 +36,17 @@ class Repositories(BaseComponent):
self.tabs_manager.add_tab("Add Database", add_repository_form, tab_id=new_tab_id)
return self.tabs_manager
def request_new_table(self, repository_name: str):
# request for a new tab_id
new_tab_id = self.tabs_manager.request_new_tab_id()
# create a new form to ask for the details of the new database
add_table_form = self._mk_add_table_form(new_tab_id, repository_name)
# create and display the form in a new tab
self.tabs_manager.add_tab("Add New Table", add_table_form, tab_id=new_tab_id)
return self.tabs_manager
def add_new_repository(self, tab_id: str, form_id: str, repository_name: str, table_name: str):
"""
@@ -46,7 +59,7 @@ class Repositories(BaseComponent):
try:
# Add the new repository and its default table to the list of repositories
tables = [MyTable(table_name, {})] if table_name else []
repository = self.repo_settings_manager.add_repository(repository_name, tables)
repository = self.db.add_repository(repository_name, tables)
# update the tab content with table content
key = (repository_name, table_name)
@@ -65,8 +78,37 @@ class Repositories(BaseComponent):
return self.tabs_manager.refresh()
def add_new_table(self, tab_id: str, form_id: str, repository_name: str, table_name: str):
"""
:param tab_id: tab id where the table content will be displayed (and where the form was displayed)
:param form_id: form used to give the repository name (to be used in case of error)
:param repository_name: new repository name
:param table_name: default table name
:return:
"""
try:
self.db.add_table(repository_name, table_name, {})
repository = self.db.get_repository(repository_name)
# update the tab content with table content
key = (repository_name, table_name)
self.tabs_manager.set_tab_content(tab_id,
self._get_table_content(key),
title=table_name,
key=key,
active=True)
return self._mk_repository(repository, True), self.tabs_manager.refresh()
except ValueError as ex:
logger.debug(f" Repository '{repository_name}' already exists.")
add_repository_form = InstanceManager.get(self._session, form_id)
add_repository_form.set_error(ex)
return self.tabs_manager.refresh()
def select_repository(self, repository_name: str):
self.repo_settings_manager.select_repository(repository_name)
self.db.select_repository(repository_name)
def show_table(self, repository_name: str, table_name: str):
key = (repository_name, table_name)
@@ -86,11 +128,10 @@ class Repositories(BaseComponent):
)
def _mk_repositories(self, oob=False):
settings = self.repo_settings_manager.get_settings()
settings = self.db._get_settings()
return Div(
*[self._mk_repository(repo, repo.name == settings.selected_repository_name)
for repo in settings.repositories],
id=self._id,
hx_swap_oob="true" if oob else None,
)
@@ -120,6 +161,7 @@ class Repositories(BaseComponent):
cls="flex")
for table in repo.tables
],
Div("+ Add Table", **self._commands.request_add_table(repo.name)),
cls="collapse-content pr-0! truncate",
),
tabindex="0", cls="collapse mb-2")
@@ -137,6 +179,17 @@ class Repositories(BaseComponent):
htmx_params=htmx_params,
extra_values={"_id": self._id, "tab_id": tab_id})
def _mk_add_table_form(self, tab_id: str, repository_name: str = None):
htmx_request = self._commands.add_table()
return InstanceManager.get(self._session, MyForm.create_component_id(self._session), MyForm,
title="Add Table",
fields=[FormField("repository_name", 'Repository Name', 'input',
value=repository_name,
disabled=True),
FormField("table_name", 'Table Name', 'input')],
htmx_request=htmx_request,
extra_values={"_id": self._id, "tab_id": tab_id, "repository_name": repository_name})
def _get_table_content(self, key):
if key in self._contents:

View File

@@ -6,4 +6,5 @@ ROUTE_ROOT = "/add"
class Routes:
AddRepository = "/add-repository"
SelectRepository = "/select-repository"
AddTable = "/add-table"
ShowTable = "/show-table"

View File

@@ -5,38 +5,33 @@ from core.settings_management import SettingsManager
from core.settings_objects import BaseSettingObj
ADD_STUFF_SETTINGS_ENTRY = "AddStuffSettings"
REPOSITORIES_SETTINGS_ENTRY = "Repositories"
logger = logging.getLogger("AddStuffSettings")
@dataclasses.dataclass
class MyTable:
name: str
settings: dict | None = None
@dataclasses.dataclass
class Repository:
name: str
tables: list[MyTable]
tables: list[str]
@dataclasses.dataclass
class AddStuffSettings:
class RepositoriesSettings:
repositories: list[Repository] = dataclasses.field(default_factory=list)
selected_repository_name: str = None
class AddStuffSettingsManager(BaseSettingObj):
__ENTRY_NAME__ = ADD_STUFF_SETTINGS_ENTRY
class RepositoriesDbManager:
def __init__(self, session: dict, settings_manager: SettingsManager):
self.session = session
self.settings_manager = settings_manager
def get_settings(self):
return self.settings_manager.get(self.session, ADD_STUFF_SETTINGS_ENTRY, default=AddStuffSettings())
def _get_settings(self):
return self.settings_manager.get(self.session, REPOSITORIES_SETTINGS_ENTRY, default=RepositoriesSettings())
def add_repository(self, repository_name: str, tables: list[MyTable] = None):
def add_repository(self, repository_name: str, tables: list[str] = None):
"""
Adds a new repository to the list of repositories. The repository is identified
by its name and can optionally include a list of associated tables.
@@ -48,7 +43,7 @@ class AddStuffSettingsManager(BaseSettingObj):
:return: None
"""
settings = self.get_settings()
settings = self._get_settings()
if repository_name is None or repository_name == "":
raise ValueError("Repository name cannot be empty.")
@@ -61,9 +56,26 @@ class AddStuffSettingsManager(BaseSettingObj):
repository = Repository(repository_name, tables or [])
settings.repositories.append(repository)
self.settings_manager.put(self.session, ADD_STUFF_SETTINGS_ENTRY, settings)
self.settings_manager.put(self.session, REPOSITORIES_SETTINGS_ENTRY, settings)
return repository
def get_repository(self, repository_name: str):
if repository_name is None or repository_name == "":
raise ValueError("Repository name cannot be empty.")
settings = self._get_settings()
if repository_name not in [repo.name for repo in settings.repositories]:
raise ValueError(f"Repository '{repository_name}' does not exists.")
return next(filter(lambda r: r.name == repository_name, settings.repositories))
def modify_repository(self, repository_name: str, tables: list[str]):
repository = self.get_repository(repository_name)
def get_repositories(self):
return self._get_settings().repositories
def add_table(self, repository_name: str, table_name: str, table_settings: dict):
"""
Adds a table to the specified repository
@@ -74,7 +86,7 @@ class AddStuffSettingsManager(BaseSettingObj):
of the table.
:return: None
"""
settings = self.get_settings()
settings = self._get_settings()
repository = next(filter(lambda r: r.name == repository_name, settings.repositories), None)
if repository is None:
@@ -94,6 +106,7 @@ class AddStuffSettingsManager(BaseSettingObj):
:type repository_name: str
:return: None
"""
settings = self.get_settings()
settings = self._get_settings()
settings.selected_repository_name = repository_name
self.settings_manager.put(self.session, ADD_STUFF_SETTINGS_ENTRY, settings)

View File

@@ -15,6 +15,8 @@ class FormField:
name: str
label: str
type: str
value: str = None
disabled: bool = False
class MyForm(BaseComponent):
@@ -23,7 +25,7 @@ class MyForm(BaseComponent):
fields: list[FormField] = None,
state: dict = None, # to remember the values of the fields
submit: str = "Submit", # submit button
htmx_params: dict = None, # htmx parameters
htmx_request: dict = None, # htmx parameters
extra_values: dict = None, # hx_vals parameters, but using python dict rather than javascript
success: str = None,
error: str = None
@@ -33,7 +35,7 @@ class MyForm(BaseComponent):
self.fields = fields
self.state: dict = {} if state is None else state
self.submit = submit
self.htmx_params = htmx_params
self.htmx_request = htmx_request
self.extra_values = extra_values
self.success = success
self.error = error
@@ -80,10 +82,10 @@ class MyForm(BaseComponent):
Button(
self.submit,
hx_post=self.htmx_params.get("hx-post", None),
hx_target=self.htmx_params.get("hx-target", None),
hx_swap=self.htmx_params.get("hx-swap", None),
hx_vals=self.htmx_params.get("hx-vals", f"js:{{...{self.extra_values} }}" if self.extra_values else None),
hx_post=self.htmx_request.get("hx-post", None),
hx_target=self.htmx_request.get("hx-target", None),
hx_swap=self.htmx_request.get("hx-swap", None),
hx_vals=self.htmx_request.get("hx-vals", f"js:{{...{self.extra_values} }}" if self.extra_values else None),
cls="btn w-full font-bold py-2 px-4 rounded button-xs"
),
@@ -106,7 +108,8 @@ class MyForm(BaseComponent):
name=field.name,
placeholder=field.label,
required=True,
value=self.state.get(field.name, None),
value=self.state.get(field.name, field.value),
disabled=field.disabled,
hx_put=f"{ROUTE_ROOT}{Routes.OnUpdate}",
hx_trigger="keyup changed delay:300ms",
@@ -120,4 +123,4 @@ class MyForm(BaseComponent):
@staticmethod
def create_component_id(session):
prefix = f"{MY_FORM_INSTANCE_ID}{session['user_id']}"
return get_unique_id(prefix)
return get_unique_id(prefix)