ok-script 0.0.40__tar.gz → 0.0.41__tar.gz

{ok-script-0.0.40 → ok-script-0.0.41}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ok-script
-Version: 0.0.40
+Version: 0.0.41
 Summary: Automation with Computer Vision for Python
 Home-page: https://github.com/ok-oldking/ok-script
 Author: ok-oldking

{ok-script-0.0.40 → ok-script-0.0.41}/ok/OK.py

@@ -34,7 +34,7 @@ class OK:
             self.config = config
             self.init_device_manager()
             from ok.gui.debug.Screenshot import Screenshot
-            self.screenshot = Screenshot()
+            self.screenshot = Screenshot(self.exit_event)
             if config.get("use_gui"):
                 from ok.gui.App import App
                 self.app = App(config, self.exit_event)
@@ -123,7 +123,8 @@ class OK:
     def quit(self):
         logger.debug('quit app')
         self.exit_event.set()
-        self.device_manager.stop()
+        if self.device_manager is not None:
+            self.device_manager.stop()
         if self.app:
             self.app.quit()
 

{ok-script-0.0.40 → ok-script-0.0.41}/ok/capture/HwndWindow.py

@@ -11,7 +11,6 @@ from win32 import win32gui
 from ok.capture.windows.window import is_foreground_window, get_window_bounds
 from ok.gui.Communicate import communicate
 from ok.logging.Logger import get_logger
-from ok.util.exit_event import ExitEvent
 
 logger = get_logger(__name__)
 
@@ -41,7 +40,7 @@ class HwndWindow:
         super().__init__()
         self.app_exit_event = exit_event
         self.exe_name = exe_name
-        self.stop_event = ExitEvent()
+        self.stop_event = threading.Event()
         self.update_title_re(title)
         self.visible = False
         self.update_frame_size(frame_width, frame_height)

{ok-script-0.0.40 → ok-script-0.0.41}/ok/capture/windows/WindowsGraphicsCaptureMethod.py

@@ -32,7 +32,7 @@ class WindowsGraphicsCaptureMethod(BaseCaptureMethod):
     description = "fast, most compatible, capped at 60fps"
     last_frame = None
     last_frame_time = 0
-    hwnd_window: HwndWindow = None
+    _hwnd_window: HwndWindow = None
     frame_pool = None
     item = None
     session = None
@@ -42,7 +42,7 @@ class WindowsGraphicsCaptureMethod(BaseCaptureMethod):
 
     def __init__(self, hwnd_window: HwndWindow):
         super().__init__()
-        self.hwnd_window = hwnd_window
+        self._hwnd_window = hwnd_window
         self.start_or_stop()
 
     def frame_arrived_callback(self, x, y):
@@ -108,6 +108,15 @@ class WindowsGraphicsCaptureMethod(BaseCaptureMethod):
                 return self.get_frame()
         self.last_frame = img
 
+    @property
+    def hwnd_window(self):
+        return self._hwnd_window
+
+    @hwnd_window.setter
+    def hwnd_window(self, hwnd_window):
+        self._hwnd_window = hwnd_window
+        self.start_or_stop()
+
     def connected(self):
         return self.hwnd_window is not None and self.hwnd_window.exists
 

{ok-script-0.0.40 → ok-script-0.0.41}/ok/config/Config.py

@@ -1,16 +1,18 @@
+from ok.gui.Communicate import communicate
 from ok.util.json import read_json_file, write_json_file
 from ok.util.path import get_path_relative_to_exe
 
 
 class Config:
-    def __init__(self, default, folder, name):
+    def __init__(self, default, folder, name, validator=None):
         super().__init__()
         self.default = default
+        self.validator = validator
         self.config_file = get_path_relative_to_exe(folder, f"{name}.json")
         self.config = read_json_file(self.config_file)
         if self.config is None:
             self.config = default
-        elif verify_config(self.config, default):
+        elif self.verify_config(self.config, default):
             self.save_file()
 
     def save_file(self):
@@ -60,26 +62,39 @@ class Config:
         return len(self.config)
 
     def __setitem__(self, key, value):
