Merge pull request #35 from sopherapps/bugfix/error-multiple-redis-in…

…stances-can-be-passed-to-store

Fix possibility of Passing Multiple Redis Instances to the Store

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+### Changed
+
+- [BREAKING CHANGE] Removed the 'redis_store' argument from the `Store` constructor
+- [BREAKING CHANGE] Made the 'redis_store' property of the `Store` readonly
+
+### Fixed
+
+- Fixed the rendering of the reference docs from the docstrings
+
 ## [0.5.0] - 2024-02-10
 
 ### Added

pydantic_redis/_shared/store.py

@@ -34,7 +34,6 @@ class AbstractStore(BaseModel):
 
     name: str
     redis_config: RedisConfig
-    redis_store: Optional[Union[Redis, AioRedis]] = None
     life_span_in_seconds: Optional[int] = None
     select_all_fields_for_all_ids_script: Optional[Union[AsyncScript, Script]] = None
     paginated_select_all_fields_for_all_ids_script: Optional[
@@ -49,25 +48,31 @@ class AbstractStore(BaseModel):
     models: Dict[str, Type["AbstractModel"]] = {}
     model_config = ConfigDict(arbitrary_types_allowed=True, from_attributes=True)
 
+    # protected properties
+    _redis_store: Optional[Union[Redis, AioRedis]] = None
+
     def __init__(
         self,
         name: str,
         redis_config: RedisConfig,
-        redis_store: Optional[Union[Redis, AioRedis]] = None,
         life_span_in_seconds: Optional[int] = None,
         **data: Any,
     ):
         super().__init__(
             name=name,
             redis_config=redis_config,
-            redis_store=redis_store,
             life_span_in_seconds=life_span_in_seconds,
             **data,
         )
 
-        self.redis_store = self._connect_to_redis()
+        self._redis_store = self._connect_to_redis()
         self._register_lua_scripts()
 
+    @property
+    def redis_store(self) -> Optional[Union[Redis, AioRedis]]:
+        """the redis store for the given store"""
+        return self._redis_store
+
     def _connect_to_redis(self) -> Union[Redis, AioRedis]:
         """Connects the store to redis.
 

pydantic_redis/asyncio/store.py

@@ -30,7 +30,6 @@ class Store(AbstractStore):
             Model name
         name (str): the name of this Store
         redis_config (pydantic_redis.syncio.RedisConfig): the configuration for connecting to a redis database
-        redis_store (Optional[redis.Redis]): an Redis instance associated with this store (default: None)
         life_span_in_seconds (Optional[int]): the default time-to-live for the records inserted in this store
             (default: None)
     """

pydantic_redis/syncio/store.py

@@ -30,7 +30,6 @@ class Store(AbstractStore):
             Model name
         name (str): the name of this Store
         redis_config (pydantic_redis.syncio.RedisConfig): the configuration for connecting to a redis database
-        redis_store (Optional[redis.Redis]): an Redis instance associated with this store (default: None)
         life_span_in_seconds (Optional[int]): the default time-to-live for the records inserted in this store
             (default: None)
     """