Merge branch 'master' into ps_handling_special_str_values_in_topk_list_result_callback

Author: petyaslavova

.github/workflows/integration.yaml

@@ -74,7 +74,7 @@ jobs:
       max-parallel: 15
       fail-fast: false
       matrix:
-        redis-version: ['8.0-M05-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.7', '6.2.17']
+        redis-version: ['8.0-RC1-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.7', '6.2.17']
         python-version: ['3.8', '3.13']
         parser-backend: ['plain']
         event-loop: ['asyncio']

docker-compose.yml

@@ -1,6 +1,6 @@
 ---
 x-client-libs-stack-image: &client-libs-stack-image
-  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_STACK_IMAGE_TAG:-rs-7.4.0-v2}"
+  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_STACK_IMAGE_TAG:-7.4.2}"
 
 x-client-libs-image: &client-libs-image
   image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_IMAGE_TAG:-7.4.2}"

docs/advanced_features.rst

@@ -384,13 +384,13 @@ run_in_thread.
 
 A PubSub object adheres to the same encoding semantics as the client
 instance it was created from. Any channel or pattern that's unicode will
-be encoded using the charset specified on the client before being sent
+be encoded using the encoding specified on the client before being sent
 to Redis. If the client's decode_responses flag is set the False (the
 default), the 'channel', 'pattern' and 'data' values in message
 dictionaries will be byte strings (str on Python 2, bytes on Python 3).
 If the client's decode_responses is True, then the 'channel', 'pattern'
 and 'data' values will be automatically decoded to unicode strings using
-the client's charset.
+the client's encoding.
 
 PubSub objects remember what channels and patterns they are subscribed
 to. In the event of a disconnection such as a network error or timeout,

doctests/dt_vec_set.py

