工具函数

utils

工具模块.

Classes

Logger

Bases: Protocol

日志记录器协议.

定义了日志接口,用户可以提供自己的日志实现。

Source code in src/symphra_modules/utils/logger.py

class Logger(Protocol):
    """日志记录器协议.

    定义了日志接口,用户可以提供自己的日志实现。
    """

    def debug(self, message: str, **kwargs: Any) -> None:
        """记录 DEBUG 级别日志."""
        ...

    def info(self, message: str, **kwargs: Any) -> None:
        """记录 INFO 级别日志."""
        ...

    def warning(self, message: str, **kwargs: Any) -> None:
        """记录 WARNING 级别日志."""
        ...

    def error(self, message: str, **kwargs: Any) -> None:
        """记录 ERROR 级别日志."""
        ...

    def exception(self, message: str, **kwargs: Any) -> None:
        """记录异常信息."""
        ...

Functions

debug(message, **kwargs)

记录 DEBUG 级别日志.

源代码位于： src/symphra_modules/utils/logger.py

def debug(self, message: str, **kwargs: Any) -> None:
    """记录 DEBUG 级别日志."""
    ...

error(message, **kwargs)

记录 ERROR 级别日志.

源代码位于： src/symphra_modules/utils/logger.py

def error(self, message: str, **kwargs: Any) -> None:
    """记录 ERROR 级别日志."""
    ...

exception(message, **kwargs)

记录异常信息.

源代码位于： src/symphra_modules/utils/logger.py

def exception(self, message: str, **kwargs: Any) -> None:
    """记录异常信息."""
    ...

info(message, **kwargs)

记录 INFO 级别日志.

源代码位于： src/symphra_modules/utils/logger.py

def info(self, message: str, **kwargs: Any) -> None:
    """记录 INFO 级别日志."""
    ...

warning(message, **kwargs)

记录 WARNING 级别日志.

源代码位于： src/symphra_modules/utils/logger.py

def warning(self, message: str, **kwargs: Any) -> None:
    """记录 WARNING 级别日志."""
    ...

Functions

get_logger()

获取全局日志实例.

返回：

类型	描述
Logger	当前配置的日志记录器

源代码位于： src/symphra_modules/utils/logger.py

def get_logger() -> Logger:
    """获取全局日志实例.

    Returns:
        当前配置的日志记录器
    """
    return _global_logger

now()

获取当前 UTC 时间.

返回：

类型	描述
datetime	当前 UTC 时间戳

源代码位于： src/symphra_modules/utils/__init__.py

def now() -> datetime:
    """获取当前 UTC 时间.

    Returns:
        当前 UTC 时间戳
    """
    return datetime.now(UTC)

set_logger(logger)

设置全局日志实例.

参数：

名称	类型	描述	默认
logger	Logger	新的日志记录器实例	必需

源代码位于： src/symphra_modules/utils/logger.py

def set_logger(logger: Logger) -> None:
    """设置全局日志实例.

    Args:
        logger: 新的日志记录器实例
    """
    global _global_logger
    _global_logger = logger