Python Cachier 项目教程

Python Cachier 项目教程

cachierPersistent, stale-free, local and cross-machine caching for Python functions.项目地址:https://gitcode.com/gh_mirrors/ca/cachier

1. 项目的目录结构及介绍

python-cachier/
├── cachier/
│   ├── __init__.py
│   ├── core.py
│   ├── mongo_core.py
│   ├── pickle_core.py
│   ├── cachier.py
│   └── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_cachier.py
│   └── test_core.py
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── requirements.txt

• cachier/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件，使目录成为一个Python包。
  • core.py: 核心功能实现。
  • mongo_core.py: MongoDB缓存核心实现。
  • pickle_core.py: Pickle缓存核心实现。
  • cachier.py: 主要功能文件，包含缓存装饰器等。
  • utils.py: 工具函数文件。
• tests/: 包含项目的测试文件。
  • __init__.py: 初始化文件，使目录成为一个Python包。
  • test_cachier.py: 测试cachier模块的文件。
  • test_core.py: 测试核心功能的文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• setup.py: 项目安装文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件主要是setup.py，它用于安装和管理项目的依赖。通过运行以下命令可以安装项目：

pip install .

3. 项目的配置文件介绍

项目没有专门的配置文件，但可以通过装饰器参数进行配置。例如：

from cachier import cachier

@cachier(cache_dir='~/temp/cache')
def my_function():
    pass

通过cache_dir参数可以指定缓存文件的存储路径。其他配置参数包括：

• pickle_reload: 是否在每次读取缓存时重新加载缓存文件。
• separate_files: 是否将缓存存储在多个文件中。
• allow_none: 是否缓存None值。

这些参数可以在装饰器中进行设置，以满足不同的缓存需求。

cachierPersistent, stale-free, local and cross-machine caching for Python functions.项目地址:https://gitcode.com/gh_mirrors/ca/cachier