allow Model and Index property __prefix__ = None value

Author: user

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
->> Note: Make sure to edit `version` on `__init__.py`
+
+## 1.2.6
+
+ - allow Model and Index property `__prefix__ = None` value
 
 
 ## 1.2.5

RSO/__init__.py

@@ -1 +1 @@
-__version__ = "1.2.5"
+__version__ = "1.2.6"

RSO/aioredis/index.py

@@ -21,8 +21,14 @@ class HashIndex(BaseIndex):
 
     @classmethod
     def _to_redis_key(cls):
-        return f'{cls.__prefix__}::{cls.__model__.__model_name__}::'\
-               f'{cls.__index_name__}::{cls.__key__}'
+        model_prefix = cls.__model__.__model_name__
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}'
+        return redis_key
 
     @property
     def redis_key(self):
@@ -65,9 +71,13 @@ class ListIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls, value):
         model_prefix = cls.__model__.__model_name__
-        first_part = f'{cls.__prefix__}::{model_prefix}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self):
@@ -139,9 +149,13 @@ class SetIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls, value):
         model_prefix = cls.__model__.__model_name__
-        first_part = f'{cls.__prefix__}::{model_prefix}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self):

RSO/base.py

@@ -11,8 +11,8 @@
 
 class BaseIndex:
     # prefix for redis key
-    __prefix__: str = REDIS_MODEL_PREFIX
-    __index_name__: str = 'index_base'
+    __prefix__: str
+    __index_name__: str = 'index'
     # Model class that using this index
     __model__: T
     __key__: str
@@ -32,12 +32,12 @@ def create_from_model_class(cls, model_instance: Type["BaseModel"]):
 
 class BaseModel:
     # prefix for redis key
-    __prefix__: str = REDIS_MODEL_PREFIX
+    __prefix__: str
     # infix for redis key and model name
     __model_name__: str
     # Object property name that are to be redis key suffix
     __key__: str
-    __indexes__: List[BaseIndex] = []
+    __indexes__: List[BaseIndex]
 
     @classmethod
     def get_fields(cls) -> List[str]:
@@ -68,6 +68,8 @@ def __post_init__(self):
     def _to_redis_key(cls, value):
         if isinstance(value, UUID):
             value = str(value)
+        if cls.__prefix__ is None:
+            return f'{cls.__model_name__}:{value}'
         return f'{cls.__prefix__}::{cls.__model_name__}:{value}'
 
     @property

RSO/index.py

@@ -10,8 +10,14 @@
 class HashIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls) -> str:
-        return f'{cls.__prefix__}::{cls.__model__.__model_name__}::'\
-               f'{cls.__index_name__}::{cls.__key__}'
+        model_prefix = cls.__model__.__model_name__
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}'
+        return redis_key
 
     @property
     def redis_key(self) -> str:
@@ -44,9 +50,13 @@ class ListIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls, value) -> str:
         model_prefix = cls.__model__.__model_name__
-        first_part = f'{cls.__prefix__}::{model_prefix}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self) -> str:
@@ -114,9 +124,13 @@ class SetIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls, value: Any) -> str:
         model_prefix = cls.__model__.__model_name__
-        first_part = f'{cls.__prefix__}::{model_prefix}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self) -> str:

RSO/txredisapi/index.py

@@ -11,8 +11,14 @@
 class HashIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls) -> str:
-        return f'{cls.__prefix__}::{cls.__model__.__model_name__}::'\
-               f'{cls.__index_name__}::{cls.__key__}'
+        model_prefix = cls.__model__.__model_name__
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}'
+        return redis_key
 
     @property
     def redis_key(self) -> str:
@@ -60,9 +66,13 @@ class ListIndex(BaseIndex):
     @classmethod
     def _to_redis_key(cls, value):
         model_prefix = cls.__model__.__model_name__
-        first_part = f'{cls.__prefix__}::{model_prefix}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self):
@@ -152,9 +162,14 @@ class SetIndex(BaseIndex):
 
     @classmethod
     def _to_redis_key(cls, value):
-        first_part = f'{cls.__prefix__}::{cls.__model__.__model_name__}::'\
-                     f'{cls.__index_name__}::{cls.__key__}'
-        return f'{first_part}:{value}'
+        model_prefix = cls.__model__.__model_name__
+        if cls.__prefix__ is not None:
+            redis_key = f'{cls.__prefix__}::'
+        else:
+            redis_key = ''
+        redis_key = f'{redis_key}{model_prefix}::' \
+                    f'{cls.__index_name__}::{cls.__key__}:{value}'
+        return redis_key
 
     @property
     def redis_key(self):
