config.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  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
  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. logger.error(f'can not ask this variable {name}')
  97. return None # 或者抛出异常,或者返回其他默认值
  98. def gui_args(self, task: str) -> str:
  99. """
  100. 获取给gui显示的参数
  101. :return:
  102. """
  103. return self.model.gui_args(task=task)
  104. def get_arg(self, task: str, group: str, argument: str):
  105. """
  106. :param task:
  107. :param group:
  108. :param argument:
  109. :return: str/int/float
  110. """
  111. try:
  112. return self.data[task][group][argument]
  113. except:
  114. logger.exception(f'have no arg {task}.{group}.{argument}')
  115. def set_arg(self, task: str, group: str, argument: str, value) -> None:
  116. """
  117. :param task:
  118. :param group:
  119. :param argument:
  120. :param value:
  121. :return:
  122. """
  123. try:
  124. self.data[task][group][argument] = value
  125. except:
  126. logger.exception(f'have no arg {task}.{group}.{argument}')
  127. def save(self) -> None:
  128. """
  129. 保存配置文件
  130. :return:
  131. """
  132. self.model.write_json(self.config_name, self.model.dict())
  133. def update_scheduler(self) -> None:
  134. """
  135. 更新调度器, 设置pending_task and waiting_task
  136. :return:
  137. """
  138. pending_task = []
  139. waiting_task = []
  140. error = []
  141. now = datetime.now()
  142. for key, value in self.model.dict().items():
  143. func = Function(key, value)
  144. if not func.enable:
  145. continue
  146. if not isinstance(func.next_run, datetime):
  147. error.append(func)
  148. elif func.next_run < now:
  149. pending_task.append(func)
  150. else:
  151. waiting_task.append(func)
  152. # f = Filter(regex=r"(.*)", attr=["command"])
  153. # f.load(self.SCHEDULER_PRIORITY)
  154. if pending_task:
  155. pending_task = TaskScheduler.schedule(rule=self.model.script.optimization.schedule_rule,
  156. pending=pending_task)
  157. if waiting_task:
  158. # waiting_task = f.apply(waiting_task)
  159. waiting_task = sorted(waiting_task, key=operator.attrgetter("next_run"))
  160. if error:
  161. pending_task = error + pending_task
  162. self.pending_task = pending_task
  163. self.waiting_task = waiting_task
  164. def get_next(self) -> Function:
  165. """
  166. 获取下一个要执行的任务
  167. :return:
  168. """
  169. self.update_scheduler()
  170. if self.pending_task:
  171. logger.info(f"Pending tasks: {[f.command for f in self.pending_task]}")
  172. task = self.pending_task[0]
  173. logger.attr("Task", task)
  174. return task
  175. # 哪怕是没有任务,也要返回一个任务,这样才能保证调度器正常运行
  176. if self.waiting_task:
  177. logger.info("No task pending")
  178. task = copy.deepcopy(self.waiting_task[0])
  179. # task.next_run = (task.next_run + self.hoarding).replace(microsecond=0)
  180. logger.attr("Task", task)
  181. return task
  182. else:
  183. logger.critical("No task waiting or pending")
  184. logger.critical("Please enable at least one task")
  185. raise RequestHumanTakeover
  186. def task_call(self, task: str=None, force_call=True):
  187. """
  188. 回调任务,这会是在任务结束后调用
  189. :param task: 调用的任务的大写名称
  190. :param force_call:
  191. :return:
  192. """
  193. task = convert_to_underscore(task)
  194. if self.model.deep_get(self.model, keys=f'{task}.scheduler.next_run') is None:
  195. raise ScriptError(f"Task to call: `{task}` does not exist in user config")
  196. task_enable = self.model.deep_get(self.model, keys=f'{task}.scheduler.enable')
  197. if force_call or task_enable:
  198. logger.info(f"Task call: {task}")
  199. next_run = datetime.now().replace(
  200. microsecond=0
  201. )
  202. self.model.deep_set(self.model, keys=f'{task}.scheduler.next_run', value=next_run)
  203. self.save()
  204. return True
  205. else:
  206. logger.info(f"Task call: {task} (skipped because disabled by user)")
  207. return False
  208. def task_delay(self, task: str, start_time: datetime = None,
  209. success: bool=None, server: bool=True, target: timedelta=None) -> None:
  210. """
  211. 设置下次运行时间 当然这个也是可以重写的
  212. :param target: 可以自定义的下次运行时间
  213. :param server: True
  214. :param success: 判断是成功的还是失败的时间间隔
  215. :param task: 任务名称,大驼峰的
  216. :param finish: 是完成任务后的时间为基准还是开始任务的时间为基准
  217. :return:
  218. """
  219. # 任务预处理
  220. if not task:
  221. task = self.task.command
  222. task = convert_to_underscore(task)
  223. task_object = getattr(self.model, task, None)
  224. if not task_object:
  225. logger.warning(f'No task named {task}')
  226. return
  227. scheduler = getattr(task_object, 'scheduler', None)
  228. if not scheduler:
  229. logger.warning(f'No scheduler in {task}')
  230. return
  231. # 任务开始时间
  232. if not start_time:
  233. start_time = datetime.now().replace(microsecond=0)
  234. # 依次判断是否有自定义的下次运行时间
  235. run = []
  236. if success is not None:
  237. interval = (
  238. scheduler.success_interval
  239. if success
  240. else scheduler.failure_interval
  241. )
  242. run.append(start_time + interval)
  243. # if server is not None:
  244. # if server:
  245. # server = scheduler.server_update
  246. # run.append(get_server_next_update(server))
  247. if target is not None:
  248. target = [target] if not isinstance(target, list) else target
  249. target = nearest_future(target)
  250. run.append(target)
  251. next_run = None
  252. # 排序
  253. if not len(run):
  254. raise ScriptError(
  255. "Missing argument in delay_next_run, should set at least one"
  256. )
  257. run = min(run).replace(microsecond=0)
  258. next_run = run
  259. # 将这些连接起来,方便日志输出
  260. kv = dict_to_kv(
  261. {
  262. "success": success,
  263. "server_update": server,
  264. "target": target,
  265. },
  266. allow_none=False,
  267. )
  268. logger.info(f"Delay task `{task}` to {next_run} ({kv})")
  269. # 强制设定下一次的运行时间
  270. if server and scheduler.server_update != time(hour=9):
  271. next_run = parse_tomorrow_server(scheduler.server_update)
  272. # 设置
  273. logger.attr(f'{task}.scheduler.next_run', next_run)
  274. scheduler.next_run = next_run
  275. self.save()
  276. @cached_property
  277. def notifier(self):
  278. notifier = Notifier(self.model.script.error.notify_config, enable=self.model.script.error.notify_enable)
  279. notifier.config_name = self.config_name.upper()
  280. logger.info(f'Notifier: {notifier.config_name}')
  281. return notifier
  282. if __name__ == '__main__':
  283. config = Config(config_name='oas1')
  284. config.update_scheduler()
  285. print(config.pending_task)
  286. print(config.waiting_task)
  287. config.update_scheduler()
  288. print(config.pending_task)
  289. # print(config.get_next())