-        self.config[key] = value
-        self.save_file()
+        if self.validate(key, value):
+            self.config[key] = value
+            self.save_file()
 
     def __getitem__(self, key):
         return self.config[key]
 
-
-def verify_config(config, default_config):
-    modified = False
-
-    # Remove entries that do not exist in default_config
-    for key in list(config.keys()):
-        if key not in default_config:
-            del config[key]
-            modified = True
-
-    # Check entries in default_config
-    for key, default_value in default_config.items():
-        if key not in config or type(config[key]) != type(default_value):
-            config[key] = default_value
-            modified = True
-
-    return not modified
+    def validate(self, key, value):
+        if self.validator is not None:
+            valid, message = self.validator(key, value)
+            if not valid:
+                communicate.config_validation.emit(message)
+                return False
+        return True
+
+    def verify_config(self, config, default_config):
+        modified = False
+
+        # Remove entries that do not exist in default_config
+        for key in list(config.keys()):
+            if key not in default_config:
+                del config[key]
+                modified = True
+
+        # Check entries in default_config
+        for key, default_value in default_config.items():
+            if key not in config or type(config[key]) != type(default_value):
+                config[key] = default_value
+                modified = True
+            elif self.validator is not None:
+                valid = self.validate(key, self.config[key])
+                if not valid:
+                    config[key] = default_value
+                    modified = True
+
+        return not modified

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/Communicate.py

@@ -17,6 +17,7 @@ class Communicate(QObject):
     screenshot = Signal(np.ndarray, str)
     update_overlay = Signal()
     adb_devices: Signal = Signal(bool)
+    config_validation: Signal = Signal(str)
     tab = Signal(str)
     capture_error = Signal()
 

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/MainWindow.py

@@ -67,6 +67,20 @@ class MainWindow(MSFluentWindow):
 
         communicate.capture_error.connect(self.capture_error)
         communicate.notification.connect(self.show_notification)
+        communicate.config_validation.connect(self.config_validation)
+
+    def config_validation(self, message):
+        title = self.tr('Error')
+        InfoBar.error(
+            title=title,
+            content=message,
+            orient=Qt.Horizontal,
+            isClosable=True,
+            position=InfoBarPosition.TOP,
+            duration=5000,  # won't disappear automatically
+            parent=self.window()
+        )
+        self.tray.showMessage(title, message)
 
     def show_notification(self, message, title=None, error=None):
         bar = InfoBar.error if error else InfoBar.info

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/debug/Screenshot.py

@@ -20,10 +20,9 @@ logger = get_logger(__name__)
 
 class Screenshot(QObject):
 
-    def __init__(self):
+    def __init__(self, exit_event):
         super().__init__()
         self.queue = []
-        self.exit_event = ok.gui.ok.exit_event
         self.time_to_expire = 3
         self.ui_dict = {}
         self.color_map = {
@@ -31,10 +30,13 @@ class Screenshot(QObject):
             "green": QColor(0, 255, 0),  # RGB for green
             "blue": QColor(0, 0, 255)  # RGB for blue
         }
+        self.exit_event = exit_event
         communicate.draw_box.connect(self.draw_box)
         communicate.screenshot.connect(self.screenshot)
         self.click_screenshot_folder = get_path_relative_to_exe(ok.gui.ok.config.get("click_screenshots_folder"))
         self.screenshot_folder = get_path_relative_to_exe(ok.gui.ok.config.get("screenshots_folder"))
+        logger.debug(f"init Screenshot {self.screenshot_folder} {self.click_screenshot_folder}")
+        print(f"init Screenshot {self.screenshot_folder} {self.screenshot_folder}")
         if self.click_screenshot_folder is not None or self.screenshot_folder is not None:
             self.task_queue = queue.Queue()
             self.exit_event.bind_queue(self.task_queue)
@@ -106,6 +108,7 @@ class Screenshot(QObject):
         pil_image = self.to_pil_image(frame)
         if pil_image is None:
             return
+        self.save_pil_image(name + '_original', folder, pil_image)
         # Ensure no fill
         draw = ImageDraw.Draw(pil_image)
 
