From 206efa3491e7ccff30cc4d09989d310b6c6f4e7f Mon Sep 17 00:00:00 2001 From: Yiling-J Date: Sun, 3 Nov 2024 15:44:56 +0800 Subject: [PATCH] bump core version and update readme --- README.md | 5 ++++- pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6029083..6ee8247 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # Theine + +**IMPORTANT: Theine is currently undergoing a major rewrite and refactor to become a thread-safe, high-performance concurrent cache. V2 will support free-threading in Python and will focus on enhancing multi-threading performance. Some APIs will change in the update.** + High performance in-memory cache inspired by [Caffeine](https://github.com/ben-manes/caffeine). - High performance [Rust core](https://github.com/Yiling-J/theine-core) @@ -63,7 +66,7 @@ Reference: https://static.usenix.org/event/usenix05/tech/general/full_papers/jiang/jiang_html/html.html -## API +## API (V1) Key should be a **Hashable** object, and value can be any **Python object**. If key type is not **str/int**, Theine will generate a unique key string automatically, this unique str will use extra space in memory and increase get/set/remove overhead. diff --git a/pyproject.toml b/pyproject.toml index 1542a5d..149026c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ license = "BSD-3-Clause" [tool.poetry.dependencies] python = ">=3.8,<4.0" typing-extensions = "^4.4.0" -theine-core = "^0.4.3" +theine-core = "^0.4.5" [tool.poetry.group.dev.dependencies] pytest = "^7.2.1"