1) Fixed documentation requirements and OCR example order

2) Added RapidOCR test stub for default OCRAlgorithm tests
3) Fixed IdsAlgorithm and NamesAlgorithm argument forwarding without debugger
4) Renamed UnDetected event to Undetected and updated CV tests
5) Fixed YOLO box coordinate rounding and size calculation
6) Fixed OCR plot text offset check and cleaned up docstrings

Author: lexter0705

apparser/core/ui/coordinates.py

@@ -22,8 +22,8 @@ def __init__(
         :type from_ui: BaseUi
         :param point_one: First point of the nested region.
         :type point_one: Point | RelativelyPoint
-        :param point_two: Second point of the nested region or region size.
-        :type point_two: Point | RelativelyPoint | Size
+        :param point_two: Second point of the nested region.
+        :type point_two: Point | RelativelyPoint
         :raises TypeError: If any argument has an invalid type.
         """
         if not isinstance(from_ui, BaseUi):

apparser/cv/events/__init__.py

@@ -2,7 +2,7 @@
 from apparser.cv.events.moved import Moved
 from apparser.cv.events.detected import Detected
 from apparser.cv.events.resized import Resized
-from apparser.cv.events.undetected import UnDetected
+from apparser.cv.events.undetected import Undetected
 
 __all__ = ["CvEvent", "Moved",
-           "Detected", "Resized", "UnDetected"]
+           "Detected", "Resized", "Undetected"]

apparser/cv/events/undetected.py

@@ -1,7 +1,7 @@
 from apparser.cv.events.base import CvEvent
 
 
-class UnDetected(CvEvent):
+class Undetected(CvEvent):
     """Represent a previously tracked object that disappeared."""
 
     def __str__(self) -> str:

apparser/cv/readers/yolo.py

@@ -50,12 +50,12 @@ def read(self, ui: BaseUi) -> CvAllData:
                 track_id = int(track_id.item())
             cls_name = names[class_index]
             x1, y1, x2, y2 = box.xyxy[0].tolist()
-            x = int(x1)
-            y = int(y1)
-            x2 = int(x2)
-            y2 = int(y2)
-            width = x2 - x1
-            height = y2 - y1
+            x = round(x1)
+            y = round(y1)
+            x2 = round(x2)
+            y2 = round(y2)
+            width = x2 - x
+            height =  y2 - y
             box_ui = CoordinatesUi(ui, Point(x, y), Point(x2, y2))
             boxes.append(
                 CvBox(

apparser/cv/utils/changes_checker.py

@@ -1,30 +1,12 @@
 from apparser.cv.models import CvAllData, CvChangeData, CvBox
-from apparser.cv.events import Detected, UnDetected, Moved, Resized
+from apparser.cv.events import Detected, Undetected, Moved, Resized
 
 
 def _is_moved(box: CvBox, old_box: CvBox) -> bool:
-    """Check whether a box position changed.
-
-    :param box: Current box state.
-    :type box: CvBox
-    :param old_box: Previous box state.
-    :type old_box: CvBox
-    :return: True if the box coordinates changed.
-    :rtype: bool
-    """
     return abs(box.x - old_box.x) > 0 or abs(box.y - old_box.y) > 0
 
 
 def _is_resized(box: CvBox, old_box: CvBox) -> bool:
-    """Check whether both box dimensions changed.
-
-    :param box: Current box state.
-    :type box: CvBox
-    :param old_box: Previous box state.
-    :type old_box: CvBox
-    :return: True if width and height both changed.
-    :rtype: bool
-    """
     return abs(box.width - old_box.width) > 0 or abs(box.height - old_box.height) > 0
 
 
@@ -59,7 +41,7 @@ def __get_undetected(self, current_data: CvAllData) -> list[CvChangeData]:
         :rtype: list[CvChangeData]
         """
         new_ids = [i.track_id for i in current_data.boxes if i.track_id is not None]
-        return [CvChangeData(UnDetected, i, i) for i in self.__old_data.boxes if
+        return [CvChangeData(Undetected, i, i) for i in self.__old_data.boxes if
                 i.track_id not in new_ids and i.track_id is not None]
 
     def check(self, data: CvAllData) -> list[CvChangeData]:

apparser/instructions/default/click.py

@@ -12,7 +12,7 @@ def __init__(self, click_type: BaseKeyCode = LeftClick()):
 
         :param click_type: Mouse button to click.
         :type click_type: BaseKeyCode
-        :raises TypeError: If ``click_type`` is neither :class:`BaseKeyCode`.
+        :raises TypeError: If ``click_type`` is not a :class:`BaseKeyCode`.
         """
         if not isinstance(click_type, BaseKeyCode):
             raise TypeError('click_type must be BaseKeyCode')

apparser/instructions/default/press.py

@@ -30,16 +30,17 @@ def perform(self, *args, **kwargs):
 class PressKeysCombination(BaseInstruction):
     """Send a keyboard shortcut as a pressed combination."""
 
-    def __init__(self, keys: list[BaseKeyCode | str]):
+    def __init__(self, keys: list[BaseKeyCode | str] | str):
         """Initialize a key combination instruction.
 
         :param keys: Keys to press together.
-        :type keys: list[BaseKeyCode | str]
+        :type keys: list[BaseKeyCode | str] | str
         """
         self.__keys = keys
         self.__validate()
 
     def __validate(self):
+
         for key in self.__keys:
             if not (isinstance(key, BaseKeyCode) or isinstance(key, str)):
                 raise TypeError('key_code must be BaseKeyCode or str')

apparser/instructions/default/sleep.py

@@ -12,7 +12,7 @@ def __init__(self, sleep_time: float):
         :param sleep_time: Delay duration in seconds.
         :type sleep_time: float
         :raises ValueError: If ``sleep_time`` is not greater than zero.
-        :raises TypeError: If ``sleep_time`` is not number.
+        :raises TypeError: If ``sleep_time`` is not a number.
         """
         if not isinstance(sleep_time, float) and not isinstance(sleep_time, int):
             raise TypeError("sleep_time must be a number.")

apparser/instructions/ocr/plot_text.py

@@ -41,7 +41,7 @@ def __paint_cords(self, data: TextData):
         if y < 0:
             y = data.coordinates.right_bottom.y - self.__text_move.y
         x = data.coordinates.left_top.x + self.__text_move.x
-        if y < 0:
+        if x < 0:
             x = data.coordinates.right_bottom.x - self.__text_move.x
         self.__draw.text((x, y), data.text, fill=self.__color)
 

apparser/instructions/ui/algorithms/ids.py

@@ -113,7 +113,7 @@ def perform(self, ui: BaseUi, *args, **kwargs):
             if self.__debugger is not None:
                 self.__debugger.try_perform(instruction, **perform_kwargs)
             else:
-                instruction.perform(ui, **perform_kwargs)
+                instruction.perform(**perform_kwargs)
 
     def add_instruction(self, instruction: tuple[int, list[Any]]):
         _check_instruction(instruction)