@@ -127,6 +130,11 @@ class Screenshot(QObject):
                 # Put text
                 draw.text((x, y + height + 8), f"{box.name or key}_{round(box.confidence * 100)}", fill=color,
                           font=self.pil_font)
+        self.save_pil_image(name + '_boxed', folder, pil_image)
+
+    def save_pil_image(self, name, folder, pil_image):
+
+        logger.debug(f'save_pil_image {name}, {folder}')
         now = datetime.now()
 
         # Convert to string with milliseconds
@@ -142,6 +150,7 @@ class Screenshot(QObject):
             pil_image.save(os.path.join(folder, f"{time_string}.png"))
 
     def stop(self):
+        logger.debug(f'stop screenshot')
         if self.task_queue is not None:
             self.task_queue.put(None)
 

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/ConfigItemFactory.py

@@ -6,20 +6,20 @@ from ok.gui.tasks.LabelAndSwitchButton import LabelAndSwitchButton
 from ok.gui.tasks.ModifyListItem import ModifyListItem
 
 
-def config_widget(config, config_desc, config_type, key, value):
-    the_type = config_type.get(key)
+def config_widget(task, key, value):
+    the_type = task.config_type.get(key)
     if the_type:
         if the_type['type'] == 'drop_down':
-            return LabelAndDropDown(config, config_desc, the_type['options'], key)
+            return LabelAndDropDown(task, the_type['options'], key)
     if isinstance(value, bool):
-        return LabelAndSwitchButton(config, config_desc, key)
+        return LabelAndSwitchButton(task, key)
     elif isinstance(value, list):
-        return ModifyListItem(config, config_desc, key)
+        return ModifyListItem(task, key)
     elif isinstance(value, int):
-        return LabelAndSpinBox(config, config_desc, key)
+        return LabelAndSpinBox(task, key)
     elif isinstance(value, float):
-        return LabelAndDoubleSpinBox(config, config_desc, key)
+        return LabelAndDoubleSpinBox(task, key)
     elif isinstance(value, str):
-        return LabelAndLineEdit(config, config_desc, key)
+        return LabelAndLineEdit(task, key)
     else:
         raise ValueError(f"invalid type {type(value)}, value {value}")

ok-script-0.0.41/ok/gui/tasks/ConfigLabelAndWidget.py

@@ -0,0 +1,16 @@
+from ok.gui.tasks.LabelAndWidget import LabelAndWidget
+
+
+class ConfigLabelAndWidget(LabelAndWidget):
+
+    def __init__(self, task, key: str):
+        desc = None
+        self.key = key
+        self.task = task
+        self.config = task.config
+        if task.config_description is not None:
+            desc = task.config_description.get(key)
+        super().__init__(key, desc)
+
+    def update_config(self, value):
+        self.config[self.key] = value

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/LabelAndDoubleSpinBox.py

@@ -5,10 +5,9 @@ from ok.gui.tasks.ConfigLabelAndWidget import ConfigLabelAndWidget
 
 class LabelAndDoubleSpinBox(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, key: str):
-        super().__init__(config_desc, key)
+    def __init__(self, task, key: str):
+        super().__init__(task, key)
         self.key = key
-        self.config = config
         self.spin_box = DoubleSpinBox()
         self.update_value()
         self.spin_box.valueChanged.connect(self.value_changed)
@@ -18,4 +17,4 @@ class LabelAndDoubleSpinBox(ConfigLabelAndWidget):
         self.spin_box.setValue(self.config.get(self.key))
 
     def value_changed(self, value):
-        self.config[self.key] = value
+        self.update_config(value)

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/LabelAndDropDown.py

@@ -5,10 +5,9 @@ from ok.gui.tasks.ConfigLabelAndWidget import ConfigLabelAndWidget
 
 class LabelAndDropDown(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, options, key: str):
-        super().__init__(config_desc, key)
+    def __init__(self, task, options, key: str):
+        super().__init__(task, key)
         self.key = key
-        self.config = config
         self.combo_box = ComboBox()
         self.combo_box.addItems(options)
         self.combo_box.setCurrentIndex(find_string_index(options, self.config.get(self.key)))
