PyLRU 技术文档

1. 安装指南

安装方式

PyLRU 是一个用纯 Python 实现的 LRU 缓存库，支持 Python 2.6+ 及 3.x 系列。你可以通过以下命令安装 PyLRU：

pip install pylru

或者，你可以直接将 pylru.py 文件复制到你的项目中使用。

2. 项目的使用说明

基本用法

PyLRU 提供了一个 lrucache 类，它具有类似字典的接口，可以像字典一样使用。以下是基本的使用示例：

import pylru

size = 100  # 缓存的大小，即缓存中最多可以存储的键值对数量
cache = pylru.lrucache(size)  # 创建一个缓存对象

# 插入键值对
cache[key] = value

# 查找键对应的值
value = cache[key]

# 删除键值对
del cache[key]

# 测试键是否在缓存中
key in cache

# 查看缓存中的键
for key in cache:
    print(key)

缓存大小调整

你可以通过 size() 方法动态调整缓存的大小：

cache.size(200)  # 将缓存大小调整为200

清空缓存

使用 clear() 方法可以清空缓存中的所有内容：

cache.clear()

回调函数

lrucache 支持一个可选的回调函数，当缓存满时，最久未使用的键值对将被移除，此时回调函数会被调用：

def callback(key, value):
    print(f"Key {key} with value {value} was ejected from the cache.")

cache = pylru.lrucache(size, callback)

3. 项目API使用文档

lrucache 类

• __getitem__(key): 获取键 key 对应的值，如果键不存在则抛出 KeyError。
• __setitem__(key, value): 插入或更新键值对 (key, value)。
• __delitem__(key): 删除键 key 对应的键值对。
• __contains__(key): 检查键 key 是否在缓存中。
• peek(key): 获取键 key 对应的值，但不影响缓存顺序。
• keys(): 返回缓存中所有键的迭代器。
• values(): 返回缓存中所有值的迭代器。
• items(): 返回缓存中所有键值对的迭代器。
• size(): 返回当前缓存的大小。
• size(x): 设置缓存的大小为 x，并返回新的缓存大小。
• clear(): 清空缓存中的所有内容。

WriteThroughCacheManager 类

WriteThroughCacheManager 类用于将缓存与一个具有字典接口的后端存储对象结合使用，支持写入即同步的语义。

import pylru

size = 100
cached = pylru.WriteThroughCacheManager(store, size)

# 使用 cached 对象进行操作，缓存会自动管理
value = cached[key]
cached[key] = value
del cached[key]

WriteBackCacheManager 类

WriteBackCacheManager 类与 WriteThroughCacheManager 类似，但支持写回语义，即插入操作仅在缓存中更新，直到缓存中的数据被移除或显式调用 sync() 方法时才会写入后端存储。

import pylru

size = 100
cached = pylru.WriteBackCacheManager(store, size)

# 使用 cached 对象进行操作
value = cached[key]
cached[key] = value
del cached[key]

# 最后必须调用 sync() 方法确保所有数据写回后端存储
cached.sync()

4. 项目安装方式

通过 pip 安装

pip install pylru

直接使用源码

你可以直接将 pylru.py 文件复制到你的项目中，然后直接使用：

import pylru

通过以上步骤，你可以轻松安装并使用 PyLRU 缓存库，提升你的应用程序性能。