enum for aggregation scorer

Author: rbs333

redis/commands/search/aggregation.py

@@ -1,8 +1,18 @@
+from enum import Enum
 from typing import List, Union
 
 FIELDNAME = object()
 
 
+class Scorers(Enum):
+    TFIDF = "TFIDF"
+    TFIDF_DOCNORM = "TFIDF.DOCNORM"
+    BM25 = "BM25"
+    DISMAX = "DISMAX"
+    DOCSCORE = "DOCSCORE"
+    HAMMING = "HAMMING"
+
+
 class Limit:
     def __init__(self, offset: int = 0, count: int = 0) -> None:
         self.offset = offset
@@ -112,7 +122,7 @@ def __init__(self, query: str = "*") -> None:
         self._cursor = []
         self._dialect = None
         self._add_scores = False
-        self._scorer = None
+        self._scorer = Scorers.TFIDF.value
 
     def load(self, *fields: List[str]) -> "AggregateRequest":
         """
@@ -309,7 +319,7 @@ def scorer(self, scorer: str) -> "AggregateRequest":
         :param scorer: The scoring function to use
                        (e.g. `TFIDF.DOCNORM` or `BM25`)
         """
-        self._scorer = scorer
+        self._scorer = Scorers(scorer).value
         return self
 
     def verbatim(self) -> "AggregateRequest":

tests/test_asyncio/test_search.py

@@ -1611,6 +1611,14 @@ async def test_aggregations_hybrid_scoring(decoded_r: redis.Redis):
             len(row) == 6
 
 
+@pytest.mark.redismod
+@skip_ifmodversion_lt("2.10.05", "search")
+async def test_invalid_scorer():
+
+    with pytest.raises(ValueError):
+        aggregations.AggregateRequest("*").scorer("blah")
+
+
 @pytest.mark.redismod
 @skip_if_redis_enterprise()
 async def test_search_commands_in_pipeline(decoded_r: redis.Redis):

tests/test_search.py

@@ -1521,6 +1521,14 @@ async def test_aggregations_hybrid_scoring(client):
             len(row) == 6
 
 
+@pytest.mark.redismod
+@skip_ifmodversion_lt("2.10.05", "search")
+async def test_invalid_scorer():
+
+    with pytest.raises(ValueError):
+        aggregations.AggregateRequest("*").scorer("blah")
+
+
 @pytest.mark.redismod
 @skip_ifmodversion_lt("2.0.0", "search")
 def test_index_definition(client):