memoshelve 0.1.2__tar.gz

memoshelve-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jason Gross
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

memoshelve-0.1.2/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: memoshelve
+Version: 0.1.2
+Summary: Add your description here
+Project-URL: Homepage, https://github.com/jxnl/memoshelve
+Project-URL: Bug Tracker, https://github.com/jxnl/memoshelve/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: robust
+Requires-Dist: dill>=0.4.0; extra == "robust"
+Requires-Dist: stablehash>=0.2.3; extra == "robust"
+Requires-Dist: typing-extensions>=4.14.1; extra == "robust"
+Provides-Extra: testing
+Requires-Dist: numpy>=2.3.2; extra == "testing"
+Requires-Dist: pytest>=8.4.1; extra == "testing"
+Requires-Dist: pytest-asyncio>=1.1.0; extra == "testing"
+Requires-Dist: memoshelve[robust]; extra == "testing"
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Requires-Dist: memoshelve[testing]; extra == "dev"
+Provides-Extra: all
+Requires-Dist: memoshelve[dev,robust,testing]; extra == "all"
+Dynamic: license-file
+
+# memoshelve
+
+A persistent memoization decorator using Python's `shelve` with two-tier caching (memory + disk).
+
+## Features
+
+- Two-tier caching: in-memory + persistent disk storage
+- Async and sync function support
+- Cache inspection and management
+- Optional enhanced serialization with `dill` and `stablehash`
+
+## Installation
+
+```bash
+pip install memoshelve
+
+# For enhanced serialization
+pip install memoshelve[robust]
+```
+
+## Usage
+
+### Basic Decorator
+
+```python
+from memoshelve import cache
+
+@cache(filename="cache.db")
+def expensive_function(x, y):
+    return x * y + 42
+
+result = expensive_function(10, 20)  # Computed and cached
+result = expensive_function(10, 20)  # Retrieved from cache
+```
+
+### Context Manager
+
+```python
+from memoshelve import memoshelve
+
+with memoshelve(expensive_function, "cache.db") as cached_fn:
+    result = cached_fn(10, 20)
+```
+
+### Async Functions
+
+```python
+@cache(filename="async_cache.db")
+async def async_function(data):
+    return len(data) * 42
+```
+
+## API
+
+### Cache Methods
+
+```python
+@cache(filename="example.db")
+def compute(x, y):
+    return x ** y
+
+# Check if cached
+compute.__contains__(2, 3)
+
+# Get without computing
+compute.get(2, 3)  # Raises KeyError if not cached
+
+# Get with status
+result, status = compute.__call_with_status__(2, 3)
+# status: "cached (mem)", "cached (disk)", or "miss"
+
+# Manual operations
+compute.put(2, 3, 8)      # Store value
+compute.uncache(2, 3)     # Remove from cache
+```
+
+### Configuration
+
+```python
+@cache(
+    filename="cache.db",
+    ignore=["debug"],         # Ignore parameters in cache key
+    get_hash=custom_hash,     # Custom hash function
+    disable=False,            # Toggle caching
+    print_cache_miss=True,    # Log cache misses
+)
+def my_function(data, debug=False):
+    return process(data)
+```
+
+### Cache Management
+
+```python
+from memoshelve import compact
+
+# Compact cache file
+compact("cache.db", backup=True)
+
+# Access metadata
+metadata = my_function.memoshelve
+metadata.disk_keys()     # Keys in disk cache
+metadata.mem_keys()      # Keys in memory cache
+metadata.compact()       # Compact this cache
+```
+
+## Storage
+
+Default cache location: `~/.cache/memoshelve/` (configurable via `XDG_CACHE_HOME`)
+
+Cache files use Python's `shelve` module and may create multiple files (`.db`, `.dir`, `.dat`).
+
+## License
+
+MIT License

memoshelve-0.1.2/README.md

@@ -0,0 +1,114 @@
+# memoshelve
+
+A persistent memoization decorator using Python's `shelve` with two-tier caching (memory + disk).
+
+## Features
+
+- Two-tier caching: in-memory + persistent disk storage
+- Async and sync function support
+- Cache inspection and management
+- Optional enhanced serialization with `dill` and `stablehash`
+
+## Installation
+
+```bash
+pip install memoshelve
+
+# For enhanced serialization
+pip install memoshelve[robust]
+```
+
+## Usage
+
+### Basic Decorator
+
+```python
+from memoshelve import cache
+
+@cache(filename="cache.db")
+def expensive_function(x, y):
+    return x * y + 42
+
+result = expensive_function(10, 20)  # Computed and cached
+result = expensive_function(10, 20)  # Retrieved from cache
+```
+
+### Context Manager
+
+```python
+from memoshelve import memoshelve
+
+with memoshelve(expensive_function, "cache.db") as cached_fn:
+    result = cached_fn(10, 20)
+```
+
+### Async Functions
+
+```python
+@cache(filename="async_cache.db")
+async def async_function(data):
+    return len(data) * 42
+```
+
+## API
+
+### Cache Methods
+
+```python
+@cache(filename="example.db")
+def compute(x, y):
+    return x ** y
+
+# Check if cached
+compute.__contains__(2, 3)
+
+# Get without computing
+compute.get(2, 3)  # Raises KeyError if not cached
+
+# Get with status
+result, status = compute.__call_with_status__(2, 3)
+# status: "cached (mem)", "cached (disk)", or "miss"
+
+# Manual operations
+compute.put(2, 3, 8)      # Store value
+compute.uncache(2, 3)     # Remove from cache
+```
+
+### Configuration
+
+```python
+@cache(
+    filename="cache.db",
+    ignore=["debug"],         # Ignore parameters in cache key
+    get_hash=custom_hash,     # Custom hash function
+    disable=False,            # Toggle caching
+    print_cache_miss=True,    # Log cache misses
+)
+def my_function(data, debug=False):
+    return process(data)
+```
+
+### Cache Management
+
+```python
+from memoshelve import compact
+
+# Compact cache file
+compact("cache.db", backup=True)
+
+# Access metadata
+metadata = my_function.memoshelve
+metadata.disk_keys()     # Keys in disk cache
+metadata.mem_keys()      # Keys in memory cache
+metadata.compact()       # Compact this cache
+```
+
+## Storage
+
+Default cache location: `~/.cache/memoshelve/` (configurable via `XDG_CACHE_HOME`)
+
+Cache files use Python's `shelve` module and may create multiple files (`.db`, `.dir`, `.dat`).
+
+## License
+
+MIT License

memoshelve-0.1.2/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "memoshelve"
+version = "0.1.2"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = []
+
+[project.optional-dependencies]
+# n.b. typing-extensions is required for stablehash, but not declared, cf https://github.com/NiklasRosenstein/python-stablehash/issues/9
+robust = ["dill>=0.4.0", "stablehash>=0.2.3", "typing-extensions>=4.14.1"]
+testing = [
+    "numpy>=2.3.2",
+    "pytest>=8.4.1",
+    "pytest-asyncio>=1.1.0",
+    "memoshelve[robust]",
+]
+dev = ["pre-commit>=4.2.0", "memoshelve[testing]"]
+all = ["memoshelve[robust,testing,dev]"]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[project.urls]
+"Homepage" = "https://github.com/jxnl/memoshelve"
+"Bug Tracker" = "https://github.com/jxnl/memoshelve/issues"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true

memoshelve-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+