简介

cushy-storage是一个基于磁盘缓存的Python库，可以将Python对象序列化后缓存到磁盘中，以便下次使用时直接读取，从而提高程序的执行效率。另一方面， cushy-storage让你无需花费精力在如何制订一套数据存储规范上，字典般的操作可以减少很多开发的成本。

特性

可以方便的将数据进行本地磁盘存储
免去了直接操作文件的工作
像操作dict一样读写，十分方便
提供序列化操作
提供多种数据压缩方式

安装

pip install cushy-storage --upgrade

快速上手

cushy-storage 的使用主要分为三个类，BaseDict CushyDict disk_cache，其中CushyDict是BaseDict的增强版，可以实现 BaseDict的所有功能，还增加了相应序列化操作，因此推荐直接使用CushyDict来操作保存数据。

BaseDict类

BaseDict类是CushyDict类的基础实现，提供了基本的字典结构和缓存操作。它可以用于缓存任何类型的Python对象，但不支持序列化和反序列化操作。

from cushy_storage import BaseDict

# 初始化cache，保存在./data文件夹下
cache = BaseDict('./data')
# Base Dict只能存储二进制数据，可以用于流式传输
cache['key'] = b'value'
value = cache['key']
print(value)

CushyDict类

CushyDict类是BaseDict库的高级实现，增加了对值进行序列化和反序列化的功能。它支持多种序列化算法（包括pickle和json）和压缩算法（包括zlib和lzma），可以根据需要选择不同的算法进行数据压缩和序列化，下面是一些简单的使用教程。

from cushy_storage import CushyDict

# 初始化cache，保存在./data文件夹下
cache = CushyDict('./data')

cache['key'] = {'value': 42}
print(cache['key'])

cache['a'] = 1
print(cache['a'])

cache['b'] = "hello world"
print(cache['b'])

cache['arr'] = [1,2,3,4,5]
print(cache['arr'])

如果在初始化的时候不传入参数，则默认保存在./data文件夹下

from cushy_storage import CushyDict

cache = CushyDict()

判断key是否存在（和字典操作同理）

from cushy_storage import CushyDict

cache = CushyDict('./data')
if 'key' in cache:
    print("key exist")
else:
    print("key not exist")

用CushyDict存储对象信息

from cushy_storage import CushyDict


class User:
    def __init__(self, name, age):
        self.name = name
        self.age = age


def main():
    cache = CushyDict('./data', serialize='pickle')
    user = User("Jack", 18)
    cache['user'] = user

    print(cache['user'].name)
    print(cache['user'].age)


if __name__ == '__main__':
    main()

disk_cache装饰器函数

disk_cache装饰器函数可以将函数的输出结果缓存到磁盘中，以便下次使用时直接读取。通过该装饰器，可以在不改变原有代码逻辑的情况下，大幅度提高程序的执行效率。

from cushy_storage import disk_cache

@disk_cache('./data')
def my_func():
    return {'value': 42}

result = my_func()

待办

鸣谢

本项目基于github.com/RimoChan/ri… 进行二次开发改进，感谢RimoChan 大佬。

This project is based on github.com/RimoChan/ri… for secondary development and improvement. Thanks to RimoChan for his great work.

贡献

如果你想为这个项目做贡献，你可以提交pr或issue。我很高兴看到更多的人参与并优化它。

【cushy-storage】 一个基于磁盘缓存的Python框架

简介

特性

安装

快速上手

BaseDict类

CushyDict类

disk_cache装饰器函数

待办

鸣谢

贡献

【cushy-storage】一个基于磁盘缓存的Python框架