utils.py 9.7 KB

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