Utils 模块

工具模块提供各种辅助功能和通用工具类。

工具集合

class Utils.abc.Repository[源代码]

基类:Dict[str, Any], ABC

提供键值存储功能的抽象基类。

继承自 Dict 实现字典的全部功能,同时作为抽象基类(ABC)提供接口规范。 重写 __getitem__ 方法使其在访问不存在的键时返回None而不是抛出KeyError。

该类可作为配置文件、设置存储等键值对存储机制的基类。

__init__() None[源代码]

初始化Repository实例。

get(key: str, default: Any = None) Any[源代码]

获取指定键的值,如果键不存在则返回默认值。

参数:
  • key (str) -- 要获取值的键

  • default (Any, optional) -- 键不存在时返回的默认值。默认为None

返回:

键对应的值或默认值

返回类型:

Any

set(key: str, value: Any) None[源代码]

设置指定键的值。

参数:
  • key (str) -- 要设置的键

  • value (Any) -- 要设置的值

__getitem__(key: str) Any[源代码]

重写字典的键访问方法,当键不存在时返回None而不是抛出KeyError。

此方法通过调用 get 方法实现安全访问。

参数:

key (str) -- 要访问的键

返回:

键对应的值,如果键不存在则返回None

返回类型:

Any

通用工具

通用工具模块

本模块提供各种通用的工具函数和辅助功能

Utils.tools.empty(*args, **kwargs) None[源代码]

空回调函数,接受任意参数但不执行任何操作。

这是一个通用的空操作函数,通常用作默认回调函数。在DEBUG日志级别下, 会记录调用此函数的详细信息,帮助开发者了解何时何地使用了默认回调。

参数:
  • *args -- 任意位置参数,将被忽略

  • **kwargs -- 任意关键字参数,将被忽略

返回:

总是返回 None

返回类型:

None

示例

>>> # 作为默认回调使用
>>> callback = empty
>>> callback("some", "args", key="value")  # 不会有任何输出
>>> # 在需要回调但不想执行任何操作时使用
>>> process_data(data, on_complete=empty)

备注

在DEBUG日志级别下,此函数会记录调用堆栈信息。 在生产环境中,为了性能考虑,建议将日志级别设置为INFO或更高。

Utils.tools.uuid_generate(username: str) str[源代码]

生成离线模式下的 UUID

根据用户名生成一个离线模式下的 UUID,使用 MD5 哈希算法

参数:

username (str): 玩家用户名

返回:

uuid.UUID: 生成的 UUID 对象

UUID 工具