Ensure favourites are added

setup.cfg

@@ -14,6 +14,7 @@ packages =
     popups
     gui
     storage
+    db
 python_requires = >=3.10
 package_dir =
     =src
@@ -32,4 +33,5 @@ design = py.typed
 pages = py.typed
 popups = py.typed
 gui = py.typed
-storage = py.typed
+storage = py.typed
+db = py.typed

src/App.py

@@ -12,6 +12,7 @@
 from pages.TestPage import TestPage
 from pages.TutorialPage import TutorialPage
 from storage.Storage import Storage
+from db.set_favourites import set_favourites
 
 _APPLICATION_PATH = os.path.dirname(sys.executable)
 
@@ -62,6 +63,7 @@ def change_page(self, page: TPAGES) -> None:
 
 
 def main() -> None:
+    set_favourites()
     App().mainloop()
 
 

src/db/get_connection.py

@@ -0,0 +1,14 @@
+import os
+from contextlib import contextmanager
+from typing import Generator
+import sqlite3
+
+
+_BASE_FILE = rf"C:\Users\{os.getenv('USERNAME')}\AppData\Local\SMXMobile"
+
+
+@contextmanager
+def get_connection(filename: str) -> Generator[sqlite3.Connection, None, None]:
+    connection = sqlite3.connect(rf"{_BASE_FILE}\{filename}.sdb")
+    yield connection
+    connection.close()

src/gui/db_functions.py → src/db/get_items_jobs.py

@@ -1,23 +1,10 @@
-import os
-import sqlite3
-from contextlib import contextmanager
-from typing import Generator
-
 from design.Item import Item
 from design.Job import Job
-
-_BASE_FILE = rf"C:\Users\{os.getenv('USERNAME')}\AppData\Local\SMXMobile"
-
-
-@contextmanager
-def _get_connection(filename: str) -> Generator[sqlite3.Connection, None, None]:
-    connection = sqlite3.connect(rf"{_BASE_FILE}\{filename}.sdb")
-    yield connection
-    connection.close()
+from db.get_connection import get_connection
 
 
 def get_items(item_number: str) -> list[Item]:
-    with _get_connection("SCMTests") as connection:
+    with get_connection("SCMTests") as connection:
         item_fields = connection.execute(
             """
             SELECT logical_name, description, model, manufacturer, serial_no_, room, last_update
@@ -31,7 +18,7 @@ def get_items(item_number: str) -> list[Item]:
 
 
 def get_jobs(job_number: str) -> list[Job]:
-    with _get_connection("SCMLookup") as connection:
+    with get_connection("SCMLookup") as connection:
         job_fields = connection.execute(
             """
             SELECT company, location, dept, number

src/db/set_favourites.py

@@ -0,0 +1,18 @@
+from db.get_connection import get_connection
+from design.data import SCRIPTS
+
+
+def set_favourites() -> None:
+    script_numbers = [(script.number,) for script in SCRIPTS.values()]
+    with get_connection("Settings") as connection:
+        with connection:
+            connection.execute("DELETE FROM ScriptFavourites")
+
+        with connection:
+            connection.executemany(
+                """
+                INSERT INTO ScriptFavourites
+                VALUES (?)
+            """,
+                script_numbers,
+            )

src/design/Script.py

@@ -12,6 +12,7 @@ def __init__(self, name: str, *options: str):
 class Script:
     nickname: str = field(hash=False, eq=False)
     name: str
+    number: int = field(hash=False, eq=False)
     tests: tuple[ScriptTest, ...] = field(factory=tuple, hash=False, eq=False)
     exact_matches: list[str] = field(factory=list, kw_only=True, hash=False, eq=False)
     search_terms: list[str] = field(factory=list, kw_only=True, hash=False, eq=False)

src/design/data.py

@@ -79,23 +79,27 @@
     "CHANGE TILT TABLE": Script(
         "CHANGE TILT TABLE",
         "AT - CHANGE / TILT TABLE",
+        1278,
         (_CASTORS_P, _FRAME_P, _PAINT_P, _LABELLING_P, _CHARGER_N, _BATTERY_N, _CONTROL_P, _CONDITION_1, _FURTHER_ATTENTION_N),
     ),
     "SLING": Script(
         "SLING",
         "AT - SLING",
+        1261,
         (_DETAILS_P, _GENERAL_WEAR_P, _STITCHING_P, _FITTINGS_P, _VELCRO_N, _LABELLING_P, _CONDITION_1),
         exact_matches=["SLING", "PATIENT TRANSFER SLING, MECHANICAL LIFT"],
     ),
     "WALKER": Script(
         "WALKER",
         "AT - WALKER / STANDER",
+        1279,
         (_CASTORS_P, _CASTORS_P, _CASTORS_P, _FRAME_P, _HARDWARE_P, _PAINT_P, _OPERATION_P, _ATTACHMENTS_N, _LABELLING_P, _CONDITION_1, _FURTHER_ATTENTION_N),
         search_terms=["WALK", "STAND", "STEDY"],
     ),
     "CEILING HOIST": Script(
         "CEILING",
         "AT - CEILING HOIST",
+        1227,
         (
             _OPERATION_P,
             _CONTROL_P,
@@ -124,22 +128,26 @@
     "TRACK": Script(
         "TRACK",
         "AT - TRACK",
+        1287,
         (_FEATURES_P, _TRACK_DUST_P, _CHARGER_N, _TRACK_LOAD_KG, _LOAD_TEST_P, _ELECTRIC_TEST_N),
         exact_matches=["TRACK", "TRACK, CEILING HOIST", "CEILING TRACK"],
     ),
     "COMMODE": Script(
         "COMMODE",
         "AT - COMMODE",
+        1228,
         (_CASTORS_P, _FRAME_P, _PAINT_P, _OPERATION_P, _LABELLING_P, _CHARGER_N, _BATTERY_N, _CONTROL_P, _CONDITION_1),
     ),
     "BED": Script(
         "BED",
         "AT - ELECTRIC BED",
+        1222,
         (_CASTORS_P, _FRAME_P, _HARDWARE_P, _CONTROL_P, _PAINT_P, _OPERATION_P, _LABELLING_P, _CHARGER_N, _HELP_POLE_N, _CONDITION_1),
     ),
     "FLOOR HOIST": Script(
         "FLOOR",
         "AT - FLOOR HOIST",
+        1226,
         (
             _CASTORS_P,
             _VISUAL_P,
@@ -167,24 +175,28 @@
     "RECLINER": Script(
         "RECLINER",
         "AT - LIFT RECLINER",
+        1223,
         (_HARDWARE_P, _ACTUATOR_P, _CONTROL_P, _FRAME_P, _PAINT_P, _OPERATION_P, _LABELLING_P, _BATTERY_N, _POWER_P, _CONDITION_1),
     ),
     "TUB": Script(
         "TUB",
         "AT - TUB / BATH CHAIRS",
+        1230,
         (_CASTORS_P, _FRAME_P, _PAINT_P, _OPERATION_P, _LABELLING_P, _CHARGER_N, _BATTERY_N, _CONTROL_P, _CONDITION_1),
         search_terms=["BATH"],
         exact_matches=["BATH BED"],
     ),
     "SCALE": Script(
         "SCALE",
         "AT - WEIGH CHAIR / SCALE",
+        1229,
         (_CASTORS_P, _FRAME_P, _PAINT_P, _OPERATION_P, _LABELLING_P, _CHARGER_N, _BATTERY_P, _ACCURACY_P, _CONDITION_1),
         search_terms=["WEIGH"],
     ),
     "WHEELCHAIR": Script(
         "WHEELCHAIR",
         "AT - WHEELCHAIR",
+        1113,
         (
             _CASTORS_P,
             _CASTORS_P,
@@ -212,21 +224,24 @@
     "CHARGER": Script(
         "CHARGER",
         "BATTERY OPERATED / VISUAL TEST",
+        859,
         (_BATTERY_N, _CONTROL_P, _VISUAL_P, _ATTACHMENTS_N),
     ),
-    "BATTERY": Script("BATTERY", "BATTERY PACK", (_VISUAL_P, _CAPACITY_P, _DATE_P)),
+    "BATTERY": Script("BATTERY", "BATTERY PACK", 1065, (_VISUAL_P, _CAPACITY_P, _DATE_P)),
     "CLASS II": Script(
         "CLASS II",
         "CLASS II NO APPLIED PARTS",
+        606,
         (_MAINS_P, _FUSES_P, _CONTROL_P, _BATTERY_N, _VISUAL_P, _ATTACHMENTS_N, _EARTH_RESISTANCE, _INSULATION_RESISTANCE, _INSULATION_RESISTANCE_ENCLOSURE, _TOUCH_CURRENT, _IEC_MAINS_LEAD),
     ),
     "FURNITURE": Script(
         "FURNITURE",
         "FURNITURE GENERIC",
+        799,
         (_CHASIS_P, _CASTORS_P, _CASTORS_P, _PAINT_P, _CASTORS_P, _MISSING_COMPONENTS_N, _POLES_P, _CLEAN_P, _ELECTRIC_N, _PERFORMANCE_P),
         search_terms=["OVERBED"],
     ),
-    "VISUAL": Script("VISUAL", "VISUAL INSPECTION ONLY", (_INTEGRITY_P, _ACCESSORIES_P)),
+    "VISUAL": Script("VISUAL", "VISUAL INSPECTION ONLY", 1190, (_INTEGRITY_P, _ACCESSORIES_P)),
 }
 
 SCRIPT_DOWNS: dict[str, int] = {script.nickname: i for i, script in enumerate(SCRIPTS.values())}

src/gui/__init__.py

@@ -8,4 +8,3 @@
     get_click_position,
     get_selected_text,
 )
-from gui.db_functions import get_items, get_jobs

src/pages/TestPage.py

@@ -10,7 +10,7 @@
 from design.Test import TEST_RESULTS, ScriptError, Test
 from design.TestJob import TestJob
 from gui.actions import complete_test, turn_off_capslock
-from gui.db_functions import get_items
+from db.get_items_jobs import get_items
 from pages.Page import Page
 from popups.ScriptSelectionPopup import ScriptSelectionPopup
 from popups.TestJobPopup import TestJobPopup

src/popups/JobEntryPopup.py

@@ -1,7 +1,7 @@
 from tkinter import Misc, StringVar, ttk
 from typing import Callable
 from design.Job import Job
-from gui.db_functions import get_jobs
+from db.get_items_jobs import get_jobs
 from popups.Popup import Popup
 from popups.OptionSelectPopup import OptionSelectPopup
 

src/storage/Storage.py

@@ -26,7 +26,7 @@ def keys(cls) -> KeysView[Any]:
         return cls.__annotations__.keys()
 
     @classmethod
-    def from_dict(cls, data: Mapping[str, tuple[int, int]]) -> 'Positions':
+    def from_dict(cls, data: Mapping[str, tuple[int, int]]) -> "Positions":
         return cls(**data)
 
 
@@ -61,7 +61,7 @@ def _save(self) -> None:
             json.dump(data, file, indent=4)
 
     @contextmanager
-    def edit(self) -> Generator['Storage', None, None]:
+    def edit(self) -> Generator["Storage", None, None]:
         try:
             yield self
         finally:

testing/test_db_functions.py → testing/db/test_get_items_jobs.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from gui.db_functions import get_items, get_jobs
+from db.get_items_jobs import get_items, get_jobs
 
 
 class JobMock:

testing/design/test_job.py

@@ -22,10 +22,10 @@ def test_job_add_test() -> None:
     test1 = Test(Item("001", "Test Item 1", "ModelX", "ManufacturerX", "XYZ001", "RM1", "2019"))
     test2 = Test(Item("002", "Test Item 2", "ModelY", "ManufacturerY", "XYZ002", "RM1", "2019"))
 
-    custom1 = Script("Custom1", "Custom Script", (), exact_matches=["Test Item 1"])
+    custom1 = Script("Custom1", "Custom Script", 1, (), exact_matches=["Test Item 1"])
     SCRIPTS["Custom1"] = custom1
     test1.script = test1.determine_script()
-    custom2 = Script("Custom2", "Custom Script", (), exact_matches=["Test Item 2"])
+    custom2 = Script("Custom2", "Custom Script", 1, (), exact_matches=["Test Item 2"])
     SCRIPTS["Custom2"] = custom2
     test2.script = test2.determine_script()
 
@@ -40,7 +40,7 @@ def test_job_add_test() -> None:
 
 
 def test_job_remove_test() -> None:
-    custom1 = Script("Custom1", "Custom Script", (), exact_matches=["Test Item 1"])
+    custom1 = Script("Custom1", "Custom Script", 1, (), exact_matches=["Test Item 1"])
     SCRIPTS["Custom1"] = custom1
     test1 = Test(Item("001", "Test Item 1", "ModelX", "ManufacturerX", "XYZ001", "RM1", "2019"))
     test1.script = test1.determine_script()

testing/design/test_script.py

@@ -5,25 +5,26 @@
 
 
 def test_script_creation() -> None:
-    script = Script("Nick", "Script Name")
+    script = Script("Nick", "Script Name", 1)
     assert script.nickname == "Nick"
     assert script.name == "Script Name"
+    assert script.number == 1
     assert len(script.tests) == 0
     assert script.search_terms == ["Nick"]
 
 
 def test_script_creation_with_tests() -> None:
     test1 = ScriptTest("Test 1", "Pass", "Fail")
     test2 = ScriptTest("Test 2", "N/A", "Yes", "No")
-    script = Script("Nickname", "Test Script", (test1, test2))
+    script = Script("Nickname", "Test Script", 1, (test1, test2))
     assert script.nickname == "Nickname"
     assert script.name == "Test Script"
     assert len(script.tests) == 2
     assert script.search_terms == ["Nickname"]
 
 
 def test_script_creation_with_extra_terms() -> None:
-    script = Script("UniqueNick", "Unique Script", search_terms=["tag1", "tag2"])
+    script = Script("UniqueNick", "Unique Script", 1, search_terms=["tag1", "tag2"])
     assert script.nickname == "UniqueNick"
     assert script.name == "Unique Script"
     assert len(script.tests) == 0
@@ -41,19 +42,19 @@ def test_script_creation_with_extra_terms() -> None:
     ],
 )
 def test_script_matches(match_description: str, expected: bool) -> None:
-    script = Script("Tester", "Matching Script", search_terms=["tag3"])
+    script = Script("Tester", "Matching Script", 1, search_terms=["tag3"])
     assert script.is_for(match_description) == expected
 
 
 def test_script_to_string() -> None:
-    script = Script("MyNick", "Awesome Script")
+    script = Script("MyNick", "Awesome Script", 1)
     assert str(script) == "Awesome Script"
 
 
 def test_hash_and_eq() -> None:
-    script1 = Script("Nick1", "Script 1")
-    script2 = Script("Nick2", "Script 2")
-    script3 = Script("Nick3", "Script 1")
+    script1 = Script("Nick1", "Script 1", 1)
+    script2 = Script("Nick2", "Script 2", 1)
+    script3 = Script("Nick3", "Script 1", 1)
     assert len({script1, script2}) == 2
     assert len({script1, script3}) == 1
     assert hash(script1) != hash(script2)

testing/design/test_test.py

@@ -29,7 +29,7 @@ def test_test_determine_script() -> None:
     test = Test(item)
 
     # Adding a custom script for testing
-    custom_script = Script("CustomScript", "Custom Script")
+    custom_script = Script("CustomScript", "Custom Script", 1)
     SCRIPTS["CustomScript"] = custom_script
 
     test.script = custom_script
@@ -57,7 +57,7 @@ def test_test_complete_and_full_info() -> None:
     item = Item("001", "Test Item", "ModelX", "ManufacturerX", "XYZ001", "RM1", "2019")
     test = Test(item)
 
-    custom = Script("CustomScript", "Custom Script", (), exact_matches=["Test Item"])
+    custom = Script("CustomScript", "Custom Script", 1, (), exact_matches=["Test Item"])
     SCRIPTS["CustomScript"] = custom
     test.script = test.determine_script()
     assert test.script.nickname == "CustomScript"
@@ -76,6 +76,6 @@ def test_test_complete_and_full_info() -> None:
 def test_test_item_model_property() -> None:
     item = Item("001", "Test Item", "ModelX", "ManufacturerX", "XYZ001", "RM1", "2019")
     test = Test(item)
-    test.script = Script("CustomScript", "Custom Script")
+    test.script = Script("CustomScript", "Custom Script", 1)
 
     assert test.item_model == "Custom Script -> ModelX"