@@ -0,0 +1,286 @@
+# EXAMPLE: vecset_tutorial
+# HIDE_START
+"""
+Code samples for Vector set doc pages:
+    https://redis.io/docs/latest/develop/data-types/vector-sets/
+"""
+
+import redis
+
+from redis.commands.vectorset.commands import (
+    QuantizationOptions
+)
+
+r = redis.Redis(decode_responses=True)
+# HIDE_END
+
+# REMOVE_START
+r.delete(
+    "points", "quantSetQ8", "quantSetNoQ",
+    "quantSetBin", "setNotReduced", "setReduced"
+)
+# REMOVE_END
+
+# STEP_START vadd
+res1 = r.vset().vadd("points", [1.0, 1.0], "pt:A")
+print(res1)  # >>> 1
+
+res2 = r.vset().vadd("points", [-1.0, -1.0], "pt:B")
+print(res2)  # >>> 1
+
+res3 = r.vset().vadd("points", [-1.0, 1.0], "pt:C")
+print(res3)  # >>> 1
+
+res4 = r.vset().vadd("points", [1.0, -1.0], "pt:D")
+print(res4)  # >>> 1
+
+res5 = r.vset().vadd("points", [1.0, 0], "pt:E")
+print(res5)  # >>> 1
+
+res6 = r.type("points")
+print(res6)  # >>> vectorset
+# STEP_END
+# REMOVE_START
+assert res1 == 1
+assert res2 == 1
+assert res3 == 1
+assert res4 == 1
+assert res5 == 1
+
+assert res6 == "vectorset"
+# REMOVE_END
+
+# STEP_START vcardvdim
+res7 = r.vset().vcard("points")
+print(res7)  # >>> 5
+
+res8 = r.vset().vdim("points")
+print(res8)  # >>> 2
+# STEP_END
+# REMOVE_START
+assert res7 == 5
+assert res8 == 2
+# REMOVE_END
+
+# STEP_START vemb
+res9 = r.vset().vemb("points", "pt:A")
+print(res9)  # >>> [0.9999999403953552, 0.9999999403953552]
+
+res10 = r.vset().vemb("points", "pt:B")
+print(res10)  # >>> [-0.9999999403953552, -0.9999999403953552]
+
+res11 = r.vset().vemb("points", "pt:C")
+print(res11)  # >>> [-0.9999999403953552, 0.9999999403953552]
+
+res12 = r.vset().vemb("points", "pt:D")
+print(res12)  # >>> [0.9999999403953552, -0.9999999403953552]
+
+res13 = r.vset().vemb("points", "pt:E")
+print(res13)  # >>> [1, 0]
+# STEP_END
+# REMOVE_START
+assert 1 - res9[0] < 0.001
+assert 1 - res9[1] < 0.001
+assert 1 + res10[0] < 0.001
+assert 1 + res10[1] < 0.001
+assert 1 + res11[0] < 0.001
+assert 1 - res11[1] < 0.001
+assert 1 - res12[0] < 0.001
+assert 1 + res12[1] < 0.001
+assert res13 == [1, 0]
+# REMOVE_END
+
+# STEP_START attr
+res14 = r.vset().vsetattr("points", "pt:A", {
+    "name": "Point A",
+    "description": "First point added"
+})
+print(res14)  # >>> 1
+
+res15 = r.vset().vgetattr("points", "pt:A")
+print(res15)
+# >>> {'name': 'Point A', 'description': 'First point added'}
+
+res16 = r.vset().vsetattr("points", "pt:A", "")
+print(res16)  # >>> 1
+
+res17 = r.vset().vgetattr("points", "pt:A")
+print(res17)  # >>> None
+# STEP_END
+# REMOVE_START
+assert res14 == 1
+assert res15 == {"name": "Point A", "description": "First point added"}
+assert res16 == 1
+assert res17 is None
+# REMOVE_END
+
+# STEP_START vrem
+res18 = r.vset().vadd("points", [0, 0], "pt:F")
+print(res18)  # >>> 1
+
+res19 = r.vset().vcard("points")
+print(res19)  # >>> 6
+
+res20 = r.vset().vrem("points", "pt:F")
+print(res20)  # >>> 1
+
+res21 = r.vset().vcard("points")
+print(res21)  # >>> 5
+# STEP_END
+# REMOVE_START
+assert res18 == 1
+assert res19 == 6
+assert res20 == 1
+assert res21 == 5
+# REMOVE_END
+
+# STEP_START vsim_basic
+res22 = r.vset().vsim("points", [0.9, 0.1])
+print(res22)
+# >>> ['pt:E', 'pt:A', 'pt:D', 'pt:C', 'pt:B']
+# STEP_END
+# REMOVE_START
+assert res22 == ["pt:E", "pt:A", "pt:D", "pt:C", "pt:B"]
+# REMOVE_END
+
+# STEP_START vsim_options
+res23 = r.vset().vsim(
+    "points", "pt:A",
+    with_scores=True,
+    count=4
+)
+print(res23)
+# >>> {'pt:A': 1.0, 'pt:E': 0.8535534143447876, 'pt:D': 0.5, 'pt:C': 0.5}
+# STEP_END
+# REMOVE_START
+assert res23["pt:A"] == 1.0
+assert res23["pt:C"] == 0.5
+assert res23["pt:D"] == 0.5
+assert res23["pt:E"] - 0.85 < 0.005
+# REMOVE_END
+
+# STEP_START vsim_filter
+res24 = r.vset().vsetattr("points", "pt:A", {
+    "size": "large",
+    "price": 18.99
+})
+print(res24)  # >>> 1
+
+res25 = r.vset().vsetattr("points", "pt:B", {
+    "size": "large",
+    "price": 35.99
+})
+print(res25)  # >>> 1
+
+res26 = r.vset().vsetattr("points", "pt:C", {
+    "size": "large",
+    "price": 25.99
+})
+print(res26)  # >>> 1
+
+res27 = r.vset().vsetattr("points", "pt:D", {
+    "size": "small",
+    "price": 21.00
+})
+print(res27)  # >>> 1
+
+res28 = r.vset().vsetattr("points", "pt:E", {
+    "size": "small",
+    "price": 17.75
+})
+print(res28)  # >>> 1
+
+# Return elements in order of distance from point A whose
+# `size` attribute is `large`.
+res29 = r.vset().vsim(
+    "points", "pt:A",
+    filter='.size == "large"'
+)
+print(res29)  # >>> ['pt:A', 'pt:C', 'pt:B']
+
+# Return elements in order of distance from point A whose size is
+# `large` and whose price is greater than 20.00.
+res30 = r.vset().vsim(
+    "points", "pt:A",
+    filter='.size == "large" && .price > 20.00'
+)
+print(res30)  # >>> ['pt:C', 'pt:B']
+# STEP_END
+# REMOVE_START
+assert res24 == 1
+assert res25 == 1
+assert res26 == 1
+assert res27 == 1
+assert res28 == 1
+
+assert res30 == ['pt:C', 'pt:B']
+# REMOVE_END
+
+# STEP_START add_quant
+# Import `QuantizationOptions` enum using:
+#
+# from redis.commands.vectorset.commands import (
+#   QuantizationOptions
+# )
+res31 = r.vset().vadd(
+    "quantSetQ8", [1.262185, 1.958231],
+    "quantElement",
+    quantization=QuantizationOptions.Q8
+)
+print(res31)  # >>> 1
+
+res32 = r.vset().vemb("quantSetQ8", "quantElement")
+print(f"Q8: {res32}")
+# >>> Q8: [1.2643694877624512, 1.958230972290039]
+
+res33 = r.vset().vadd(
+    "quantSetNoQ", [1.262185, 1.958231],
+    "quantElement",
+    quantization=QuantizationOptions.NOQUANT
+)
+print(res33)  # >>> 1
+
+res34 = r.vset().vemb("quantSetNoQ", "quantElement")
+print(f"NOQUANT: {res34}")
+# >>> NOQUANT: [1.262184977531433, 1.958230972290039]
+
+res35 = r.vset().vadd(
+    "quantSetBin", [1.262185, 1.958231],
+    "quantElement",
+    quantization=QuantizationOptions.BIN
+)
+print(res35)  # >>> 1
+
+res36 = r.vset().vemb("quantSetBin", "quantElement")
+print(f"BIN: {res36}")
+# >>> BIN: [1, 1]
+# STEP_END
+# REMOVE_START
+assert res31 == 1
+# REMOVE_END
+
+# STEP_START add_reduce
+# Create a list of 300 arbitrary values.
+values = [x / 299 for x in range(300)]
+
+res37 = r.vset().vadd(
+    "setNotReduced",
+    values,
+    "element"
+)
+print(res37)  # >>> 1
+
+res38 = r.vset().vdim("setNotReduced")
+print(res38)  # >>> 300
+
+res39 = r.vset().vadd(
+    "setReduced",
+    values,
+    "element",
+    reduce_dim=100
+)
+print(res39)  # >>> 1
+
+res40 = r.vset().vdim("setReduced")  # >>> 100
+print(res40)
+# STEP_END

