CacheAbstract

类抽象基类源码

cache = CacheAbstract[Info, Data]()

缓存的抽象基类，其中Info和Data是泛型。

本项目中，Info和Data分别设置为CachedFileInfo和CachedData。

继承该基类，以提供缓存的更多实现。

抽象方法

is_in

flag: bool = cache.is_in(key: str)

抽象方法，用来检查key是否注册在了缓存中。

运算符__contains__委托给了该方法。

输入

参数	类型	必选	说明
key	str		要验证的关键字。

输出

参数	类型	说明
flag	bool	若取值True，则表明key给定的值存在于缓存中。

---

remove

info: Info = cache.remove(key: str)

抽象方法，用来将数据从缓存中移出为信息。

调用该方法、蕴含了数据结束生命周期的断言。调用后，只有缓存数据的信息仍然可用。

输入

参数	类型	必选	说明
key	str		将要从缓存中移除的数据的关键字。

输出

参数	类型	说明
info	Info	从缓存中所查询到的数据、对应的轻量化信息。

---

dump

cache.dump(key: str, info: Info, data: Data)

抽象方法，用来向缓存中置入数据。

输入

参数	类型	必选	说明
key	str		新数据的关键字。若该关键字key已存在于缓存中，则替换原值。
info	Info		要写入缓存中数据的轻量化信息。
data	Data		要写入缓存中的数据。

---

load

info, data_loader = cache.load(key: str)

抽象方法，用来透过某关键字，从缓存中载入数据。

输入

参数	类型	必选	说明
key	str		要查询数据的关键字。若该关键字key未找到，抛出FileNotFoundError。

输出

参数	类型	说明
info	Info	从缓存中所查询到的数据、对应的轻量化信息。
data_loader	Callable[[], Data]	缓存数据的懒加载器。该函数实现了一种延迟加载机制，从而允许大体量数据仅在需要使用的时候才实际加载。

方法

load_info

info: Info = cache.load_info(key: str)

透过某关键字，读取对应的元数据。

该方法的实现，基于获取load(key)[0]返回的值。

输入

参数	类型	必选	说明
key	str		要查询数据的关键字。若该关键字key未找到，抛出FileNotFoundError。

输出

参数	类型	说明
info	Info	从缓存中所查询到的数据、对应的轻量化信息。

---

load_data

data: Data = cache.load_data(key: str)

透过某关键字，加载对应的缓存数据。

该方法的实现，基于获取load(key)[1]()调用的结果。

输入

参数	类型	必选	说明
key	str		要查询数据的关键字。若该关键字key未找到，抛出FileNotFoundError。

输出

参数	类型	说明
data	Data	从缓存中所查询到的数据。由于data可能体量较大，该值在大多数情况下，应当定义为一个类文件对象。

运算符

__contains__

flag: bool = key in cache

检查key是否注册在了缓存中。

输入

参数	类型	必选	说明
key	str		要验证的关键字。

输出

参数	类型	说明
flag	bool	若取值True，则表明key给定的值存在于缓存中。