zhenxun_bot/zhenxun/utils/time_utils.py
Rumio b993450a23
feat(limit, message): 引入声明式限流系统并增强消息格式化功能 (#1978)
- 新增 Cooldown、RateLimit、ConcurrencyLimit 三种限流依赖
- MessageUtils 支持动态格式化字符串 (format_args 参数)
- 插件CD限制消息显示精确剩余时间

- 重构限流逻辑至 utils/limiters.py,新增时间工具模块
- 整合时间工具函数并优化时区处理
- 新增 limiter_hook 自动释放资源,CooldownError 优化异常处理

- 冷却提示从固定文本改为动态显示剩余时间
- 示例:总结功能冷却中,请等待 1分30秒 后再试~

Co-authored-by: webjoin111 <455457521@qq.com>
Co-authored-by: HibiKier <45528451+HibiKier@users.noreply.github.com>
2025-07-15 17:13:33 +08:00

92 lines
2.6 KiB
Python

from datetime import date, datetime
import re
import pytz
class TimeUtils:
DEFAULT_TIMEZONE = pytz.timezone("Asia/Shanghai")
@classmethod
def get_day_start(cls, target_date: date | datetime | None = None) -> datetime:
"""获取某天的0点时间
返回:
datetime: 今天某天的0点时间
"""
if not target_date:
target_date = datetime.now(cls.DEFAULT_TIMEZONE)
if isinstance(target_date, datetime) and target_date.tzinfo is None:
target_date = cls.DEFAULT_TIMEZONE.localize(target_date)
return (
target_date.replace(hour=0, minute=0, second=0, microsecond=0)
if isinstance(target_date, datetime)
else datetime.combine(
target_date, datetime.min.time(), tzinfo=cls.DEFAULT_TIMEZONE
)
)
@classmethod
def is_valid_date(cls, date_text: str, separator: str = "-") -> bool:
"""日期是否合法
参数:
date_text: 日期
separator: 分隔符
返回:
bool: 日期是否合法
"""
try:
datetime.strptime(date_text, f"%Y{separator}%m{separator}%d")
return True
except ValueError:
return False
@classmethod
def parse_time_string(cls, time_str: str) -> int:
"""
将带有单位的时间字符串 (e.g., "10s", "5m", "1h") 解析为总秒数。
"""
time_str = time_str.lower().strip()
match = re.match(r"^(\d+)([smh])$", time_str)
if not match:
raise ValueError(
f"无效的时间格式: '{time_str}'。请使用如 '30s', '10m', '2h' 的格式。"
)
value, unit = int(match.group(1)), match.group(2)
if unit == "s":
return value
if unit == "m":
return value * 60
if unit == "h":
return value * 3600
return 0
@classmethod
def format_duration(cls, seconds: float) -> str:
"""
将秒数格式化为易于阅读的字符串 (例如 "1小时5分钟", "30.5秒")
"""
seconds = round(seconds, 1)
if seconds < 0.1:
return "不到1秒"
if seconds < 60:
return f"{seconds}"
minutes, sec_remainder = divmod(int(seconds), 60)
if minutes < 60:
if sec_remainder == 0:
return f"{minutes}分钟"
return f"{minutes}分钟{sec_remainder}"
hours, rem_minutes = divmod(minutes, 60)
if rem_minutes == 0:
return f"{hours}小时"
return f"{hours}小时{rem_minutes}分钟"