doctests/home_json.py

@@ -10,7 +10,7 @@
 import redis.commands.search.aggregation as aggregations
 import redis.commands.search.reducers as reducers
 from redis.commands.search.field import TextField, NumericField, TagField
-from redis.commands.search.indexDefinition import IndexDefinition, IndexType
+from redis.commands.search.index_definition import IndexDefinition, IndexType
 from redis.commands.search.query import Query
 import redis.exceptions
 # STEP_END
@@ -25,7 +25,12 @@
 except redis.exceptions.ResponseError:
     pass
 
-r.delete("user:1", "user:2", "user:3")
+try:
+    r.ft("hash-idx:users").dropindex(True)
+except redis.exceptions.ResponseError:
+    pass
+
+r.delete("user:1", "user:2", "user:3", "huser:1", "huser:2", "huser:3")
 # REMOVE_END
 # STEP_START create_data
 user1 = {
@@ -134,4 +139,50 @@
 )
 # REMOVE_END
 
+# STEP_START make_hash_index
+hashSchema = (
+    TextField("name"),
+    TagField("city"),
+    NumericField("age")
+)
+
+hashIndexCreated = r.ft("hash-idx:users").create_index(
+    hashSchema,
+    definition=IndexDefinition(
+        prefix=["huser:"], index_type=IndexType.HASH
+    )
+)
+# STEP_END
+# REMOVE_START
+assert hashIndexCreated
+# REMOVE_END
+
+# STEP_START add_hash_data
+huser1Set = r.hset("huser:1", mapping=user1)
+huser2Set = r.hset("huser:2", mapping=user2)
+huser3Set = r.hset("huser:3", mapping=user3)
+# STEP_END
+# REMOVE_START
+assert huser1Set
+assert huser2Set
+assert huser3Set
+# REMOVE_END
+
+# STEP_START query1_hash
+findPaulHashResult = r.ft("hash-idx:users").search(
+    Query("Paul @age:[30 40]")
+)
+
+print(findPaulHashResult)
+# >>> Result{1 total, docs: [Document {'id': 'huser:3',
+# >>>   'payload': None, 'name': 'Paul Zamir', ...
+# STEP_END
+# REMOVE_START
+assert str(findPaulHashResult) == (
+    "Result{1 total, docs: [Document " +
+    "{'id': 'huser:3', 'payload': None, 'name': 'Paul Zamir', " +
+    "'email': '[email protected]', 'age': '35', 'city': 'Tel Aviv'}]}"
+)
+# REMOVE_END
+
 r.close()