config.py 11 KB

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