utils.py 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import os
  5. import json
  6. import yaml
  7. from filelock import FileLock
  8. from datetime import datetime, timedelta, timezone, time
  9. from module.config.atomicwrites import atomic_write
  10. from module.logger import logger
  11. DEFAULT_TIME = datetime(2023, 1, 1, 0, 0)
  12. def filepath_config(filename, mod_name='script') -> str:
  13. """
  14. 返回配置文件的路径
  15. """
  16. if mod_name == 'script':
  17. return os.path.join('./config', f'{filename}.json')
  18. else:
  19. return os.path.join('./config', f'{filename}.{mod_name}.json')
  20. def filepath_args(filename='args', mod_name='alas'):
  21. return f'./module/config/argument/{filename}.json'
  22. def filepath_argument(filename):
  23. return f'./module/config/argument/{filename}.yaml'
  24. def read_file(file: str):
  25. """
  26. Read a file, support both .yaml and .json format.
  27. Return empty dict if file not exists.
  28. Args:
  29. file (str):
  30. Returns:
  31. dict, list:
  32. """
  33. folder = os.path.dirname(file)
  34. if not os.path.exists(folder):
  35. os.mkdir(folder)
  36. if not os.path.exists(file):
  37. return {}
  38. _, ext = os.path.splitext(file)
  39. lock = FileLock(f"{file}.lock")
  40. with lock:
  41. logger.debug(f'read: {file}')
  42. if ext == '.yaml':
  43. with open(file, mode='r', encoding='utf-8') as f:
  44. s = f.read()
  45. data = list(yaml.safe_load_all(s))
  46. if len(data) == 1:
  47. data = data[0]
  48. if not data:
  49. data = {}
  50. return data
  51. elif ext == '.json':
  52. with open(file, mode='r', encoding='utf-8') as f:
  53. s = f.read()
  54. return json.loads(s)
  55. else:
  56. logger.warning(f'Unsupported config file extension: {ext}')
  57. return {}
  58. def write_file(file: str, data):
  59. """
  60. Write data into a file, supports both .yaml and .json format.
  61. Args:
  62. file (str):
  63. data (dict, list):
  64. """
  65. folder = os.path.dirname(file)
  66. if not os.path.exists(folder):
  67. os.mkdir(folder)
  68. _, ext = os.path.splitext(file)
  69. lock = FileLock(f"{file}.lock")
  70. with lock:
  71. logger.debug(f'write: {file}')
  72. if ext == '.yaml':
  73. with atomic_write(file, overwrite=True, encoding='utf-8', newline='') as f:
  74. if isinstance(data, list):
  75. yaml.safe_dump_all(data, f, default_flow_style=False, encoding='utf-8', allow_unicode=True,
  76. sort_keys=False)
  77. else:
  78. yaml.safe_dump(data, f, default_flow_style=False, encoding='utf-8', allow_unicode=True,
  79. sort_keys=False)
  80. elif ext == '.json':
  81. with atomic_write(file, overwrite=True, encoding='utf-8', newline='') as f:
  82. s = json.dumps(data, indent=2, ensure_ascii=False, sort_keys=False, default=str)
  83. f.write(s)
  84. else:
  85. logger.warning(f'Unsupported config file extension: {ext}')
  86. def deep_iter(data, depth=0, current_depth=1):
  87. """
  88. Iter a dictionary safely.
  89. Args:
  90. data (dict):
  91. depth (int): Maximum depth to iter
  92. current_depth (int):
  93. Returns:
  94. list: Key path
  95. Any:
  96. """
  97. if isinstance(data, dict) \
  98. and (depth and current_depth <= depth):
  99. for key, value in data.items():
  100. for child_path, child_value in deep_iter(value, depth=depth, current_depth=current_depth + 1):
  101. yield [key] + child_path, child_value
  102. else:
  103. yield [], data
  104. def server_timezone() -> timedelta:
  105. return timedelta(hours=8)
  106. def server_time_offset() -> timedelta:
  107. """
  108. To convert local time to server time:
  109. server_time = local_time + server_time_offset()
  110. To convert server time to local time:
  111. local_time = server_time - server_time_offset()
  112. """
  113. return datetime.now(timezone.utc).astimezone().utcoffset() - server_timezone()
  114. def get_server_next_update(daily_trigger):
  115. """
  116. Args:
  117. daily_trigger (list[str], str): [ "00:00", "12:00", "18:00",]
  118. Returns:
  119. datetime.datetime
  120. """
  121. if isinstance(daily_trigger, str):
  122. daily_trigger = daily_trigger.replace(' ', '').split(',')
  123. diff = server_time_offset()
  124. local_now = datetime.now()
  125. trigger = []
  126. for t in daily_trigger:
  127. h, m = [int(x) for x in t.split(':')]
  128. future = local_now.replace(hour=h, minute=m, second=0, microsecond=0) + diff
  129. s = (future - local_now).total_seconds() % 86400
  130. future = local_now + timedelta(seconds=s)
  131. trigger.append(future)
  132. update = sorted(trigger)[0]
  133. return update
  134. def convert_to_underscore(text: str) -> str:
  135. """
  136. 大驼峰形式的字符串转换为下划线形式的字符串,并在数字前插入下划线。如果字符串中已经包含下划线,则会直接返回原始字符串。
  137. :param text:
  138. :return:
  139. """
  140. if '_' in text:
  141. # If text already contains underscore, assume it's in the correct format
  142. return text
  143. text = text.replace(' ', '')
  144. result = ''
  145. for i, char in enumerate(text):
  146. if char.isupper():
  147. if i > 0 and (text[i-1].islower() or (i < len(text) - 1 and text[i+1].islower())):
  148. # Insert underscore before uppercase letter, except at the beginning
  149. result += '_'
  150. result += char.lower()
  151. elif char.isdigit():
  152. if i > 0 and (text[i-1].isalpha() or (i < len(text) - 1 and text[i+1].isalpha())):
  153. # Insert underscore before digit, except at the beginning
  154. result += '_'
  155. result += char
  156. else:
  157. result += char
  158. return result
  159. def get_server_last_update(daily_trigger):
  160. """
  161. Args:
  162. daily_trigger (list[str], str): [ "00:00", "12:00", "18:00",]
  163. Returns:
  164. datetime.datetime
  165. """
  166. if isinstance(daily_trigger, str):
  167. daily_trigger = daily_trigger.replace(' ', '').split(',')
  168. diff = server_time_offset()
  169. local_now = datetime.now()
  170. trigger = []
  171. for t in daily_trigger:
  172. h, m = [int(x) for x in t.split(':')]
  173. future = local_now.replace(hour=h, minute=m, second=0, microsecond=0) + diff
  174. s = (future - local_now).total_seconds() % 86400 - 86400
  175. future = local_now + timedelta(seconds=s)
  176. trigger.append(future)
  177. update = sorted(trigger)[-1]
  178. return update
  179. def nearest_future(future, interval=120):
  180. """
  181. Get the neatest future time.
  182. Return the last one if two things will finish within `interval`.
  183. Args:
  184. future (list[datetime.datetime]):
  185. interval (int): Seconds
  186. Returns:
  187. datetime.datetime:
  188. """
  189. future = [datetime.fromisoformat(f) if isinstance(f, str) else f for f in future]
  190. future = sorted(future)
  191. next_run = future[0]
  192. for finish in future:
  193. if finish - next_run < timedelta(seconds=interval):
  194. next_run = finish
  195. return next_run
  196. def dict_to_kv(dictionary, allow_none=True):
  197. """
  198. Args:
  199. dictionary: Such as `{'path': 'Scheduler.ServerUpdate', 'value': True}`
  200. allow_none (bool):
  201. Returns:
  202. str: Such as `path='Scheduler.ServerUpdate', value=True`
  203. """
  204. return ', '.join([f'{k}={repr(v)}' for k, v in dictionary.items() if allow_none or v is not None])
  205. def parse_tomorrow_server(server_update: time, delay_date: int = 1, float_seconds: int = 0) -> datetime:
  206. """
  207. 获取明天的日期,给这个日期加上server_update的时间,返回datetime
  208. :param server_update:
  209. :param float_seconds: 浮动的秒数,可为正或负值
  210. :return:
  211. """
  212. if isinstance(server_update, str):
  213. server_update = time.fromisoformat(server_update)
  214. now = datetime.now()
  215. tomorrow = now + timedelta(days=delay_date)
  216. next_run = datetime.combine(tomorrow, server_update)
  217. # 应用浮动时间
  218. if float_seconds !=0:
  219. next_run += timedelta(seconds=float_seconds)
  220. # 确保时间在第二天内,不回退到前一天,不跨越到第三天(考虑任务时间,最早 00:00,最晚 23:50)
  221. start_of_tomorrow = datetime.combine(tomorrow, time.min)
  222. end_of_tomorrow = datetime.combine(tomorrow, time(hour=23, minute=50))
  223. if next_run < start_of_tomorrow:
  224. next_run = start_of_tomorrow
  225. elif next_run > end_of_tomorrow:
  226. next_run = end_of_tomorrow
  227. return next_run
  228. def deep_get(d, keys, default=None):
  229. """
  230. Get values in dictionary safely.
  231. https://stackoverflow.com/questions/25833613/safe-method-to-get-value-of-nested-dictionary
  232. Args:
  233. d (dict):
  234. keys (str, list): Such as `Scheduler.NextRun.value`
  235. default: Default return if key not found.
  236. Returns:
  237. """
  238. if isinstance(keys, str):
  239. keys = keys.split('.')
  240. assert type(keys) is list
  241. if d is None:
  242. return default
  243. if not keys:
  244. return d
  245. return deep_get(d.get(keys[0]), keys[1:], default)
  246. def deep_set(d, keys, value):
  247. """
  248. Set value into dictionary safely, imitating deep_get().
  249. """
  250. if isinstance(keys, str):
  251. keys = keys.split('.')
  252. assert type(keys) is list
  253. if not keys:
  254. return value
  255. if not isinstance(d, dict):
  256. d = {}
  257. d[keys[0]] = deep_set(d.get(keys[0], {}), keys[1:], value)
  258. return d
  259. def deep_pop(d, keys, default=None):
  260. """
  261. Pop value from dictionary safely, imitating deep_get().
  262. """
  263. if isinstance(keys, str):
  264. keys = keys.split('.')
  265. assert type(keys) is list
  266. if not isinstance(d, dict):
  267. return default
  268. if not keys:
  269. return default
  270. elif len(keys) == 1:
  271. return d.pop(keys[0], default)
  272. return deep_pop(d.get(keys[0]), keys[1:], default)
  273. if __name__ == '__main__':
  274. print(parse_tomorrow_server("09:01:00"))