@@ -17,7 +16,7 @@ class LabelAndDropDown(ConfigLabelAndWidget):
         self.add_widget(self.combo_box)
 
     def text_changed(self, text):
-        self.config[self.key] = text
+        self.update_config(text)
 
 
 def find_string_index(my_list, target_string):

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/LabelAndLineEdit.py

@@ -5,10 +5,9 @@ from ok.gui.tasks.ConfigLabelAndWidget import ConfigLabelAndWidget
 
 class LabelAndLineEdit(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, key: str):
-        super().__init__(config_desc, key)
+    def __init__(self, task, key: str):
+        super().__init__(task, key)
         self.key = key
-        self.config = config
         self.line_edit = LineEdit()
         self.update_value()
         self.line_edit.textChanged.connect(self.value_changed)
@@ -18,4 +17,4 @@ class LabelAndLineEdit(ConfigLabelAndWidget):
         self.line_edit.setText(self.config.get(self.key))
 
     def value_changed(self, value):
-        self.config[self.key] = value
+        self.update_config(value)

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/LabelAndSpinBox.py

@@ -5,10 +5,9 @@ from ok.gui.tasks.ConfigLabelAndWidget import ConfigLabelAndWidget
 
 class LabelAndSpinBox(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, key: str):
-        super().__init__(config_desc, key)
+    def __init__(self, task, key: str):
+        super().__init__(task, key)
         self.key = key
-        self.config = config
         self.spin_box = SpinBox()
         self.spin_box.setFixedWidth(130)
         self.update_value()
@@ -19,4 +18,4 @@ class LabelAndSpinBox(ConfigLabelAndWidget):
         self.spin_box.setValue(self.config.get(self.key))
 
     def value_changed(self, value):
-        self.config[self.key] = value
+        self.update_config(value)

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/LabelAndSwitchButton.py

@@ -5,10 +5,9 @@ from ok.gui.tasks.ConfigLabelAndWidget import ConfigLabelAndWidget
 
 class LabelAndSwitchButton(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, key: str):
-        super().__init__(config_desc, key)
+    def __init__(self, task, key: str):
+        super().__init__(task, key)
         self.key = key
-        self.config = config
         self.switch_button = SwitchButton()
         self.switch_button.setOnText(self.tr('Yes'))
         self.switch_button.setOffText(self.tr('No'))
@@ -20,4 +19,4 @@ class LabelAndSwitchButton(ConfigLabelAndWidget):
         self.switch_button.setChecked(self.config.get(self.key))
 
     def check_changed(self, checked):
-        self.config[self.key] = checked
+        self.update_config(checked)

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/ModifyListItem.py

@@ -8,10 +8,8 @@ from ok.gui.widget.UpdateConfigWidgetItem import value_to_string
 
 class ModifyListItem(ConfigLabelAndWidget):
 
-    def __init__(self, config, config_desc, key: str):
-        super().__init__(config_desc, key)
-        self.key = key
-        self.config = config
+    def __init__(self, task, key: str):
+        super().__init__(task, key)
         self.switch_button = PushButton(self.tr('Modify'))
         self.switch_button.clicked.connect(self.clicked)
         self.list_text = QLabel("")
@@ -20,7 +18,15 @@ class ModifyListItem(ConfigLabelAndWidget):
         self.add_widget(self.switch_button)
 
     def update_value(self):
-        self.list_text.setText(value_to_string(self.config.get(self.key)))
+        items = self.config.get(self.key)
+        total_length = sum(len(item) for item in items)
+
+        if total_length > 30:
+            display_text = "\n".join(items)
+        else:
+            display_text = value_to_string(items)
+
+        self.list_text.setText(display_text)
 
     def clicked(self):
         dialog = ModifyListDialog(self.config.get(self.key), self.window())
@@ -28,5 +34,5 @@ class ModifyListItem(ConfigLabelAndWidget):
         dialog.exec()
 
     def list_modified(self, the_list):
-        self.config[self.key] = the_list
+        self.update_config(the_list)
         self.update_value()