@@ -167,7 +182,7 @@ def save_index(self, redis: Union[BaseRedisProtocol, ConnectionHandler]):
             redis.sadd(self.redis_key, self._model_key_value)
             returnValue(None)
         else:
-            yield redis.sadd(self.redis_key, self._model_key_value)
+            yield redis.sadd(self.redis_key, members=self._model_key_value)
 
     @classmethod
     @inlineCallbacks
@@ -196,4 +211,4 @@ def search_models(
 
     @inlineCallbacks
     def remove_from_index(self, redis: Union[BaseRedisProtocol, ConnectionHandler]):
-        yield redis.srem(self.redis_key, self._model_key_value)
+        yield redis.srem(self.redis_key, members=self._model_key_value)

tests/conftest.py

@@ -48,7 +48,6 @@ def tx_redis():
 
     @inlineCallbacks
     def cb(conn):
-        yield conn.ping()
         yield conn.flushdb()
         return conn
     d.addCallback(cb)

tests/models/redispy.py

@@ -50,8 +50,23 @@ def to_redis(self):
     def search_by_queue(cls, redis: Redis, queue_id: int):
         return ListIndexQueue.search_models(redis, queue_id, cls)
 
-    @classmethod
-    def search_by_list_by_rpushlpop(
-        cls, redis: Redis, queue_id: int
-    ):
-        return ListIndexQueue.x
+
+class NoPrefixSingleIndexUsername(BaseIndexUsername, HashIndex):
+    __prefix__ = None
+
+
+class NoPrefixSingleIndexEmail(BaseIndexEmail, HashIndex):
+    __prefix__ = None
+
+
+class NoPrefixSetIndexGroupID(BaseIndexGroupID, SetIndex):
+    __prefix__ = None
+
+
+class NoPrefixListIndexQueue(BaseIndexQueue, ListIndex):
+    __prefix__ = None
+
+
+@dataclass
+class NoPrefixUserModel(Model, BaseUserModel):
+    __prefix__ = None

tests/models/txredisapi.py

@@ -64,4 +64,3 @@ class ExtendedUserModel(UserModel):
     @defer.inlineCallbacks
     def save(self, redis: Union[BaseRedisProtocol, ConnectionHandler]):
         yield super(ExtendedUserModel, self).extended_save(redis)
-

tests/test_index.py

@@ -1,18 +1,39 @@
 from datetime import date
 
+from tests.models.const import REDIS_MODEL_PREFIX
 from .models.redispy import (
     UserModel,
     SingleIndexEmail,
     SingleIndexUsername,
     SetIndexGroupID,
-    ListIndexQueue
+    ListIndexQueue,
+    NoPrefixUserModel,
+    NoPrefixSingleIndexUsername,
+    NoPrefixSetIndexGroupID,
+    NoPrefixListIndexQueue,
 )
 
 
 BIRTH_DATE = date.fromisoformat('1999-09-09')
 
 
 class TestHashIndex:
+    def test_redis_key(self):
+        # With prefix
+        user = UserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = SingleIndexUsername.create_from_model_class(user)
+        assert index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
+        # Without prefix
+        user = NoPrefixUserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = NoPrefixSingleIndexUsername.create_from_model_class(user)
+        assert not index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
+
     def test_search_model(self, sync_redis):
         user = UserModel(
             user_id=1, username='username', email='test@email'
@@ -59,6 +80,22 @@ def test_after_delete(self, sync_redis):
 
 
 class TestListIndex:
+    def test_redis_key(self):
+        # With prefix
+        user = UserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = ListIndexQueue.create_from_model_class(user)
+        assert index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
+        # Without prefix
+        user = NoPrefixUserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = NoPrefixListIndexQueue.create_from_model_class(user)
+        assert not index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
+
     def test_success(self, sync_redis):
         user = UserModel(
             user_id=1,
@@ -150,6 +187,22 @@ def test_after_delete(self, sync_redis):
 
 
 class TestSetIndex:
+
+    def test_redis_key(self):
+        # With prefix
+        user = UserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = SetIndexGroupID.create_from_model_class(user)
+        assert index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
+        # Without prefix
+        user = NoPrefixUserModel(
+            user_id=1, username='username', email='test@email'
+        )
+        index = NoPrefixSetIndexGroupID.create_from_model_class(user)
+        assert not index.redis_key.startswith(REDIS_MODEL_PREFIX)
+
     def test_search_model(self, sync_redis):
         user = UserModel(
             user_id=1, username='username', group_id=10,