config.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import copy
  5. import datetime
  6. import operator
  7. import threading
  8. from datetime import datetime, timedelta
  9. from cached_property import cached_property
  10. from threading import Lock
  11. from module.base.filter import Filter
  12. from module.config.config_updater import ConfigUpdater
  13. from module.config.config_manual import ConfigManual
  14. from module.config.config_watcher import ConfigWatcher
  15. from module.config.config_menu import ConfigMenu
  16. from module.config.config_model import ConfigModel
  17. from module.config.config_state import ConfigState
  18. from module.config.scheduler import TaskScheduler
  19. from module.config.utils import *
  20. from module.notify.notify import Notifier
  21. from module.exception import RequestHumanTakeover, ScriptError
  22. from module.logger import logger
  23. class Function:
  24. def __init__(self, key: str, data: dict):
  25. """
  26. 输入的是每一个ConfigModel的一个字段对象
  27. :param data:
  28. """
  29. if isinstance(data, dict) is False:
  30. self.enable = False
  31. self.command = "Unknown"
  32. self.next_run = DEFAULT_TIME
  33. return
  34. if data.get("scheduler") is None:
  35. self.enable = False
  36. self.command = "Unknown"
  37. self.next_run = DEFAULT_TIME
  38. return
  39. self.enable: bool = data['scheduler']['enable']
  40. self.command: str = ConfigModel.type(key)
  41. next_run = data['scheduler']['next_run']
  42. if isinstance(next_run, str):
  43. next_run = datetime.strptime(next_run, "%Y-%m-%d %H:%M:%S")
  44. self.next_run: datetime = next_run
  45. priority = data['scheduler']['priority']
  46. if isinstance(priority, str):
  47. priority = int(priority)
  48. self.priority: int = priority
  49. if not isinstance(self.priority, int):
  50. logger.error(f"Invalid priority: {self.priority}")
  51. # self.enable = deep_get(data, keys="Scheduler.Enable", default=False)
  52. # self.command = deep_get(data, keys="Scheduler.Command", default="Unknown")
  53. # self.next_run = deep_get(data, keys="Scheduler.NextRun", default=DEFAULT_TIME)
  54. def __str__(self):
  55. enable = "Enable" if self.enable else "Disable"
  56. return f"{self.command} ({enable}, {self.priority}, {str(self.next_run)})"
  57. __repr__ = __str__
  58. def __eq__(self, other):
  59. if not isinstance(other, Function):
  60. return False
  61. if self.command == other.command and self.next_run == other.next_run:
  62. return True
  63. else:
  64. return False
  65. def name_to_function(name):
  66. """
  67. Args:
  68. name (str):
  69. Returns:
  70. Function:
  71. """
  72. function = Function({})
  73. function.command = name
  74. function.enable = True
  75. return function
  76. class Config(ConfigState, ConfigManual, ConfigWatcher, ConfigMenu):
  77. def __init__(self, config_name: str, task=None) -> None:
  78. """
  79. :param config_name:
  80. :param task:
  81. """
  82. super().__init__(config_name) # 调用 ConfigState 的初始化方法
  83. super(ConfigManual, self).__init__()
  84. super(ConfigWatcher, self).__init__()
  85. super(ConfigMenu, self).__init__()
  86. self.model = ConfigModel(config_name=config_name)
  87. def __getattr__(self, name):
  88. """
  89. 一开始是打算直接继承ConfigModel的,但是pydantic会接管所有的变量
  90. 故而选择持有ConfigModel
  91. :param name:
  92. :return:
  93. """
  94. try:
  95. return getattr(self.model, name)
  96. except AttributeError:
  97. # 这个导致 大量的无用log
  98. # logger.error(f'can not ask this variable {name}')
  99. return None # 或者抛出异常,或者返回其他默认值
  100. @cached_property
  101. def lock_config(self) -> Lock:
  102. return Lock()
  103. def gui_args(self, task: str) -> str:
  104. """
  105. 获取给gui显示的参数
  106. :return:
  107. """
  108. return self.model.gui_args(task=task)
  109. def get_arg(self, task: str, group: str, argument: str):
  110. """
  111. :param task:
  112. :param group:
  113. :param argument:
  114. :return: str/int/float
  115. """
  116. try:
  117. return self.data[task][group][argument]
  118. except:
  119. logger.exception(f'have no arg {task}.{group}.{argument}')
  120. def set_arg(self, task: str, group: str, argument: str, value) -> None:
  121. """
  122. :param task:
  123. :param group:
  124. :param argument:
  125. :param value:
  126. :return:
  127. """
  128. try:
  129. self.data[task][group][argument] = value
  130. except:
  131. logger.exception(f'have no arg {task}.{group}.{argument}')
  132. def save(self) -> None:
  133. """
  134. 保存配置文件
  135. :return:
  136. """
  137. self.model.write_json(self.config_name, self.model.dict())
  138. def update_scheduler(self) -> None:
  139. """
  140. 更新调度器, 设置pending_task and waiting_task
  141. :return:
  142. """
  143. pending_task = []
  144. waiting_task = []
  145. error = []
  146. now = datetime.now()
  147. for key, value in self.model.dict().items():
  148. func = Function(key, value)
  149. if not func.enable:
  150. continue
  151. if not isinstance(func.next_run, datetime):
  152. error.append(func)
  153. elif func.next_run < now:
  154. pending_task.append(func)
  155. else:
  156. waiting_task.append(func)
  157. # f = Filter(regex=r"(.*)", attr=["command"])
  158. # f.load(self.SCHEDULER_PRIORITY)
  159. if pending_task:
  160. pending_task = TaskScheduler.schedule(rule=self.model.script.optimization.schedule_rule,
  161. pending=pending_task)
  162. if waiting_task:
  163. # waiting_task = f.apply(waiting_task)
  164. waiting_task = sorted(waiting_task, key=operator.attrgetter("next_run"))
  165. if error:
  166. pending_task = error + pending_task
  167. self.pending_task = pending_task
  168. self.waiting_task = waiting_task
  169. def get_next(self) -> Function:
  170. """
  171. 获取下一个要执行的任务
  172. :return:
  173. """
  174. self.update_scheduler()
  175. if self.pending_task:
  176. logger.info(f"Pending tasks: {[f.command for f in self.pending_task]}")
  177. task = self.pending_task[0]
  178. logger.attr("Task", task)
  179. return task
  180. # 哪怕是没有任务,也要返回一个任务,这样才能保证调度器正常运行
  181. if self.waiting_task:
  182. logger.info("No task pending")
  183. task = copy.deepcopy(self.waiting_task[0])
  184. # task.next_run = (task.next_run + self.hoarding).replace(microsecond=0)
  185. logger.attr("Task", task)
  186. return task
  187. else:
  188. logger.critical("No task waiting or pending")
  189. logger.critical("Please enable at least one task")
  190. raise RequestHumanTakeover
  191. def task_call(self, task: str=None, force_call=True):
  192. """
  193. 回调任务,这会是在任务结束后调用
  194. :param task: 调用的任务的大写名称
  195. :param force_call:
  196. :return:
  197. """
  198. task = convert_to_underscore(task)
  199. if self.model.deep_get(self.model, keys=f'{task}.scheduler.next_run') is None:
  200. raise ScriptError(f"Task to call: `{task}` does not exist in user config")
  201. task_enable = self.model.deep_get(self.model, keys=f'{task}.scheduler.enable')
  202. if force_call or task_enable:
  203. logger.info(f"Task call: {task}")
  204. next_run = datetime.now().replace(
  205. microsecond=0
  206. )
  207. self.model.deep_set(self.model, keys=f'{task}.scheduler.next_run', value=next_run)
  208. self.save()
  209. return True
  210. else:
  211. logger.info(f"Task call: {task} (skipped because disabled by user)")
  212. return False
  213. def task_delay(self, task: str, start_time: datetime = None,
  214. success: bool=None, server: bool=True, target: datetime=None) -> None:
  215. """
  216. 设置下次运行时间 当然这个也是可以重写的
  217. :param target: 可以自定义的下次运行时间
  218. :param server: True
  219. :param success: 判断是成功的还是失败的时间间隔
  220. :param task: 任务名称,大驼峰的
  221. :param finish: 是完成任务后的时间为基准还是开始任务的时间为基准
  222. :return:
  223. """
  224. # 任务预处理
  225. if not task:
  226. task = self.task.command
  227. task = convert_to_underscore(task)
  228. task_object = getattr(self.model, task, None)
  229. if not task_object:
  230. logger.warning(f'No task named {task}')
  231. return
  232. scheduler = getattr(task_object, 'scheduler', None)
  233. if not scheduler:
  234. logger.warning(f'No scheduler in {task}')
  235. return
  236. # 任务开始时间
  237. if not start_time:
  238. start_time = datetime.now().replace(microsecond=0)
  239. # 依次判断是否有自定义的下次运行时间
  240. run = []
  241. if success is not None:
  242. interval = (
  243. scheduler.success_interval
  244. if success
  245. else scheduler.failure_interval
  246. )
  247. if isinstance(interval, str):
  248. interval = timedelta(interval)
  249. run.append(start_time + interval)
  250. # if server is not None:
  251. # if server:
  252. # server = scheduler.server_update
  253. # run.append(get_server_next_update(server))
  254. if target is not None:
  255. target = [target] if not isinstance(target, list) else target
  256. target = nearest_future(target)
  257. run.append(target)
  258. next_run = None
  259. # 排序
  260. if not len(run):
  261. raise ScriptError(
  262. "Missing argument in delay_next_run, should set at least one"
  263. )
  264. run = min(run).replace(microsecond=0)
  265. next_run = run
  266. # 将这些连接起来,方便日志输出
  267. kv = dict_to_kv(
  268. {
  269. "success": success,
  270. "server_update": server,
  271. "target": target,
  272. },
  273. allow_none=False,
  274. )
  275. logger.info(f"Delay task `{task}` to {next_run} ({kv})")
  276. # 强制设定下一次的运行时间
  277. if server and scheduler.server_update != time(hour=9):
  278. next_run = parse_tomorrow_server(scheduler.server_update)
  279. # 保证线程安全的
  280. self.lock_config.acquire()
  281. try:
  282. scheduler.next_run = next_run
  283. finally:
  284. self.lock_config.release()
  285. # 设置
  286. logger.attr(f'{task}.scheduler.next_run', next_run)
  287. self.save()
  288. @cached_property
  289. def notifier(self):
  290. notifier = Notifier(self.model.script.error.notify_config, enable=self.model.script.error.notify_enable)
  291. notifier.config_name = self.config_name.upper()
  292. logger.info(f'Notifier: {notifier.config_name}')
  293. return notifier
  294. if __name__ == '__main__':
  295. config = Config(config_name='oas1')
  296. config.update_scheduler()
  297. print(config.waiting_task)
  298. # print(config.get_next())