{ok-script-0.0.40 → ok-script-0.0.41}/ok/gui/tasks/TaskCard.py

@@ -61,7 +61,7 @@ class TaskCard(ExpandSettingCard):
             self.task.disable()
 
     def __addConfig(self, key: str, value):
-        widget = config_widget(self.task.config, self.task.config_description, self.task.config_type, key, value)
+        widget = config_widget(self.task, key, value)
         self.config_widgets.append(widget)
         self.viewLayout.addWidget(widget)
         self._adjustViewSize()

{ok-script-0.0.40 → ok-script-0.0.41}/ok/save/SaveMethodBase.py

@@ -41,6 +41,7 @@ class SaveMethodBase:
         print("Thread exiting")
 
     def stop(self):
+        print("SaveMethodBase stop")
         self.exit_event.set()
 
     def wait_until_done(self):

{ok-script-0.0.40 → ok-script-0.0.41}/ok/task/BaseTask.py

@@ -97,7 +97,17 @@ class BaseTask(ExecutorOperation):
         self.info[key] = self.info.get(key, 0) + count
 
     def load_config(self, folder):
-        self.config = Config(self.default_config, folder, self.__class__.__name__)
+        self.config = Config(self.default_config, folder, self.__class__.__name__, self.validate)
+
+    def validate(self, key, value):
+        message = self.validate_config(key, value)
+        if message:
+            return False, message
+        else:
+            return True, None
+
+    def validate_config(self, key, value):
+        pass
 
     def enable(self):
         if not self._enabled:

{ok-script-0.0.40 → ok-script-0.0.41}/ok/task/ExecutorOperation.py

@@ -78,7 +78,12 @@ class ExecutorOperation:
             self.click_box(to_click, relative_x, relative_y)
             return to_click
 
-    def box_of_screen(self, x, y, width, height, name=None):
+    def box_of_screen(self, x, y, width=0, height=0, to_x=1, to_y=1, name=None):
+        if width == 0:
+            width = to_x - x
+        if height == 0:
+            height = to_y - y
+
         if name is None:
             name = f"{x} {y} {width} {height}"
         return Box(int(x * self.executor.method.width), int(y * self.executor.method.height),

{ok-script-0.0.40 → ok-script-0.0.41}/ok/task/TaskExecutor.py

@@ -305,6 +305,7 @@ class TaskExecutor:
         return self.current_scene
 
     def stop(self):
+        logger.info('stop')
         self.exit_event.set()
 
     def wait_until_done(self):

{ok-script-0.0.40 → ok-script-0.0.41}/ok/util/exit_event.py

@@ -1,5 +1,9 @@
 import threading
 
+from ok.logging.Logger import get_logger
+
+logger = get_logger(__name__)
+
 
 class ExitEvent(threading.Event):
     queues = set()
@@ -9,5 +13,6 @@ class ExitEvent(threading.Event):
 
     def set(self):
         super(ExitEvent, self).set()
+        logger.debug(f"ExitEvent set event empty queues")
         for queue in self.queues:
             queue.put(None)

{ok-script-0.0.40 → ok-script-0.0.41}/ok_script.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ok-script
-Version: 0.0.40
+Version: 0.0.41
 Summary: Automation with Computer Vision for Python
 Home-page: https://github.com/ok-oldking/ok-script
 Author: ok-oldking

{ok-script-0.0.40 → ok-script-0.0.41}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setuptools.setup(
     name="ok-script",
-    version="0.0.40",
+    version="0.0.41",
     author="ok-oldking",
     author_email="firedcto@gmail.com",
     description="Automation with Computer Vision for Python",

ok-script-0.0.40/ok/gui/tasks/ConfigLabelAndWidget.py

@@ -1,10 +0,0 @@
-from ok.gui.tasks.LabelAndWidget import LabelAndWidget
-
-
-class ConfigLabelAndWidget(LabelAndWidget):
-
-    def __init__(self, config_desc, key: str):
-        desc = None
-        if config_desc is not None:
-            desc = config_desc.get(key)
-        super().__init__(key, desc)