From 5f05dede3ba26d4a1441c8839673b77755da8ccc Mon Sep 17 00:00:00 2001 From: slorello89 Date: Fri, 3 May 2024 14:44:17 -0400 Subject: [PATCH 1/3] adding support for boolean checks --- aredis_om/model/model.py | 14 +++++++++++++- tests/test_json_model.py | 23 +++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/aredis_om/model/model.py b/aredis_om/model/model.py index 56c5c90d..5d0a9dea 100644 --- a/aredis_om/model/model.py +++ b/aredis_om/model/model.py @@ -116,6 +116,8 @@ class Operators(Enum): STARTSWITH = 14 ENDSWITH = 15 CONTAINS = 16 + TRUE = 17 + FALSE = 18 def __str__(self): return str(self.name) @@ -582,6 +584,8 @@ def resolve_field_type( "Only lists and tuples are supported for multi-value fields. " f"Docs: {ERRORS_URL}#E4" ) + elif field_type is bool: + return RediSearchFieldTypes.TAG elif any(issubclass(field_type, t) for t in NUMERIC_TYPES): # Index numeric Python types as NUMERIC fields, so we can support # range queries. @@ -676,7 +680,11 @@ def resolve_value( separator_char, ) return "" - if isinstance(value, int): + if isinstance(value, bool): + result = "@{field_name}:{{{value}}}".format( + field_name=field_name, value=value + ) + elif isinstance(value, int): # This if will hit only if the field is a primary key of type int result = f"@{field_name}:[{value} {value}]" elif separator_char in value: @@ -1814,6 +1822,8 @@ def schema_for_type(cls, name, typ: Any, field_info: PydanticFieldInfo): return "" embedded_cls = embedded_cls[0] schema = cls.schema_for_type(name, embedded_cls, field_info) + elif typ is bool: + schema = f"{name} TAG" elif any(issubclass(typ, t) for t in NUMERIC_TYPES): vector_options: Optional[VectorFieldOptions] = getattr( field_info, "vector_options", None @@ -2121,6 +2131,8 @@ def schema_for_type( raise sortable_tag_error if case_sensitive is True: schema += " CASESENSITIVE" + elif typ is bool: + schema = f"{path} AS {index_field_name} TAG" elif any(issubclass(typ, t) for t in NUMERIC_TYPES): schema = f"{path} AS {index_field_name} NUMERIC" elif issubclass(typ, str): diff --git a/tests/test_json_model.py b/tests/test_json_model.py index d5744858..2906b745 100644 --- a/tests/test_json_model.py +++ b/tests/test_json_model.py @@ -971,3 +971,26 @@ async def test_xfix_queries(m): result = await m.Member.find(m.Member.bio % "*ack*").first() assert result.first_name == "Steve" + + +@py_test_mark_asyncio +async def test_boolean(): + class Example(JsonModel): + b: bool = Field(index=True) + d: datetime.date = Field(index=True) + name: str = Field(index=True) + + await Migrator().run() + + ex = Example(b=True, name="steve", d=datetime.date.today()) + exFalse = Example(b=False, name="foo", d=datetime.date.today()) + await ex.save() + await exFalse.save() + res = await Example.find(Example.b == True).first() + assert res.name == "steve" + + res = await Example.find(Example.b == False).first() + assert res.name == "foo" + + res = await Example.find(Example.d == ex.d and Example.b == True).first() + assert res.name == ex.name From 7fe0efff46a4aa169b61daff567d0ea4cacc1334 Mon Sep 17 00:00:00 2001 From: slorello89 Date: Fri, 3 May 2024 15:06:48 -0400 Subject: [PATCH 2/3] adding writeup on booleans --- docs/getting_started.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/getting_started.md b/docs/getting_started.md index 15fea449..6f59fcfe 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -702,6 +702,27 @@ Customer.find((Customer.last_name == "Brookins") | ( ) & (Customer.last_name == "Smith")).all() ``` +### Saving and querying boolean values + +For historical reasons, saving and querying boolean values is not supported in `HashModels`, however in JSON models, +you may store and query boolean values using the `==` syntax: + +```python +from redis_om import ( + Field, + JsonModel, + Migrator +) + +class Demo(JsonModel): + b: bool = Field(index=True) + +Migrator().run() +d = Demo(b=True) +d.save() +res = Demo.find(Demo.b == True) +``` + ## Calling Other Redis Commands Sometimes you'll need to run a Redis command directly. Redis OM supports this through the `db` method on your model's class. This returns a connected Redis client instance which exposes a function named for each Redis command. For example, let's perform some basic set operations: From bbffe69616386ace993eb9802a26844d1d7556ec Mon Sep 17 00:00:00 2001 From: slorello89 Date: Fri, 3 May 2024 15:14:18 -0400 Subject: [PATCH 3/3] fixing linter and spell check --- Makefile | 2 +- docs/getting_started.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 9e41a736..827a367a 100644 --- a/Makefile +++ b/Makefile @@ -53,7 +53,7 @@ sync: $(INSTALL_STAMP) lint: $(INSTALL_STAMP) dist $(POETRY) run isort --profile=black --lines-after-imports=2 ./tests/ $(NAME) $(SYNC_NAME) $(POETRY) run black ./tests/ $(NAME) - $(POETRY) run flake8 --ignore=W503,E501,F401,E731 ./tests/ $(NAME) $(SYNC_NAME) + $(POETRY) run flake8 --ignore=W503,E501,F401,E731,E712 ./tests/ $(NAME) $(SYNC_NAME) $(POETRY) run mypy ./tests/ $(NAME) $(SYNC_NAME) --ignore-missing-imports --exclude migrate.py --exclude _compat\.py$ $(POETRY) run bandit -r $(NAME) $(SYNC_NAME) -s B608 diff --git a/docs/getting_started.md b/docs/getting_started.md index 6f59fcfe..70e06713 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -702,10 +702,10 @@ Customer.find((Customer.last_name == "Brookins") | ( ) & (Customer.last_name == "Smith")).all() ``` -### Saving and querying boolean values +### Saving and querying Boolean values -For historical reasons, saving and querying boolean values is not supported in `HashModels`, however in JSON models, -you may store and query boolean values using the `==` syntax: +For historical reasons, saving and querying Boolean values is not supported in `HashModels`, however in JSON models, +you may store and query Boolean values using the `==` syntax: ```python from redis_om import (