Merge branch 'main' into huwaiza/vector-field-fix

Author: abrookins

.github/wordlist.txt

@@ -56,3 +56,7 @@ validator
 validators
 virtualenv
 http
+AMR
+EntraID
+entraid
+metamodel

.github/workflows/ci.yml

@@ -76,7 +76,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        pyver: [ "3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.8", "pypy-3.9", "pypy-3.10" ]
+        pyver: [ "3.9", "3.10", "3.11", "3.12", "pypy-3.9", "pypy-3.10" ]
         redisstack: [ "latest" ]
       fail-fast: false
     services:

.github/workflows/pypi-publish.yaml

@@ -42,7 +42,7 @@ jobs:
 
       - name: Set Poetry config
         run: |
-          pip install --upgrade pip poetry
+          pip install --upgrade pip poetry==1.8.4
           poetry config virtualenvs.in-project false
           poetry config virtualenvs.path ~/.virtualenvs
           poetry export --dev --without-hashes -o requirements.txt

README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <br/>
   <br/>
-  <img width="360" src="https://raw.githubusercontent.com/redis-developer/redis-om-python/main/images/logo.svg?token=AAAXXHUYL6RHPESRRAMBJOLBSVQXE" alt="Redis OM" />
+  <img width="360" src="docs/images/logo.svg" alt="Redis OM" />
   <br/>
   <br/>
 </div>
