base_task.py 13 KB

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