cachify 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

cachify/utils/decorator_factory.py

@@ -1,44 +1,44 @@
-import inspect
-from typing import Callable
-
-from cachify._async import async_decorator
-from cachify._sync import sync_decorator
-from cachify.types import CacheConfig, CacheKeyFunction, F, Number
-
-
-def create_cache_decorator(
-    ttl: Number,
-    never_die: bool,
-    cache_key_func: CacheKeyFunction | None,
-    ignore_fields: tuple[str, ...],
-    config: CacheConfig,
-) -> Callable[[F], F]:
-    """
-    Create a cache decorator with the given configuration.
-
-    This is a shared factory used by both memory_cache and redis_cache
-    to avoid code duplication.
-    """
-    if cache_key_func and ignore_fields:
-        raise ValueError("Either cache_key_func or ignore_fields can be provided, but not both")
-
-    def decorator(function: F) -> F:
-        if inspect.iscoroutinefunction(function):
-            return async_decorator(
-                function=function,
-                ttl=ttl,
-                never_die=never_die,
-                cache_key_func=cache_key_func,
-                ignore_fields=ignore_fields,
-                config=config,
-            )
-        return sync_decorator(
-            function=function,
-            ttl=ttl,
-            never_die=never_die,
-            cache_key_func=cache_key_func,
-            ignore_fields=ignore_fields,
-            config=config,
-        )
-
-    return decorator
+import inspect
+from typing import Callable
+
+from cachify._async import async_decorator
+from cachify._sync import sync_decorator
+from cachify.types import CacheConfig, CacheKeyFunction, F, Number
+
+
+def create_cache_decorator(
+    ttl: Number,
+    never_die: bool,
+    cache_key_func: CacheKeyFunction | None,
+    ignore_fields: tuple[str, ...],
+    config: CacheConfig,
+) -> Callable[[F], F]:
+    """
+    Create a cache decorator with the given configuration.
+
+    This is a shared factory used by both memory_cache and redis_cache
+    to avoid code duplication.
+    """
+    if cache_key_func and ignore_fields:
+        raise ValueError("Either cache_key_func or ignore_fields can be provided, but not both")
+
+    def decorator(function: F) -> F:
+        if inspect.iscoroutinefunction(function):
+            return async_decorator(
+                function=function,
+                ttl=ttl,
+                never_die=never_die,
+                cache_key_func=cache_key_func,
+                ignore_fields=ignore_fields,
+                config=config,
+            )
+        return sync_decorator(
+            function=function,
+            ttl=ttl,
+            never_die=never_die,
+            cache_key_func=cache_key_func,
+            ignore_fields=ignore_fields,
+            config=config,
+        )
+
+    return decorator

cachify/utils/functions.py

@@ -1,10 +1,10 @@
-import functools
-from typing import Any, Callable
-
-
-@functools.cache
-def get_function_id(function: Callable[..., Any]) -> str:
-    """
-    Returns the unique identifier for the function, which is a combination of its module and qualified name.
-    """
-    return f"{function.__module__}.{function.__qualname__}"
+import functools
+from typing import Any, Callable
+
+
+@functools.cache
+def get_function_id(function: Callable[..., Any]) -> str:
+    """
+    Returns the unique identifier for the function, which is a combination of its module and qualified name.
+    """
+    return f"{function.__module__}.{function.__qualname__}"

cachify/utils/locks.py

@@ -1,6 +1,6 @@
-import asyncio
-import threading
-from collections import defaultdict
-
-ASYNC_LOCKS: defaultdict[str, asyncio.Lock] = defaultdict(asyncio.Lock)
-SYNC_LOCKS: defaultdict[str, threading.Lock] = defaultdict(threading.Lock)
+import asyncio
+import threading
+from collections import defaultdict
+
+ASYNC_LOCKS: defaultdict[str, asyncio.Lock] = defaultdict(asyncio.Lock)
+SYNC_LOCKS: defaultdict[str, threading.Lock] = defaultdict(threading.Lock)

