v5.0.0 Update

.github/workflows/python-test.yml

@@ -2,17 +2,13 @@ name: python-test
 
 on:
   push:
-    branches:
-      - main
-
-  workflow_dispatch:
 
 permissions:
   contents: read
 
 jobs:
   test-python:
-    if: "contains(github.event.head_commit.message, '[run test]')"
+    if: "contains(github.event.head_commit.message, '!test')"
     name: test ${{ matrix.python-version }}
     strategy:
       fail-fast: false
@@ -54,7 +50,7 @@ jobs:
           HYPOTHESIS_PROFILE: slow
 
   test-os:
-    if: "contains(github.event.head_commit.message, '[run test]')"
+    if: "contains(github.event.head_commit.message, '!test')"
     name: test on ${{ matrix.os }}
 
     strategy:

.gitignore

@@ -2,4 +2,6 @@
 /target
 __pycache__
 *.so
-/.caches.rs
+/.coverage
+/.pytest_cache
+/htmlcov

CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v5.0.0 - Unreleased
+### Added
+- A new method named `random_key` added to `RRCache`.
+- A new method named `expire` added to `TTLCache`.
+- Some new methods added to `VTTLCache`: `expire`, `items_with_expire`.
+- `TTLCache` now supports `timedelta` as ttl.
+- `VTTLCache` now supports `timedelta` and `datetime` as ttl.
+- A new method `copy` added to all caches.
+
+### Changed
+- The core codes (rust code) renamed from `_cachebox` to `_core`. Instead of that, all of classes
+  implemented in Python which are using the core's classes. This change can help to customize the alghoritms.
+- Now the errors which occurred while doing `__eq__` operations will not be ignored.
+- Docstrings is now more complete.
+- The strictness in `__eq__` methods was reduced.
+- Add more strictness for loading pickle objects.
+- `LFUCache` now uses `VecDeque` instead of `Vec` (improves performance).
+- The `CacheInfo.cachememory` renamed to `CacheInfo.memory`.
+- *`isize` to `u64` strategy* changed in Rust.
+- `__repr__` methods refactored.
+
+### Removed
+- The `n` parameter of the `LRUCache.least_recently_used` method has been removed.
+- The deprecated `always_copy` parameter of the `cached` and `cachedmethod` decorators has been removed.
+
 ## 4.5.3 - 2025-03-31
 ### Changed
 - The `cached` and `cachedmethods` decorators cached the exceptions regardless of the number of waiters. This issue has now been resolved. Thanks to @pyfreyr for the issue [#23](https://github.com/awolverp/cachebox/issues/23).

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cachebox"
-version = "4.5.3"
+version = "5.0.0"
 edition = "2021"
 description = "The fastest memoizing and caching Python library written in Rust"
 readme = "README.md"
@@ -17,21 +17,37 @@ crate-type = ["cdylib"]
 codegen-units = 1
 debug = false
 incremental = false
-lto = "fat"
+lto = true
 panic = "abort"
 strip = "symbols"
 
-[dependencies]
-hashbrown = { version = "^0.14", default-features = false, features=["inline-more", "raw"]}
-fastrand = "^2.3"
-pyo3 = { version = "0.24.0", default-features = false, features=["macros", "extension-module"] }
-cfg-if = "1.0"
-parking_lot_core = { version = "^0.9", default-features = false }
-lock_api = { version = "^0.4", default-features = false }
-fxhash = {version = "^0.2"}
-
-[build-dependencies]
-pyo3-build-config = { version = "0.24.0", features = ["resolve-config"] }
+[dependencies.hashbrown]
+version = "0.14.5"
+default-features = false
+features = ["inline-more", "raw"]
+
+[dependencies.fastrand]
+version = "2.3.0"
+
+[dependencies.pyo3]
+version = "0.24.1"
+default-features = false
+features = ["macros", "extension-module"]
+
+[dependencies.cfg-if]
+version = "1.0.0"
+
+[dependencies.parking_lot_core]
+version = "0.9.10"
+default-features = false
+
+[dependencies.lock_api]
+version = "0.4.12"
+default-features = false
+
+[build-dependencies.pyo3-build-config]
+version = "0.24.1"
+features = ["resolve-config"]
 
 [lints.clippy]
 dbg_macro = "warn"

Makefile

@@ -1,43 +1,45 @@
-.DEFAULT_GOAL := all
-export CARGO_TERM_COLOR=$(shell (test -t 0 && echo "always") || echo "auto")
+help:
+	@echo "Commands:"
+	@echo -e "\tbuild-dev       build source"
+	@echo -e "\tbuild-prod      build source (release mode)"
+	@echo -e "\ttest-rs         clippy and test rust code"
+	@echo -e "\ttest-py         build and test python code"
+	@echo -e "\tformat          format rust and python code"
+	@echo -e "\tclean           clean all the unneeded files"
 
 .PHONY: build-dev
 build-dev:
 	maturin develop
 
-
 .PHONY: build-prod
 build-prod:
 	maturin develop --release
 
-
-.PHONY: test-py
-test-py:
-	maturin develop
-	RUST_BACKTRACE=1 pytest -vv
-	rm -rf .pytest_cache
-	ruff check .
-	ruff clean
-
-
 .PHONY: test-rs
 test-rs:
 	cargo clippy
+	cargo test -- --nocapture
 
+.PHONY: test-py
+test-py: build-dev
+	coverage run -m pytest -s -vv
+	-rm -rf .pytest_cache
+	-ruff check .
+	ruff clean
+	coverage html
 
 .PHONY: format
 format:
 	ruff format --line-length=100 .
 	ruff clean
 	cargo fmt
 
-
 .PHONY: clean
 clean:
 	-rm -rf `find . -name __pycache__`
-	-rm -rf cachebox/*.so
+	-rm -rf python/cachebox/*.so
 	-rm -rf target/release
-
-
-.PHONY: all
-all: format test-rs test-py clean
+	-rm -rf .pytest_cache
+	-rm -rf .coverage
+	-rm -rf htmlcov
+	-ruff clean