Support both sync and asyncio uses

Author: Andrew Brookins

.gitignore

@@ -133,4 +133,5 @@ data
 .install.stamp
 
 # Sync version of the library, via Unasync
-redis_om/
+redis_om/
+tests_sync/

Makefile

@@ -62,14 +62,14 @@ format: $(INSTALL_STAMP) sync
 
 .PHONY: test
 test: $(INSTALL_STAMP) sync
-	$(POETRY) run pytest -n auto -s -vv ./tests/ --cov-report term-missing --cov $(NAME) $(SYNC_NAME)
+	$(POETRY) run pytest -n auto -vv ./tests/ ./tests_sync/ --cov-report term-missing --cov $(NAME) $(SYNC_NAME)
 
 .PHONY: test_oss
 test_oss: $(INSTALL_STAMP) sync
 	# Specifically tests against a local OSS Redis instance via
 	# docker-compose.yml. Do not use this for CI testing, where we should
 	# instead have a matrix of Docker images.
-	REDIS_OM_URL="redis://localhost:6381" $(POETRY) run pytest -n auto -s -vv ./tests/ --cov-report term-missing --cov $(NAME)
+	REDIS_OM_URL="redis://localhost:6381" $(POETRY) run pytest -n auto -vv ./tests/ ./tests_sync/ --cov-report term-missing --cov $(NAME)
 
 
 .PHONY: shell

aredis_om/model/__init__.py

@@ -1,2 +1,2 @@
 from .migrations.migrator import MigrationError, Migrator
-from .model import EmbeddedJsonModel, Field, HashModel, JsonModel, RedisModel
+from .model import EmbeddedJsonModel, Field, HashModel, JsonModel, RedisModel, NotFoundError

aredis_om/model/migrations/migrator.py

@@ -6,8 +6,6 @@
 
 from aioredis import Redis, ResponseError
 
-from aredis_om.model.model import model_registry
-
 
 log = logging.getLogger(__name__)
 
@@ -96,6 +94,10 @@ async def run(self):
         if self.module:
             import_submodules(self.module)
 
+        # Import this at run-time to avoid triggering import-time side effects,
+        # e.g. checks for RedisJSON, etc.
+        from aredis_om.model.model import model_registry
+
         for name, cls in model_registry.items():
             hash_key = schema_hash_key(cls.Meta.index_name)
             try:

aredis_om/model/model.py

@@ -10,7 +10,6 @@
 from typing import (
     AbstractSet,
     Any,
-    AsyncGenerator,
     Callable,
     Dict,
     List,
@@ -1295,7 +1294,7 @@ async def save(self, pipeline: Optional[Pipeline] = None) -> "HashModel":
         return self
 
     @classmethod
-    async def all_pks(cls) -> AsyncGenerator[str, None]:  # type: ignore
+    async def all_pks(cls):  # type: ignore
         key_prefix = cls.make_key(cls._meta.primary_key_pattern.format(pk=""))
         # TODO: We assume the key ends with the default separator, ":" -- when
         #  we make the separator configurable, we need to update this as well.
@@ -1437,13 +1436,16 @@ def schema_for_type(cls, name, typ: Any, field_info: PydanticFieldInfo):
 
 class JsonModel(RedisModel, abc.ABC):
     def __init_subclass__(cls, **kwargs):
-        if not has_redis_json(cls.db()):
+        # Generate the RediSearch schema once to validate fields.
+        cls.redisearch_schema()
+
+    def __init__(self, *args, **kwargs):
+        if not has_redis_json(self.db()):
             log.error(
                 "Your Redis instance does not have the RedisJson module "
                 "loaded. JsonModel depends on RedisJson."
             )
-        # Generate the RediSearch schema once to validate fields.
-        cls.redisearch_schema()
+        super().__init__(*args, **kwargs)
 
     async def save(self, pipeline: Optional[Pipeline] = None) -> "JsonModel":
         self.check()

make_sync.py

@@ -3,23 +3,29 @@
 
 import unasync
 
+ADDITIONAL_REPLACEMENTS = {
+    "aredis_om": "redis_om",
+    "aioredis": "redis",
+    ":tests.": ":tests_sync.",
+}
+
 
 def main():
-    additional_replacements = {
-        "aredis_om": "redis_om",
-        "aioredis": "redis"
-    }
     rules = [
         unasync.Rule(
             fromdir="/aredis_om/",
             todir="/redis_om/",
-            additional_replacements=additional_replacements,
+            additional_replacements=ADDITIONAL_REPLACEMENTS,
+        ),
+        unasync.Rule(
+            fromdir="/tests/",
+            todir="/tests_sync/",
+            additional_replacements=ADDITIONAL_REPLACEMENTS,
         ),
     ]
-
     filepaths = []
     for root, _, filenames in os.walk(
-            Path(__file__).absolute().parent / "aredis_om"
+            Path(__file__).absolute().parent
     ):
         for filename in filenames:
             if filename.rpartition(".")[-1] in ("py", "pyi",):

pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
 include=[
     "docs/*",
     "images/*",
+    "redis_om/**/*",
 ]
 
 [tool.poetry.dependencies]

setup.py

@@ -14,9 +14,12 @@
     Migrator,
     QueryNotSupportedError,
     RedisModelError,
-    has_redisearch,
 )
 
+# We need to run this check as sync code (during tests) even in async mode
+# because we call it in the top-level module scope.
+from redis_om import has_redisearch
+
 
 if not has_redisearch():
     pytestmark = pytest.mark.skip
@@ -438,7 +441,11 @@ class Address(m.BaseHashModel):
         another_integer: int
         another_float: float
 
+    # We need to build the key prefix because it will differ based on whether
+    # these tests were copied into the tests_sync folder and unasynce'd.
+    key_prefix = Address.make_key(Address._meta.primary_key_pattern.format(pk=""))
+
     assert (
         Address.redisearch_schema()
-        == f"ON HASH PREFIX 1 {key_prefix}:tests.test_hash_model.Address: SCHEMA pk TAG SEPARATOR | a_string TAG SEPARATOR | a_full_text_string TAG SEPARATOR | a_full_text_string_fts TEXT an_integer NUMERIC SORTABLE a_float NUMERIC"
+        == f"ON HASH PREFIX 1 {key_prefix} SCHEMA pk TAG SEPARATOR | a_string TAG SEPARATOR | a_full_text_string TAG SEPARATOR | a_full_text_string_fts TEXT an_integer NUMERIC SORTABLE a_float NUMERIC"
     )