{cachify-0.1.0.dist-info → cachify-0.2.1.dist-info}/METADATA

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cachify
-Version: 0.1.0
+Version: 0.2.1
 Summary: A simple cache library with sync/async support, Memory and Redis backend
-Home-page: https://github.com/PulsarDataSolutions/cachify
 License: MIT
+License-File: LICENSE
 Keywords: cachify,cache,caching,redis,async,decorator,memoization
 Author: dynalz
 Author-email: git@pulsar.finance
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Dist: redis[hiredis] (>5.0.0)
+Project-URL: Homepage, https://github.com/PulsarDataSolutions/cachify
 Project-URL: Repository, https://github.com/PulsarDataSolutions/cachify
 Description-Content-Type: text/markdown
 
@@ -27,6 +28,19 @@ Description-Content-Type: text/markdown
 
 A simple and robust caching library for Python functions, supporting both synchronous and asynchronous code.
 
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Usage](#basic-usage)
+  - [Redis Cache](#redis-cache)
+  - [Never Die Cache](#never-die-cache)
+  - [Skip Cache](#skip-cache)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Features
 
 - Cache function results based on function ID and arguments
@@ -40,12 +54,14 @@ A simple and robust caching library for Python functions, supporting both synchr
 ## Installation
 
 ```bash
-# Clone the repository
-git clone https://github.com/PulsarDefi/cachify.git
-cd cachify
+# Using pip
+pip install cachify
+
+# Using poetry
+poetry add cachify
 
-# Install the package
-poetry install
+# Using uv
+uv add cachify
 ```
 
 ## Usage
@@ -56,18 +72,57 @@ poetry install
 from cachify import cache
 
 # Cache function in sync functions
-@cache(ttl=60) # ttl in seconds
+@cache(ttl=60)  # ttl in seconds
 def expensive_calculation(a, b):
     # Some expensive operation
     return a + b
 
 # And async functions
-@cache(ttl=3600) # ttl in seconds
+@cache(ttl=3600)  # ttl in seconds
 async def another_calculation(url):
     # Some expensive IO call
     return await httpx.get(url).json()
 ```
 
+### Decorator Parameters
+
+| Parameter        | Type              | Default | Description                                          |
+| ---------------- | ----------------- | ------- | ---------------------------------------------------- |
+| `ttl`            | `int \| float`    | `300`   | Time to live for cached items in seconds             |
+| `never_die`      | `bool`            | `False` | If True, cache refreshes automatically in background |
+| `cache_key_func` | `Callable`        | `None`  | Custom function to generate cache keys               |
+| `ignore_fields`  | `tuple[str, ...]` | `()`    | Function parameters to exclude from cache key        |
+
+### Custom Cache Key Function
+
+Use `cache_key_func` when you need custom control over how cache keys are generated:
+
+```python
+from cachify import cache
+
+def custom_key(args: tuple, kwargs: dict) -> str:
+    user_id = kwargs.get("user_id") or args[0]
+    return f"user:{user_id}"
+
+@cache(ttl=60, cache_key_func=custom_key)
+def get_user_profile(user_id: int):
+    return fetch_from_database(user_id)
+```
+
+### Ignore Fields
+
+Use `ignore_fields` to exclude specific parameters from the cache key. Useful when some arguments don't affect the result:
+
+```python
+from cachify import cache
+
+@cache(ttl=300, ignore_fields=("logger", "request_id"))
+def fetch_data(query: str, logger: Logger, request_id: str):
+    # Cache key only uses 'query', ignoring logger and request_id
+    logger.info(f"Fetching data for request {request_id}")
+    return database.execute(query)
+```
+
 ### Redis Cache
 
 For distributed caching across multiple processes or machines, use `rcache`:
@@ -79,7 +134,7 @@ from cachify import setup_redis_config, rcache
 # Configure Redis (call once at startup)
 setup_redis_config(
     sync_client=redis.from_url("redis://localhost:6379/0"),
-    key_prefix="myapp",       # default: "key_prefix", prefix searchable on redis "PREFIX:*"
+    key_prefix="myapp",       # default: "cachify", prefix searchable on redis "PREFIX:*"
     lock_timeout=10,          # default: 10, maximum lock lifetime in seconds
     on_error="silent",        # "silent" (default) or "raise" in case of redis errors
 )
@@ -94,7 +149,7 @@ import redis.asyncio as aredis
 setup_redis_config(async_client=aredis.from_url("redis://localhost:6379/0"))
 
 @rcache(ttl=300)
-def get_user_async(user_id: int) -> dict:
+async def get_user_async(user_id: int) -> dict:
     return await fetch_from_database(user_id)
 ```
 
@@ -165,7 +220,11 @@ Run the test scripts
 poetry run python -m pytest
 ```
 
+## Contributing
+
+Contributions are welcome! Feel free to open an issue or submit a pull request.
+
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/PulsarDataSolutions/cachify/blob/master/LICENSE) file for details.
 

cachify-0.2.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+cachify/__init__.py,sha256=OvqM85Qq3rO6-KilFjq4MO0rm_NBdTfzAo2uhBVksdU,550
+cachify/cache.py,sha256=zJM9J4DdBXyGquQUTDJJ_voC51p-RM_CQcC-4DM92Gg,4021
+cachify/config/__init__.py,sha256=ZvLLEsprTbKai3-uUTbZ6Axbgf-xw-7sxmz8Y62YdT4,98
+cachify/features/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cachify/features/never_die.py,sha256=NJvCJhHMjxxaVZCC5xrUATcBBm4OXXHdipOg6wjOfV4,7111
+cachify/memory_cache.py,sha256=2UEnYXSJJ0XlqVM7sJ2GkPW1reU7DRtfifHEdbJQrYY,1328
+cachify/redis/__init__.py,sha256=geuYVjwJdddlhrnt45cHzkJ7Anrhttm2F3Q3r0TTMLk,410
+cachify/redis/config.py,sha256=Gvlj_hrUlsIGYqu50dghrv83R5UEOMJa4jVeK-nBAOs,3558
+cachify/redis/lock.py,sha256=XbE5GHZIWUs9gqyfgle3Bur5CfKJ1pLhgtLctmZLB94,7281
+cachify/redis_cache.py,sha256=WVc26EpAVSyQptD3guDD2LuPDgnuL72BCvhln-n84hc,873
+cachify/storage/__init__.py,sha256=8FJOYwjg8LHVoNkyupdgKOR61LPfX5Bpz_mvnn-T-oU,250
+cachify/storage/memory_storage.py,sha256=rsQqoymWczzkfXisF-9Tc9UGQem936U6_vd9Uo-sWnU,1481
+cachify/storage/redis_storage.py,sha256=wZaKg7h98cmESpqiOmh906D5wfNBxYN80x-LQDLtb-c,4767
+cachify/types/__init__.py,sha256=OataAgBEQXxpc376uZFM6cmdzJLUkzkj_H8XiKq5zpU,2641
+cachify/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cachify/utils/arguments.py,sha256=7NcuntqxK7G1UV4wrIaLNfxE0E7Gr-MmPWi9U-JyQ9o,2000
+cachify/utils/decorator_factory.py,sha256=brraPKR7ZJqdTbp8s5tEk6D517CKOlo9z1ZLoqhoz_s,1325
+cachify/utils/functions.py,sha256=AA1GXJEEBsIr2NX9h6AslAdmqKaWUcjnf1q5kA216uY,312
+cachify/utils/locks.py,sha256=7x-4XK27NiM_Eu04pftUgEgu91w8B3rE15jjAl0g1AE,216
+cachify-0.2.1.dist-info/METADATA,sha256=pl450wfErW4M_deswdy9thDYahuDHno6p1LfJ3kdmHU,7432
+cachify-0.2.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+cachify-0.2.1.dist-info/entry_points.txt,sha256=a8B7GSYgDPfUClqct0o7yyBbJ61AWgSSy1idL6YZLUM,45
+cachify-0.2.1.dist-info/licenses/LICENSE,sha256=zUzOFiuoPIQzGktjk4kL78hpi57iWD6-Kug_96OgUO0,1071
+cachify-0.2.1.dist-info/RECORD,,

{cachify-0.1.0.dist-info → cachify-0.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any

{cachify-0.1.0.dist-info → cachify-0.2.1.dist-info/licenses}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Pulsar Finance
-
-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.
+MIT License
+
+Copyright (c) 2026 Pulsar Finance
+
+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.

cachify-0.1.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-cachify/__init__.py,sha256=5Q5eK7Pyty7-eSF99DBSa79FnKq27MGNiCYPkhY3uxo,553
-cachify/cache.py,sha256=Y1hh3t9DlcaG8KoVi3gZHevPzZf59WPIdDb_VsooHqo,4137
-cachify/config/__init__.py,sha256=xWH80AN6A2O2DlrY3ITkLYEkqnNv8WqGWhNAszVZq5w,102
-cachify/features/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cachify/features/never_die.py,sha256=A8sVAgVP-s6hlEs8FqrmHFg_-TJ8Bu8E8M_d3gwBpdg,7330
-cachify/memory_cache.py,sha256=9bDgV0Lb7ZB_ieARQmiKyi0nrn7E-cqQX9lH4d9xFFk,1365
-cachify/redis/__init__.py,sha256=4ZCbpo1tfU1O06pvIjerCuSR7XfopJly7mWgp9NZ_tg,429
-cachify/redis/config.py,sha256=ShaNvP6-vRnxWtFk3cD6lzMcPigpCM8FnFVBv21jxk4,3673
-cachify/redis/lock.py,sha256=NwrCa-z9fcXLvuaUrTsdCeNqoHIhR-Rm0J56fZ_0kT4,7513
-cachify/redis_cache.py,sha256=roQ3ENdqUe6n03nX4RFB0wrOKowUEcEY96BJV48hzRQ,900
-cachify/storage/__init__.py,sha256=p62r3EJPidhkHtw2OgV-gAH4U-wDtB8ZU_IbE5e3CdQ,259
-cachify/storage/memory_storage.py,sha256=lwSbCYqT4NyRwgPs8TMSjHIp5aTJs6bXmQmMKFOIhVM,1533
-cachify/storage/redis_storage.py,sha256=NOwWaSjca6591pMbLaHMmtelutXkAhxuWbFkoWChRnA,4905
-cachify/types/__init__.py,sha256=VpDvMLFAxVo-J9MISzE-liT-wiZzo4AYHG7cQgVi-TI,2736
-cachify/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cachify/utils/arguments.py,sha256=m4TMXmZ5nC9tDyS4BBDjsW41Q7L2LOx6zEWFN70ux70,2065
-cachify/utils/decorator_factory.py,sha256=5Cqz_QQDc7jVvVb_yscF41EC5o8mOda2nDeR6NvPGh8,1369
-cachify/utils/functions.py,sha256=QqpdJVvmwkPtHnPhFj5xpouJL_jQ29ySOjPkgvNg-Y0,322
-cachify/utils/locks.py,sha256=nvNnFuu3ooGpptH4-5tpaUU2YJmXlVqZ_GTQRWmKX7g,222
-cachify-0.1.0.dist-info/entry_points.txt,sha256=a8B7GSYgDPfUClqct0o7yyBbJ61AWgSSy1idL6YZLUM,45
-cachify-0.1.0.dist-info/LICENSE,sha256=nOY-lEC7Zaqf05sDxPYQ8iOGaShYMB2zf1Kr-M5hE-w,1092
-cachify-0.1.0.dist-info/METADATA,sha256=pkPXhJ5vOrtH8qi56CaESR_gI4B7c_iaZbg-ZNrlNVc,5340
-cachify-0.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-cachify-0.1.0.dist-info/RECORD,,