base_task.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import numpy as np
  5. from datetime import datetime, timedelta
  6. from typing import Union
  7. from module.config.utils import convert_to_underscore
  8. from module.atom.image import RuleImage
  9. from module.atom.click import RuleClick
  10. from module.atom.long_click import RuleLongClick
  11. from module.atom.swipe import RuleSwipe
  12. from module.atom.ocr import RuleOcr
  13. from module.ocr.base_ocr import OcrMode, OcrMethod
  14. from module.logger import logger
  15. from module.base.timer import Timer
  16. from module.config.config import Config
  17. from module.device.device import Device
  18. class BaseTask:
  19. config: Config = None
  20. device: Device = None
  21. folder: str
  22. name: str
  23. stage: str
  24. limit_time: datetime # 限制运行的时间,是软时间,不是硬时间
  25. def __init__(self, config: Config, device: Device) -> None:
  26. self.config = config
  27. self.device = device
  28. self.interval_timer = {} # 这个是用来记录每个匹配的运行间隔的,用于控制运行频率
  29. self.start_time = datetime.now() # 启动的时间
  30. def screenshot(self):
  31. """
  32. 截图 引入中间函数的目的是 为了解决如协作的这类突发的事件
  33. :return:
  34. """
  35. return self.device.screenshot()
  36. def appear(self, target: RuleImage, interval: float =None, threshold: float =None):
  37. """
  38. :param target: 匹配的目标可以是RuleImage, 也可以是RuleOcr
  39. :param interval:
  40. :param threshold:
  41. :return:
  42. """
  43. if not isinstance(target, RuleImage):
  44. return False
  45. if interval:
  46. if target.name in self.interval_timer:
  47. if self.interval_timer[target.name].limit != interval:
  48. self.interval_timer[target.name] = Timer(interval)
  49. else:
  50. self.interval_timer[target.name] = Timer(interval)
  51. if not self.interval_timer[target.name].reached():
  52. return False
  53. appear = target.match(self.device.image, threshold=threshold)
  54. if appear and interval:
  55. self.interval_timer[target.name].reset()
  56. return appear
  57. def appear_then_click(self,
  58. target: RuleImage,
  59. action: Union[RuleClick, RuleLongClick]=None,
  60. interval: float=None,
  61. threshold: float=None,
  62. duration: float=None):
  63. """
  64. 出现了就点击,默认点击图片的位置,如果添加了click参数,就点击click的位置
  65. :param duration: 如果是长按,可以手动指定duration,不指定默认.单位是ms!!!!
  66. :param action: 可以是RuleClick, 也可以是RuleLongClick
  67. :param target: 可以是RuleImage后续支持RuleOcr
  68. :param interval:
  69. :param threshold:
  70. :return: True or False
  71. """
  72. if not isinstance(target, RuleImage):
  73. return False
  74. appear = self.appear(target, interval=interval, threshold=threshold)
  75. if appear and not action:
  76. x, y = target.coord()
  77. self.device.click(x, y, control_name=target.name)
  78. elif appear and action:
  79. x, y = action.coord()
  80. if isinstance(action, RuleLongClick):
  81. if duration is None:
  82. self.device.long_click(x, y, duration=action.duration/1000, control_name=target.name)
  83. else:
  84. self.device.long_click(x, y, duration=duration/1000, control_name=target.name)
  85. elif isinstance(action, RuleClick):
  86. self.device.click(x, y, control_name=target.name)
  87. return appear
  88. def wait_until_appear(self,
  89. target: RuleImage,
  90. skip_first_screenshot=False) -> None:
  91. """
  92. 等待直到出现目标
  93. :param target:
  94. :param skip_first_screenshot:
  95. :return:
  96. """
  97. while 1:
  98. if skip_first_screenshot:
  99. skip_first_screenshot = False
  100. else:
  101. self.screenshot()
  102. if self.appear(target):
  103. break
  104. def wait_until_appear_then_click(self,
  105. target: RuleImage,
  106. action: Union[RuleClick, RuleLongClick]=None) -> None:
  107. """
  108. 等待直到出现目标,然后点击
  109. :param action:
  110. :param target:
  111. :return:
  112. """
  113. self.wait_until_appear(target)
  114. if action is None:
  115. self.device.click(target.coord(), control_name=target.name)
  116. elif isinstance(action, RuleLongClick):
  117. self.device.long_click(target.coord(), duration=action.duration/1000, control_name=target.name)
  118. elif isinstance(action, RuleClick):
  119. self.device.click(target.coord(), control_name=target.name)
  120. def wait_until_disappear(self, target: RuleImage) -> None:
  121. while 1:
  122. self.screenshot()
  123. if not self.appear(target):
  124. break
  125. def wait_until_stable(self,
  126. target: RuleImage,
  127. timer=Timer(0.3, count=1),
  128. timeout=Timer(5, count=10),
  129. skip_first_screenshot=True):
  130. """
  131. 等待目标稳定,即连续多次匹配成功
  132. :param target:
  133. :param timer:
  134. :param timeout:
  135. :param skip_first_screenshot:
  136. :return:
  137. """
  138. target._match_init = False
  139. timeout.reset()
  140. while 1:
  141. if skip_first_screenshot:
  142. skip_first_screenshot = False
  143. else:
  144. self.screenshot()
  145. if target._match_init:
  146. if target.match(self.device.image):
  147. if timer.reached():
  148. break
  149. else:
  150. # button.load_color(self.device.image)
  151. timer.reset()
  152. else:
  153. # target.load_color(self.device.image)
  154. target._match_init = True
  155. if timeout.reached():
  156. logger.warning(f'wait_until_stable({target}) timeout')
  157. break
  158. def swipe(self, swipe: RuleSwipe, interval: float =None) -> None:
  159. """
  160. :param interval:
  161. :param swipe:
  162. :return:
  163. """
  164. if not isinstance(swipe, RuleSwipe):
  165. return
  166. if interval:
  167. if swipe.name in self.interval_timer:
  168. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  169. if self.interval_timer[swipe.name].limit != interval:
  170. self.interval_timer[swipe.name] = Timer(interval)
  171. else:
  172. # 如果没有限制时间,则创建限制时间
  173. self.interval_timer[swipe.name] = Timer(interval)
  174. # 如果时间还没到达,则不执行
  175. if not self.interval_timer[swipe.name].reached():
  176. return
  177. x1, y1, x2, y2 = swipe.coord()
  178. self.device.swipe(p1=(x1, y1), p2=(x2, y2), control_name=swipe.name)
  179. # 执行后,如果有限制时间,则重置限制时间
  180. if interval:
  181. # logger.info(f'Swipe {swipe.name}')
  182. self.interval_timer[swipe.name].reset()
  183. def click(self, click: Union[RuleClick, RuleLongClick]=None, interval: float =None) -> None:
  184. """
  185. 点击或者长按
  186. :param interval:
  187. :param click:
  188. :return:
  189. """
  190. if not click:
  191. return
  192. if interval:
  193. if click.name in self.interval_timer:
  194. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  195. if self.interval_timer[click.name].limit != interval:
  196. self.interval_timer[click.name] = Timer(interval)
  197. else:
  198. # 如果没有限制时间,则创建限制时间
  199. self.interval_timer[click.name] = Timer(interval)
  200. # 如果时间还没到达,则不执行
  201. if not self.interval_timer[click.name].reached():
  202. return
  203. x, y = click.coord()
  204. if isinstance(click, RuleLongClick):
  205. self.device.long_click(x=x, y=y, duration=click.duration/1000, control_name=click.name)
  206. elif isinstance(click, RuleClick):
  207. self.device.click(x=x, y=y, control_name=click.name)
  208. # 执行后,如果有限制时间,则重置限制时间
  209. if interval:
  210. self.interval_timer[click.name].reset()
  211. def ocr_appear(self, target: RuleOcr, interval: float=None) -> bool:
  212. """
  213. ocr识别目标
  214. :param interval:
  215. :param target:
  216. :return: 如果target有keyword或者是keyword存在,返回是True,否则返回False
  217. 但是没有指定keyword,返回的是匹配到的值,具体取决于target的mode
  218. """
  219. if not isinstance(target, RuleOcr):
  220. return None
  221. if interval:
  222. if target.name in self.interval_timer:
  223. # 如果传入的限制时间不一样,则替换限制新的传入的时间
  224. if self.interval_timer[target.name].limit != interval:
  225. self.interval_timer[target.name] = Timer(interval)
  226. else:
  227. # 如果没有限制时间,则创建限制时间
  228. self.interval_timer[target.name] = Timer(interval)
  229. # 如果时间还没到达,则不执行
  230. if not self.interval_timer[target.name].reached():
  231. return None
  232. result = target.ocr(self.device.image)
  233. appear = False
  234. if not target.keyword or target.keyword == '':
  235. appear = False
  236. match target.mode:
  237. case OcrMode.FULL: # 全匹配
  238. appear = result != (0, 0, 0, 0)
  239. case OcrMode.SINGLE:
  240. appear = result == target.keyword
  241. case OcrMode.DIGIT:
  242. appear = result == int(target.keyword)
  243. case OcrMode.DIGITCOUNTER:
  244. appear = result == target.ocr_str_digit_counter(target.keyword)
  245. case OcrMode.DURATION:
  246. appear = result == target.parse_time(target.keyword)
  247. if interval and appear:
  248. self.interval_timer[target.name].reset()
  249. return appear
  250. def ocr_appear_click(self,
  251. target: RuleOcr,
  252. action: Union[RuleClick, RuleLongClick]=None,
  253. interval: float=None,
  254. duration: float = None) -> bool:
  255. """
  256. ocr识别目标,如果目标存在,则触发动作
  257. :param target:
  258. :param action:
  259. :param interval:
  260. :param duration:
  261. :return:
  262. """
  263. appear = self.ocr_appear(target, interval)
  264. if not appear:
  265. return False
  266. if action:
  267. x, y = action.coord()
  268. self.click(action, interval)
  269. else:
  270. x, y = target.coord()
  271. self.device.click(x=x, y=y, control_name=target.name)
  272. def set_next_run(self, task: str, finish: bool=False) -> None:
  273. """
  274. 设置下次运行时间 当然这个也是可以重写的
  275. :param task: 任务名称,大驼峰的
  276. :param finish: 是完成任务后的时间为基准还是开始任务的时间为基准
  277. :return:
  278. """
  279. task = convert_to_underscore(task)
  280. task_object = getattr(self.config.model, task, None)
  281. if not task_object:
  282. logger.warning(f'No task named {task}')
  283. return
  284. if finish:
  285. start_time = datetime.now()
  286. else:
  287. start_time = self.start_time
  288. delta = timedelta(days=task_object.scheduler.interval_days,
  289. hours=task_object.scheduler.interval_hours,
  290. minutes=task_object.scheduler.interval_minutes,)
  291. next_run = start_time + delta
  292. task_object.scheduler.next_run = next_run
  293. self.config.save()