@@ -370,6 +370,36 @@ You can run these modules in your self-hosted Redis deployment, or you can use [
 
 To learn more, read [our documentation](docs/redis_modules.md).
 
+## Connecting to Azure Managed Redis with EntraID
+
+Once you have EntraID setup for your Azure Managed Redis (AMR) deployment, you can use Redis OM Python with it by leveraging the [redis-py-entraid](https://github.com/redis/redis-py-entraid) library.
+Simply install the library with:
+
+```
+pip install redis-entraid
+```
+
+Then you'll initialize your credentials provider, connect to redis, and pass the database object into your metamodel:
+
+```python
+
+from redis import Redis
+from redis_entraid.cred_provider import create_from_default_azure_credential
+from redis_om import HashModel, Field
+credential_provider = create_from_default_azure_credential(
+        ("https://redis.azure.com/.default",),
+    )
+
+db = Redis(host="cluster-name.region.redis.azure.net", port=10000, ssl=True, ssl_cert_reqs=None, credential_provider=credential_provider)
+db.flushdb()
+class User(HashModel):
+    first_name: str
+    last_name: str = Field(index=True)
+
+    class Meta:
+        database = db
+```
+
 ## ❤️ Contributing
 
 We'd love your contributions!

aredis_om/model/migrations/migrator.py

@@ -130,6 +130,9 @@ async def detect_migrations(self):
                 continue
 
             stored_hash = await conn.get(hash_key)
+            if isinstance(stored_hash, bytes):
+                stored_hash = stored_hash.decode('utf-8')
+
             schema_out_of_date = current_hash != stored_hash
 
             if schema_out_of_date:

aredis_om/model/model.py

@@ -1320,6 +1320,13 @@ def __new__(cls, name, bases, attrs, **kwargs):  # noqa C901
         meta = meta or getattr(new_class, "Meta", None)
         base_meta = getattr(new_class, "_meta", None)
 
+        if len(bases) >= 1:
+            for base_index in range(len(bases)):
+                model_fields = getattr(bases[base_index], "model_fields", [])
+                for f_name in model_fields:
+                    field = model_fields[f_name]
+                    new_class.model_fields[f_name] = field
+
         if meta and meta != DefaultMeta and meta != base_meta:
             new_class.Meta = meta
             new_class._meta = meta
@@ -1455,7 +1462,16 @@ class Config:
 
     def __init__(__pydantic_self__, **data: Any) -> None:
         __pydantic_self__.validate_primary_key()
-        super().__init__(**data)
+        missing_fields = __pydantic_self__.model_fields.keys() - data.keys() - {"pk"}
+
+        kwargs = data.copy()
+
+        # This is a hack, we need to manually make sure we are setting up defaults correctly when we encounter them
+        # because inheritance apparently won't cover that in pydantic 2.0.
+        for field in missing_fields:
+            default_value = __pydantic_self__.model_fields.get(field).default  # type: ignore
+            kwargs[field] = default_value
+        super().__init__(**kwargs)
 
     def __lt__(self, other):
         """Default sort: compare primary key of models."""
@@ -1527,7 +1543,7 @@ def validate_primary_key(cls):
             else:
                 field_info = field.field_info
 
-            if getattr(field_info, "primary_key", None):
+            if getattr(field_info, "primary_key", None) is True:
                 primary_keys += 1
         if primary_keys == 0:
             raise RedisModelError("You must define a primary key for the model")
@@ -1808,7 +1824,7 @@ def schema_for_fields(cls):
             else:
                 field_info = field.field_info
 
-            if getattr(field_info, "primary_key", None):
+            if getattr(field_info, "primary_key", None) is True:
                 if issubclass(_type, str):
                     redisearch_field = (
                         f"{name} TAG SEPARATOR {SINGLE_VALUE_TAG_FIELD_SEPARATOR}"
@@ -2003,7 +2019,7 @@ def schema_for_fields(cls):
                 field_info = field.field_info
             else:
                 field_info = field
-            if getattr(field_info, "primary_key", None):
+            if getattr(field_info, "primary_key", None) is True:
                 if issubclass(_type, str):
                     redisearch_field = f"$.{name} AS {name} TAG SEPARATOR {SINGLE_VALUE_TAG_FIELD_SEPARATOR}"
                 else:

docs/images/logo.svg

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redis-om"
-version = "0.3.3"
+version = "0.3.5"
 description = "Object mappings, and more, for Redis."
 authors = ["Redis OSS <[email protected]>"]
 maintainers = ["Redis OSS <[email protected]>"]
@@ -44,7 +44,7 @@ python-ulid = "^1.0.3"
 typing-extensions = "^4.4.0"
 hiredis = ">=2.2.3,<4.0.0"
 more-itertools = ">=8.14,<11.0"
-setuptools = {version = ">=70.0,<76.0", markers = "python_version >= '3.12'"}
+setuptools = ">=70.0"
 
 [tool.poetry.dev-dependencies]
 mypy = "^1.9.0"

pyproject.toml

@@ -18,6 +18,7 @@
     Migrator,
     NotFoundError,
     QueryNotSupportedError,
+    RedisModel,
     RedisModelError,
 )
 
@@ -951,3 +952,53 @@ class TestLiterals(HashModel):
     await item.save()
     rematerialized = await TestLiterals.find(TestLiterals.flavor == "pumpkin").first()
     assert rematerialized.pk == item.pk
+
+
+@py_test_mark_asyncio
+async def test_child_class_expression_proxy():
+    # https://github.com/redis/redis-om-python/issues/669 seeing weird issue with child classes initalizing all their undefined members as ExpressionProxies
+    class Model(HashModel):
+        first_name: str
+        last_name: str
+        age: int = Field(default=18)
+        bio: Optional[str] = Field(default=None)
+
+    class Child(Model):
+        other_name: str
+        # is_new: bool = Field(default=True)
+
+    await Migrator().run()
+    m = Child(first_name="Steve", last_name="Lorello", other_name="foo")
+    await m.save()
+    print(m.age)
+    assert m.age == 18
+
+    rematerialized = await Child.find(Child.pk == m.pk).first()
+
+    assert rematerialized.age == 18
+    assert rematerialized.bio is None
+
+
+@py_test_mark_asyncio
+async def test_child_class_expression_proxy_with_mixin():
+    # https://github.com/redis/redis-om-python/issues/669 seeing weird issue with child classes initalizing all their undefined members as ExpressionProxies
+    class Model(RedisModel, abc.ABC):
+        first_name: str
+        last_name: str
+        age: int = Field(default=18)
+        bio: Optional[str] = Field(default=None)
+
+    class Child(Model, HashModel):
+        other_name: str
+        # is_new: bool = Field(default=True)
+
+    await Migrator().run()
+    m = Child(first_name="Steve", last_name="Lorello", other_name="foo")
+    await m.save()
+    print(m.age)
+    assert m.age == 18
+
+    rematerialized = await Child.find(Child.pk == m.pk).first()
+
+    assert rematerialized.age == 18
+    assert rematerialized.bio is None

tests/test_hash_model.py

@@ -12,6 +12,7 @@
 
 import pytest
 import pytest_asyncio
+from more_itertools.more import first
 from redis.exceptions import ResponseError
 
 from aredis_om import (
@@ -21,6 +22,7 @@
     Migrator,
     NotFoundError,
     QueryNotSupportedError,
+    RedisModel,
     RedisModelError,
     VectorFieldOptions,
 )
@@ -1161,6 +1163,66 @@ class TestLiterals(JsonModel):
     assert rematerialized.pk == item.pk
 
 
+@py_test_mark_asyncio
+async def test_two_false_pks():
+    from pydantic_core import PydanticUndefined as Undefined
+
+    class SomeModel(JsonModel):
+        field1: str = Field(index=True, primary_key=Undefined)
+        field2: str = Field(index=True, primary_key=Undefined)
+
+    SomeModel(field1="foo", field2="bar")
+
+
+@py_test_mark_asyncio
+async def test_child_class_expression_proxy():
+    # https://github.com/redis/redis-om-python/issues/669 seeing weird issue with child classes initalizing all their undefined members as ExpressionProxies
+    class Model(JsonModel):
+        first_name: str
+        last_name: str
+        age: int = Field(default=18)
+        bio: Optional[str] = Field(default=None)
+
+    class Child(Model):
+        is_new: bool = Field(default=True)
+
+    await Migrator().run()
+    m = Child(first_name="Steve", last_name="Lorello")
+    await m.save()
+    print(m.age)
+    assert m.age == 18
+
+    rematerialized = await Child.find(Child.pk == m.pk).first()
+
+    assert rematerialized.age == 18
+    assert rematerialized.age != 19
+    assert rematerialized.bio is None
+
+
+@py_test_mark_asyncio
+async def test_child_class_expression_proxy_with_mixin():
+    class Model(RedisModel, abc.ABC):
+        first_name: str
+        last_name: str
+        age: int = Field(default=18)
+        bio: Optional[str] = Field(default=None)
+
+    class Child(Model, JsonModel):
+        is_new: bool = Field(default=True)
+
+    await Migrator().run()
+    m = Child(first_name="Steve", last_name="Lorello")
+    await m.save()
+    print(m.age)
+    assert m.age == 18
+
+    rematerialized = await Child.find(Child.pk == m.pk).first()
+
+    assert rematerialized.age == 18
+    assert rematerialized.age != 19
+    assert rematerialized.bio is None
+
+
 @py_test_mark_asyncio
 async def test_merged_model_error():
     class Player(EmbeddedJsonModel):