rapyer 1.2.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

rapyer/__init__.py

@@ -7,6 +7,7 @@ from rapyer.base import (
     find_redis_models,
     ainsert,
     alock_from_key,
+    apipeline,
 )
 from rapyer.init import init_rapyer, teardown_rapyer
 
@@ -19,4 +20,5 @@ __all__ = [
     "find_redis_models",
     "ainsert",
     "alock_from_key",
+    "apipeline",
 ]

rapyer/base.py

@@ -18,12 +18,10 @@ from pydantic import (
     ValidationError,
 )
 from pydantic_core.core_schema import FieldSerializationInfo, ValidationInfo
-from redis.commands.search.index_definition import IndexDefinition, IndexType
-from redis.commands.search.query import Query
-from redis.exceptions import NoScriptError, ResponseError
+from redis.client import Pipeline
 
 from rapyer.config import RedisConfig
-from rapyer.context import _context_var, _context_xx_pipe
+from rapyer.context import _context_var
 from rapyer.errors.base import (
     KeyNotFound,
     PersistentNoScriptError,
@@ -36,7 +34,7 @@ from rapyer.fields.index import IndexAnnotation
 from rapyer.fields.key import KeyAnnotation
 from rapyer.fields.safe_load import SafeLoadAnnotation
 from rapyer.links import REDIS_SUPPORTED_LINK
-from rapyer.scripts import handle_noscript_error
+from rapyer.scripts import registry as scripts_registry
 from rapyer.types.base import RedisType, REDIS_DUMP_FLAG_NAME, FAILED_FIELDS_KEY
 from rapyer.types.convert import RedisConverter
 from rapyer.typing_support import Self, Unpack
@@ -56,6 +54,9 @@ from rapyer.utils.redis import (
     acquire_lock,
     update_keys_in_pipeline,
 )
+from redis.commands.search.index_definition import IndexDefinition, IndexType
+from redis.commands.search.query import Query
+from redis.exceptions import NoScriptError, ResponseError
 
 logger = logging.getLogger("rapyer")
 
@@ -150,6 +151,10 @@ class AtomicRedisModel(BaseModel):
         field_path = self.field_path
         return f"${field_path}" if field_path else "$"
 
+    @property
+    def client(self):
+        return _context_var.get() or self.Meta.redis
+
     @classmethod
     def should_refresh(cls):
         return cls.Meta.refresh_ttl and cls.Meta.ttl is not None
@@ -312,10 +317,10 @@ class AtomicRedisModel(BaseModel):
 
     async def asave(self) -> Self:
         model_dump = self.redis_dump()
-        await self.Meta.redis.json().set(self.key, self.json_path, model_dump)
+        await self.client.json().set(self.key, self.json_path, model_dump)
         if self.Meta.ttl is not None:
             nx = not self.Meta.refresh_ttl
-            await self.Meta.redis.expire(self.key, self.Meta.ttl, nx=nx)
+            await self.client.expire(self.key, self.Meta.ttl, nx=nx)
         return self
 
     def redis_dump(self):
@@ -533,7 +538,9 @@ class AtomicRedisModel(BaseModel):
     async def apipeline(
         self, ignore_redis_error: bool = False
     ) -> AbstractAsyncContextManager[Self]:
-        async with self.Meta.redis.pipeline(transaction=True) as pipe:
+        async with apipeline(
+            ignore_redis_error=ignore_redis_error, _meta=self.Meta
+        ) as pipe:
             try:
                 redis_model = await self.__class__.aget(self.key)
                 unset_fields = {
@@ -545,57 +552,13 @@ class AtomicRedisModel(BaseModel):
                     redis_model = self
                 else:
                     raise
-            _context_var.set(pipe)
-            _context_xx_pipe.set(ignore_redis_error)
             yield redis_model
-            commands_backup = list(pipe.command_stack)
-            noscript_on_first_attempt = False
-            noscript_on_retry = False
-
-            try:
-                if self.should_refresh():
-                    pipe.expire(self.key, self.Meta.ttl)
-                await pipe.execute()
-            except NoScriptError:
-                noscript_on_first_attempt = True
-            except ResponseError as exc:
-                if ignore_redis_error:
-                    logger.warning(
-                        "Swallowed ResponseError during pipeline.execute() with "
-                        "ignore_redis_error=True for key %r: %s",
-                        getattr(self, "key", None),
-                        exc,
-                    )
-                else:
-                    raise
-
-            if noscript_on_first_attempt:
-                await handle_noscript_error(self.Meta.redis)
-                evalsha_commands = [
-                    (args, options)
-                    for args, options in commands_backup
-                    if args[0] == "EVALSHA"
-                ]
-                # Retry execute the pipeline actions
-                async with self.Meta.redis.pipeline(transaction=True) as retry_pipe:
-                    for args, options in evalsha_commands:
-                        retry_pipe.execute_command(*args, **options)
-                    try:
-                        await retry_pipe.execute()
-                    except NoScriptError:
-                        noscript_on_retry = True
-
-            if noscript_on_retry:
-                raise PersistentNoScriptError(
-                    "NOSCRIPT error persisted after re-registering scripts. "
-                    "This indicates a server-side problem with Redis."
-                )
 
-            _context_var.set(None)
-            _context_xx_pipe.set(False)
+            if self.should_refresh():
+                pipe.expire(self.key, self.Meta.ttl)
 
     def __setattr__(self, name: str, value: Any) -> None:
-        if name not in self.__annotations__ or value is None:
+        if name not in self.__class__.model_fields or value is None:
             super().__setattr__(name, value)
             return
 
@@ -723,3 +686,56 @@ async def alock_from_key(
         yield redis_model
         if save_at_end and redis_model is not None:
             await redis_model.asave()
+
+
+@contextlib.asynccontextmanager
+async def apipeline(
+    ignore_redis_error: bool = False, _meta: RedisConfig = None
+) -> AbstractAsyncContextManager[Pipeline]:
+    _meta = _meta or AtomicRedisModel.Meta
+    redis = _meta.redis
+    async with redis.pipeline(transaction=True) as pipe:
+        pipe_prev = _context_var.set(pipe)
+    try:
+        yield pipe
+        commands_backup = list(pipe.command_stack)
+        noscript_on_first_attempt = False
+        noscript_on_retry = False
+
+        try:
+            await pipe.execute()
+        except NoScriptError:
+            noscript_on_first_attempt = True
+        except ResponseError as exc:
+            if ignore_redis_error:
+                logger.warning(
+                    "Swallowed ResponseError during pipeline.execute() with "
+                    "ignore_redis_error=True: %s",
+                    exc,
+                )
+            else:
+                raise
+
+        if noscript_on_first_attempt:
+            await scripts_registry.handle_noscript_error(redis, _meta)
+            evalsha_commands = [
+                (args, options)
+                for args, options in commands_backup
+                if args[0] == "EVALSHA"
+            ]
+            # Retry execute the pipeline actions
+            async with redis.pipeline(transaction=True) as retry_pipe:
+                for args, options in evalsha_commands:
+                    retry_pipe.execute_command(*args, **options)
+                try:
+                    await retry_pipe.execute()
+                except NoScriptError:
+                    noscript_on_retry = True
+
+        if noscript_on_retry:
+            raise PersistentNoScriptError(
+                "NOSCRIPT error persisted after re-registering scripts. "
+                "This indicates a server-side problem with Redis."
+            )
+    finally:
+        _context_var.reset(pipe_prev)

rapyer/context.py

@@ -7,6 +7,3 @@ from redis.asyncio.client import Redis
 _context_var: contextvars.ContextVar[Optional["Redis"]] = contextvars.ContextVar(
     "redis", default=None
 )
-_context_xx_pipe: contextvars.ContextVar[bool] = contextvars.ContextVar(
-    "redis_xx_pipe", default=False
-)

rapyer/scripts/constants.py

@@ -1,3 +1,6 @@
+REDIS_VARIANT = "redis"
+FAKEREDIS_VARIANT = "fakeredis"
+
 REMOVE_RANGE_SCRIPT_NAME = "remove_range"
 NUM_MUL_SCRIPT_NAME = "num_mul"
 NUM_FLOORDIV_SCRIPT_NAME = "num_floordiv"

rapyer/scripts/loader.py

@@ -1,9 +1,10 @@
 from functools import lru_cache
 from importlib import resources
 
+from rapyer.scripts.constants import FAKEREDIS_VARIANT, REDIS_VARIANT
 
 VARIANTS = {
-    "redis": {
+    REDIS_VARIANT: {
         "EXTRACT_ARRAY": "local arr = cjson.decode(arr_json)[1]",
         "EXTRACT_VALUE": "local value = tonumber(cjson.decode(current_json)[1])",
         "EXTRACT_STR": "local value = cjson.decode(current_json)[1]",
@@ -19,7 +20,7 @@ else
     extracted = parsed
 end""",
     },
-    "fakeredis": {
+    FAKEREDIS_VARIANT: {
         "EXTRACT_ARRAY": "local arr = cjson.decode(arr_json)",
         "EXTRACT_VALUE": "local value = tonumber(cjson.decode(current_json)[1])",
         "EXTRACT_STR": "local value = cjson.decode(current_json)[1]",
@@ -45,7 +46,7 @@ def _load_template(category: str, name: str) -> str:
     return resources.files(package).joinpath(filename).read_text()
 
 
-def load_script(category: str, name: str, variant: str = "redis") -> str:
+def load_script(category: str, name: str, variant: str = REDIS_VARIANT) -> str:
     template = _load_template(category, name)
     replacements = VARIANTS[variant]
     result = template

rapyer/scripts/registry.py

@@ -1,19 +1,27 @@
-from rapyer.errors import ScriptsNotInitializedError
+from typing import TYPE_CHECKING
+
+from rapyer.errors import PersistentNoScriptError, ScriptsNotInitializedError
 from rapyer.scripts.constants import (
     DATETIME_ADD_SCRIPT_NAME,
     DICT_POP_SCRIPT_NAME,
     DICT_POPITEM_SCRIPT_NAME,
+    FAKEREDIS_VARIANT,
     NUM_FLOORDIV_SCRIPT_NAME,
     NUM_MOD_SCRIPT_NAME,
     NUM_MUL_SCRIPT_NAME,
     NUM_POW_FLOAT_SCRIPT_NAME,
     NUM_POW_SCRIPT_NAME,
     NUM_TRUEDIV_SCRIPT_NAME,
+    REDIS_VARIANT,
     REMOVE_RANGE_SCRIPT_NAME,
     STR_APPEND_SCRIPT_NAME,
     STR_MUL_SCRIPT_NAME,
 )
 from rapyer.scripts.loader import load_script
+from redis.exceptions import NoScriptError
+
+if TYPE_CHECKING:
+    from rapyer.config import RedisConfig
 
 SCRIPT_REGISTRY: list[tuple[str, str, str]] = [
     ("list", "remove_range", REMOVE_RANGE_SCRIPT_NAME),
@@ -41,15 +49,15 @@ def _build_scripts(variant: str) -> dict[str, str]:
 
 
 def get_scripts() -> dict[str, str]:
-    return _build_scripts("redis")
+    return _build_scripts(REDIS_VARIANT)
 
 
 def get_scripts_fakeredis() -> dict[str, str]:
-    return _build_scripts("fakeredis")
+    return _build_scripts(FAKEREDIS_VARIANT)
 
 
 async def register_scripts(redis_client, is_fakeredis: bool = False) -> None:
-    variant = "fakeredis" if is_fakeredis else "redis"
+    variant = FAKEREDIS_VARIANT if is_fakeredis else REDIS_VARIANT
     scripts = _build_scripts(variant)
     for name, script_text in scripts.items():
         sha = await redis_client.script_load(script_text)
@@ -70,10 +78,25 @@ def run_sha(pipeline, script_name: str, keys: int, *args):
     pipeline.evalsha(sha, keys, *args)
 
 
-async def arun_sha(client, script_name: str, keys: int, *args):
+async def arun_sha(
+    client, redis_config: "RedisConfig", script_name: str, keys: int, *args
+):
+    sha = get_script(script_name)
+    try:
+        return await client.evalsha(sha, keys, *args)
+    except NoScriptError:
+        pass
+
+    await handle_noscript_error(client, redis_config)
     sha = get_script(script_name)
-    return await client.evalsha(sha, keys, *args)
+    try:
+        return await client.evalsha(sha, keys, *args)
+    except NoScriptError as e:
+        raise PersistentNoScriptError(
+            "NOSCRIPT error persisted after re-registering scripts. "
+            "This indicates a server-side problem with Redis."
+        ) from e
 
 
-async def handle_noscript_error(redis_client) -> None:
-    await register_scripts(redis_client)
+async def handle_noscript_error(redis_client, redis_config: "RedisConfig"):
+    await register_scripts(redis_client, is_fakeredis=redis_config.is_fake_redis)

rapyer/types/dct.py

@@ -106,7 +106,13 @@ class RedisDict(dict[str, T], GenericRedisType, Generic[T]):
 
     async def apop(self, key, default=None):
         result = await arun_sha(
-            self.client, DICT_POP_SCRIPT_NAME, 1, self.key, self.json_path, key
+            self.client,
+            self.Meta,
+            DICT_POP_SCRIPT_NAME,
+            1,
+            self.key,
+            self.json_path,
+            key,
         )
         super().pop(key, None)
         await self.refresh_ttl_if_needed()
@@ -120,7 +126,12 @@ class RedisDict(dict[str, T], GenericRedisType, Generic[T]):
 
     async def apopitem(self):
         result = await arun_sha(
-            self.client, DICT_POPITEM_SCRIPT_NAME, 1, self.key, self.json_path
+            self.client,
+            self.Meta,
+            DICT_POPITEM_SCRIPT_NAME,
+            1,
+            self.key,
+            self.json_path,
         )
         await self.refresh_ttl_if_needed()
 

{rapyer-1.2.0.dist-info → rapyer-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rapyer
-Version: 1.2.0
+Version: 1.2.1
 Summary: Pydantic models with Redis as the backend
 License: MIT
 Keywords: redis,redis-json,pydantic,pydantic-v2,orm,database,async,nosql,cache,key-value,data-modeling,python,backend,storage,serialization,validation

{rapyer-1.2.0.dist-info → rapyer-1.2.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
-rapyer/__init__.py,sha256=vgrOQkqvf0UBQMPpWSLvd9TxXXCQ8Oyt0g5E6nkhbPY,415
-rapyer/base.py,sha256=KeaRO5btbeV95CNeJHkS18Q5jmAkyxa11Ttsu0V5C-4,27004
+rapyer/__init__.py,sha256=PEFZI3eMHz-1ojcHEczcHKWAwloF5UYIibsvNg7O6a4,447
+rapyer/base.py,sha256=Q5SdwByj7cCGsKAVsITEfvp9ayp7b-KwTJzRR8Qd7fU,27196
 rapyer/config.py,sha256=Js1FGfyKfS16eOTgsPEhFfi1yTM_UkR8v2z_Vv6C3Bo,978
-rapyer/context.py,sha256=yuD_EGZB04gJv9YDlqeo7VD70J0Ldx5tE3NEGTcNdwA,357
+rapyer/context.py,sha256=MyyjpcIe2y8wUpiPNv-uYA2iDJyTuL_YxIueByle2kg,247
 rapyer/errors/__init__.py,sha256=P-DIYe85wySkCpuyWufwF7zOOOL8NUiMaHZROsciG1M,530
 rapyer/errors/base.py,sha256=PBTEbR0Y8rEhQXuWHAhoHnSxvoZ5nDfUW3Th2KOdb9M,804
 rapyer/fields/__init__.py,sha256=KyFUM5v0kdM2chITE5cH-L-IL_LRhWDXGbezhXgtEF0,157
@@ -12,8 +12,8 @@ rapyer/fields/safe_load.py,sha256=xS3PwOe9K2D7az-ctNV798cTSIb7bcviWHQ1kL1tbBo,59
 rapyer/init.py,sha256=R6xncUnBeq07gtM_iWqH4SHLquH7MNQgTbVbC6xIA6U,2133
 rapyer/links.py,sha256=A0usszwvwXI7FqwTEYquGYrqyNQqT4HUWhqmLteGXWU,121
 rapyer/scripts/__init__.py,sha256=FvTJvulDxVnVqc8JK4GmHXeS-lMis4_cudaQYe7_VKg,1130
-rapyer/scripts/constants.py,sha256=TMbBxw3Kufsmn_tWxpfzTVIdS89cHOreo2Z-RbY8koc,452
-rapyer/scripts/loader.py,sha256=9aYRIwnmZ60lLToLKLK07vLBnWARsTkoBZQnrnjLVHw,1827
+rapyer/scripts/constants.py,sha256=5PdpyNb94SRgzcskto41gG4Za35UxNJ8Nd0LtoC8RIg,509
+rapyer/scripts/loader.py,sha256=m5dy3L_FbyFR5oor2JqG-dOLp3JnZDYg5Zhd9YJFrdY,1915
 rapyer/scripts/lua/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapyer/scripts/lua/datetime/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapyer/scripts/lua/datetime/add.lua,sha256=wMhBkAr9KoDRtDR0qG0ofA8BENO1Ykr7f437kVLIUww,1536
@@ -32,13 +32,13 @@ rapyer/scripts/lua/numeric/truediv.lua,sha256=lQv6YuPb7YHsg50x7b_zDuQ3S1Oa3oeydO
 rapyer/scripts/lua/string/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapyer/scripts/lua/string/append.lua,sha256=JfSt21qCQzIMB_0dLmN58s9MFBDaOkiA8dBSBDO77bU,310
 rapyer/scripts/lua/string/mul.lua,sha256=rABORn6gxXobY44S1JYeLnLPeTZu26otemB0s6tBfx8,328
-rapyer/scripts/registry.py,sha256=RWGJdye4_UsirvsFM5gfOjBtMI-6Hx6PebcJmSs2N8k,2473
+rapyer/scripts/registry.py,sha256=uPHw3SMYqkyWAAo_j9RqZtHl54jPTwSGR_5ggNYlp-k,3223
 rapyer/types/__init__.py,sha256=lM2ZdpkgWW_7eh0AXoabtgA9CGhzWUHOi9W0_RTqu6I,484
 rapyer/types/base.py,sha256=AA7E0knCy9dJd78O0APG5FEUXvHSqWknzkp3Rpj1O30,6034
 rapyer/types/byte.py,sha256=cnV-XMMPKv03tV0oKSJ1mlrpwdAygs4H_EhOVheu-2Q,1791
 rapyer/types/convert.py,sha256=nyElDMWaWXtI_dXpAAg5elqWo439HsZ6u6wLj9WuHsI,3548
 rapyer/types/datetime.py,sha256=EuT6XhFPfQWNtGRd_8bX3DWm6_EGo-HqMef9Fr3fiNQ,4294
-rapyer/types/dct.py,sha256=-PKZoQuBXrT7wcHlss-Oc3mQqAQq2buI8aqrSoN5F7U,6431
+rapyer/types/dct.py,sha256=zsBJdA-y6UTUmc88q9h9Vhcjcdk-OJ18fJSRLvAe7LQ,6587
 rapyer/types/float.py,sha256=4TEKOJ778MFogULlfRq8iQV9bYdx-eArgRTtmeRzeP4,2864
 rapyer/types/init.py,sha256=SGH2uH9dIkWfaTMdiD-YV053nwRPaxUs4jTG1gOA2dg,495
 rapyer/types/integer.py,sha256=TvpFehA4LNvYWapaOph9izkWuf9eAAKqkPicjsKaz9s,2381
@@ -50,6 +50,6 @@ rapyer/utils/annotation.py,sha256=MB01l2k9g10AOSfttVfDIUc7JBzZWdH_Cn9FDe0IEGo,30
 rapyer/utils/fields.py,sha256=LhIhnuRBNrtE3RyFI-AiScXTzqYmOfcm-rdtmcdaHM0,2815
 rapyer/utils/pythonic.py,sha256=Xiv7RLqLozgLuwZSPIxBlsypIyoIYmPG_lV78TI4r80,141
 rapyer/utils/redis.py,sha256=d4qhR7QsER0572NMis_ATUUC17Jo4h9r8TKHTF8OIds,441
-rapyer-1.2.0.dist-info/METADATA,sha256=nYKTAQnSHNKFqU1x-RwLtYP3v93v-CSYinIZkabg1uI,11418
-rapyer-1.2.0.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-rapyer-1.2.0.dist-info/RECORD,,
+rapyer-1.2.1.dist-info/METADATA,sha256=lOK0hW34l7XZ75ewvyj8GaREF5EVYr9TXGmuVy_ZdZk,11418
+rapyer-1.2.1.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+rapyer-1.2.1.dist-info/RECORD,,

{rapyer-1.2.0.dist-info → rapyer-1.2.1.dist-info}/WHEEL

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