valkey-glide 1.3.4rc1__cp313-cp313-macosx_11_0_arm64.whl → 2.0.0rc6__cp313-cp313-macosx_11_0_arm64.whl

glide/async_commands/server_modules/ft.py

@@ -115,7 +115,8 @@ async def search(
     options: Optional[FtSearchOptions],
 ) -> FtSearchResponse:
     """
-    Uses the provided query expression to locate keys within an index. Once located, the count and/or the content of indexed fields within those keys can be returned.
+    Uses the provided query expression to locate keys within an index. Once located, the count and/or the content of indexed
+    fields within those keys can be returned.
 
     Args:
         client (TGlideClient): The client to execute the command.
@@ -124,8 +125,11 @@ async def search(
         options (Optional[FtSearchOptions]): The search options.
 
     Returns:
-        FtSearchResponse: A two element array, where first element is count of documents in result set, and the second element, which has the format Mapping[TEncodable, Mapping[TEncodable, TEncodable]] is a mapping between document names and map of their attributes.
-        If count(option in `FtSearchOptions`) is set to true or limit(option in `FtSearchOptions`) is set to FtSearchLimit(0, 0), the command returns array with only one element - the count of the documents.
+        FtSearchResponse: A two element array, where first element is count of documents in result set, and the second
+            element, which has the format Mapping[TEncodable, Mapping[TEncodable, TEncodable]] is a mapping between document
+            names and map of their attributes.
+        If count(option in `FtSearchOptions`) is set to true or limit(option in `FtSearchOptions`) is set to
+            FtSearchLimit(0, 0), the command returns array with only one element - the count of the documents.
 
     Examples:
         For the following example to work the following must already exist:
@@ -133,8 +137,20 @@ async def search(
         - A key named {json:}1 with value {"a":1, "b":2}
 
         >>> from glide import ft
-        >>> await ft.search(glide_client, "idx", "*", options=FtSeachOptions(return_fields=[ReturnField(field_identifier="first"), ReturnField(field_identifier="second")]))
-        [1, { b'json:1': { b'first': b'42', b'second': b'33' } }] # The first element, 1 is the number of keys returned in the search result. The second element is a map of data queried per key.
+        >>> await ft.search(
+        ...     glide_client,
+        ...     "idx",
+        ...     "*",
+        ...     options=FtSeachOptions(
+        ...         return_fields=[
+        ...             ReturnField(field_identifier="first"),
+        ...             ReturnField(field_identifier="second")
+        ...         ]
+        ...     )
+        ... )
+        [1, { b'json:1': { b'first': b'42', b'second': b'33' } }]
+        # The first element, 1 is the number of keys returned in the search result. The second element is a map of
+        # data queried per key.
     """
     args: List[TEncodable] = [CommandNames.FT_SEARCH, index_name, query]
     if options:
@@ -220,7 +236,8 @@ async def info(client: TGlideClient, index_name: TEncodable) -> FtInfoResponse:
         FtInfoResponse: Nested maps with info about the index. See example for more details.
 
     Examples:
-        An index with name 'myIndex', 1 text field and 1 vector field is already created for gettting the output of this example.
+        An index with name 'myIndex', 1 text field and 1 vector field is already created for gettting the output of this
+        example.
         >>> from glide import ft
         >>> await ft.info(glide_client, "myIndex")
             [
@@ -236,7 +253,26 @@ async def info(client: TGlideClient, index_name: TEncodable) -> FtInfoResponse:
                         b'type', b'VECTOR',
                         b'option', b'',
                         b'vector_params', [
-                            b'algorithm', b'HNSW', b'data_type', b'FLOAT32', b'dimension', 2, b'distance_metric', b'L2', b'initial_capacity', 1000, b'current_capacity', 1000, b'maximum_edges', 16, b'ef_construction', 200, b'ef_runtime', 10, b'epsilon', b'0.01'
+                            b'algorithm',
+                            b'HNSW',
+                            b'data_type',
+                            b'FLOAT32',
+                            b'dimension',
+                            2,
+                            b'distance_metric',
+                            b'L2',
+                            b'initial_capacity',
+                            1000,
+                            b'current_capacity',
+                            1000,
+                            b'maximum_edges',
+                            16,
+                            b'ef_construction',
+                            200,
+                            b'ef_runtime',
+                            10,
+                            b'epsilon',
+                            b'0.01'
                         ]
                     ],
                     [
@@ -313,7 +349,8 @@ async def aggregate(
     options: Optional[FtAggregateOptions],
 ) -> FtAggregateResponse:
     """
-    A superset of the FT.SEARCH command, it allows substantial additional processing of the keys selected by the query expression.
+    A superset of the FT.SEARCH command, it allows substantial additional processing of the keys selected by the query
+    expression.
 
     Args:
         client (TGlideClient): The client to execute the command.
@@ -322,12 +359,34 @@ async def aggregate(
         options (Optional[FtAggregateOptions]): The optional arguments for the command.
 
     Returns:
-        FtAggregateResponse: An array containing a mapping of field name and associated value as returned after the last stage of the command.
+        FtAggregateResponse: An array containing a mapping of field name and associated value as returned after the last stage
+            of the command.
 
     Examples:
         >>> from glide import ft
-        >>> await ft.aggregate(glide_client, "myIndex", "*", FtAggregateOptions(loadFields=["__key"], clauses=[GroupBy(["@condition"], [Reducer("COUNT", [], "bicycles")])]))
-            [{b'condition': b'refurbished', b'bicycles': b'1'}, {b'condition': b'new', b'bicycles': b'5'}, {b'condition': b'used', b'bicycles': b'4'}]
+        >>> await ft.aggregate(
+        ...     glide_client,
+        ...     "myIndex",
+        ...     "*",
+        ...     FtAggregateOptions(
+        ...         loadFields=["__key"],
+        ...         clauses=[GroupBy(["@condition"], [Reducer("COUNT", [], "bicycles")])]
+        ...    )
+        ... )
+            [
+                {
+                    b'condition': b'refurbished',
+                    b'bicycles': b'1'
+                },
+                {
+                    b'condition': b'new',
+                    b'bicycles': b'5'
+                },
+                {
+                    b'condition': b'used',
+                    b'bicycles': b'4'
+                }
+            ]
     """
     args: List[TEncodable] = [CommandNames.FT_AGGREGATE, index_name, query]
     if options:
@@ -347,11 +406,21 @@ async def profile(
         options (FtProfileOptions): Options for the command.
 
     Returns:
-        FtProfileResponse: A two-element array. The first element contains results of query being profiled, the second element stores profiling information.
+        FtProfileResponse: A two-element array. The first element contains results of query being profiled, the second element
+            stores profiling information.
 
     Examples:
-        >>> ftSearchOptions = FtSeachOptions(return_fields=[ReturnField(field_identifier="a", alias="a_new"), ReturnField(field_identifier="b", alias="b_new")])
-        >>> await ft.profile(glide_client, "myIndex", FtProfileOptions.from_query_options(query="*", queryOptions=ftSearchOptions))
+        >>> ftSearchOptions = FtSeachOptions(
+        ...     return_fields=[
+        ...         ReturnField(field_identifier="a", alias="a_new"),
+        ...         ReturnField(field_identifier="b", alias="b_new")
+        ...     ]
+        ... )
+        >>> await ft.profile(
+        ...     glide_client,
+        ...     "myIndex",
+        ...     FtProfileOptions.from_query_options(query="*", queryOptions=ftSearchOptions)
+        ... )
             [
                 [
                     2,

glide/async_commands/server_modules/ft_options/ft_aggregate_options.py

@@ -1,6 +1,5 @@
 # Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
 from abc import ABC, abstractmethod
-from enum import Enum
 from typing import List, Mapping, Optional
 
 from glide.async_commands.command_args import OrderBy
@@ -55,7 +54,8 @@ class FtAggregateLimit(FtAggregateClause):
 
 class FtAggregateFilter(FtAggregateClause):
     """
-    A clause for filtering the results using predicate expression relating to values in each result. It is applied post query and relate to the current state of the pipeline.
+    A clause for filtering the results using predicate expression relating to values in each result. It is applied post query
+    and relate to the current state of the pipeline.
     """
 
     def __init__(self, expression: TEncodable):
@@ -79,7 +79,8 @@ class FtAggregateFilter(FtAggregateClause):
 
 class FtAggregateReducer:
     """
-    A clause for reducing the matching results in each group using a reduction function. The matching results are reduced into a single record.
+    A clause for reducing the matching results in each group using a reduction function. The matching results are reduced into
+    a single record.
     """
 
     def __init__(
@@ -130,7 +131,8 @@ class FtAggregateGroupBy(FtAggregateClause):
 
         Args:
             properties (List[TEncodable]): The list of properties to be used for grouping the results in the pipeline.
-            reducers (List[Reducer]): The list of functions that handles the group entries by performing multiple aggregate operations.
+            reducers (List[Reducer]): The list of functions that handles the group entries by performing multiple
+                aggregate operations.
         """
         self.properties = properties
         self.reducers = reducers
@@ -210,7 +212,8 @@ class FtAggregateSortBy(FtAggregateClause):
 
 class FtAggregateApply(FtAggregateClause):
     """
-    A clause for applying a 1-to-1 transformation on one or more properties and stores the result as a new property down the pipeline or replaces any property using this transformation.
+    A clause for applying a 1-to-1 transformation on one or more properties and stores the result as a new property down the
+    pipeline or replaces any property using this transformation.
     """
 
     def __init__(self, expression: TEncodable, name: TEncodable):
@@ -219,7 +222,8 @@ class FtAggregateApply(FtAggregateClause):
 
         Args:
             expression (TEncodable): The expression to be transformed.
-            name (TEncodable): The new property name to store the result of apply. This name can be referenced by further APPLY/SORTBY/GROUPBY/REDUCE operations down the pipeline.
+            name (TEncodable): The new property name to store the result of apply. This name can be referenced by further
+                APPLY/SORTBY/GROUPBY/REDUCE operations down the pipeline.
         """
         self.expression = expression
         self.name = name
@@ -259,8 +263,11 @@ class FtAggregateOptions:
             loadAll (Optional[bool]): An option to load all fields declared in the index.
             loadFields (Optional[List[TEncodable]]): An option to load only the fields passed in this list.
             timeout (Optional[int]): Overrides the timeout parameter of the module.
-            params (Optional[Mapping[TEncodable, TEncodable]]): The key/value pairs can be referenced from within the query expression.
-            clauses (Optional[List[FtAggregateClause]]): FILTER, LIMIT, GROUPBY, SORTBY and APPLY clauses, that can be repeated multiple times in any order and be freely intermixed. They are applied in the order specified, with the output of one clause feeding the input of the next clause.
+            params (Optional[Mapping[TEncodable, TEncodable]]): The key/value pairs can be referenced from within the
+                query expression.
+            clauses (Optional[List[FtAggregateClause]]): FILTER, LIMIT, GROUPBY, SORTBY and APPLY clauses, that can be
+                repeated multiple times in any order and be freely intermixed. They are applied in the order specified, with
+                the output of one clause feeding the input of the next clause.
         """
         self.loadAll = loadAll
         self.loadFields = loadFields

glide/async_commands/server_modules/ft_options/ft_create_options.py

@@ -159,8 +159,10 @@ class TagField(Field):
         Args:
             name (TEncodable): The name of the tag field.
             alias (Optional[TEncodable]): An alias for the field.
-            separator (Optional[TEncodable]): Specify how text in the attribute is split into individual tags. Must be a single character.
-            case_sensitive (bool): Preserve the original letter cases of tags. If set to False, characters are converted to lowercase by default.
+            separator (Optional[TEncodable]): Specify how text in the attribute is split into individual tags. Must be a
+                single character.
+            case_sensitive (bool): Preserve the original letter cases of tags. If set to False, characters are converted to
+                lowercase by default.
         """
         super().__init__(name, FieldType.TAG, alias)
         self.separator = separator
@@ -209,7 +211,8 @@ class VectorFieldAttributes(ABC):
 
         Args:
             dimensions (int): Number of dimensions in the vector. Equivalent to `DIM` on the module API.
-            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
+            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of
+                `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
             type (VectorType): Vector type. The only supported type is `FLOAT32`. Equivalent to `TYPE` on the module API.
         """
         self.dimensions = dimensions
@@ -251,9 +254,11 @@ class VectorFieldAttributesFlat(VectorFieldAttributes):
 
         Args:
             dimensions (int): Number of dimensions in the vector. Equivalent to `DIM` on the module API.
-            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
+            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of
+                `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
             type (VectorType): Vector type. The only supported type is `FLOAT32`. Equivalent to `TYPE` on the module API.
-            initial_cap (Optional[int]): Initial vector capacity in the index affecting memory allocation size of the index. Defaults to `1024`. Equivalent to `INITIAL_CAP` on the module API.
+            initial_cap (Optional[int]): Initial vector capacity in the index affecting memory allocation size of the index.
+                Defaults to `1024`. Equivalent to `INITIAL_CAP` on the module API.
         """
         super().__init__(dimensions, distance_metric, type)
         self.initial_cap = initial_cap
@@ -285,12 +290,18 @@ class VectorFieldAttributesHnsw(VectorFieldAttributes):
 
         Args:
             dimensions (int): Number of dimensions in the vector. Equivalent to `DIM` on the module API.
-            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
+            distance_metric (DistanceMetricType): The distance metric used in vector type field. Can be one of
+                `[L2 | IP | COSINE]`. Equivalent to `DISTANCE_METRIC` on the module API.
             type (VectorType): Vector type. The only supported type is `FLOAT32`. Equivalent to `TYPE` on the module API.
-            initial_cap (Optional[int]): Initial vector capacity in the index affecting memory allocation size of the index. Defaults to `1024`. Equivalent to `INITIAL_CAP` on the module API.
-            number_of_edges (Optional[int]): Number of maximum allowed outgoing edges for each node in the graph in each layer. Default is `16`, maximum is `512`. Equivalent to `M` on the module API.
-            vectors_examined_on_construction (Optional[int]): Controls the number of vectors examined during index construction. Default value is `200`, Maximum value is `4096`. Equivalent to `EF_CONSTRUCTION` on the module API.
-            vectors_examined_on_runtime (Optional[int]): Controls the number of vectors examined during query operations. Default value is `10`, Maximum value is `4096`. Equivalent to `EF_RUNTIME` on the module API.
+            initial_cap (Optional[int]): Initial vector capacity in the index affecting memory allocation size of the index.
+                Defaults to `1024`. Equivalent to `INITIAL_CAP` on the module API.
+            number_of_edges (Optional[int]): Number of maximum allowed outgoing edges for each node in the graph in each layer.
+                Default is `16`, maximum is `512`. Equivalent to `M` on the module API.
+            vectors_examined_on_construction (Optional[int]): Controls the number of vectors examined during index
+                construction. Default value is `200`, Maximum value is `4096`. Equivalent to `EF_CONSTRUCTION` on the
+                module API.
+            vectors_examined_on_runtime (Optional[int]): Controls the number of vectors examined during query operations.
+                Default value is `10`, Maximum value is `4096`. Equivalent to `EF_RUNTIME` on the module API.
         """
         super().__init__(dimensions, distance_metric, type)
         self.initial_cap = initial_cap
@@ -337,7 +348,8 @@ class VectorField(Field):
             name (TEncodable): The name of the vector field.
             algorithm (VectorAlgorithm): The vector indexing algorithm.
             alias (Optional[TEncodable]): An alias for the field.
-            attributes (VectorFieldAttributes): Additional attributes to be passed with the vector field after the algorithm name.
+            attributes (VectorFieldAttributes): Additional attributes to be passed with the vector field after the
+                algorithm name.
         """
         super().__init__(name, FieldType.VECTOR, alias)
         self.algorithm = algorithm

glide/async_commands/server_modules/ft_options/ft_profile_options.py

@@ -45,9 +45,11 @@ class FtProfileOptions:
         Initialize a new FtProfileOptions instance.
 
         Args:
-            query (TEncodable): The query that is being profiled. This is the query argument from the FT.AGGREGATE/FT.SEARCH command.
+            query (TEncodable): The query that is being profiled. This is the query argument from the
+                FT.AGGREGATE/FT.SEARCH command.
             query_type (Optional[QueryType]): The type of query to be profiled.
-            query_options (Optional[Union[FtSearchOptions, FtAggregateOptions]]): The arguments/options for the FT.AGGREGATE/FT.SEARCH command being profiled.
+            query_options (Optional[Union[FtSearchOptions, FtAggregateOptions]]): The arguments/options for the
+                FT.AGGREGATE/FT.SEARCH command being profiled.
             limited (Optional[bool]): To provide some brief version of the output, otherwise a full verbose output is provided.
         """
         self.query = query
@@ -66,12 +68,14 @@ class FtProfileOptions:
         A class method to create FtProfileOptions with FT.SEARCH/FT.AGGREGATE options.
 
         Args:
-            query (TEncodable): The query that is being profiled. This is the query argument from the FT.AGGREGATE/FT.SEARCH command.
-            query_options (Optional[Union[FtSearchOptions, FtAggregateOptions]]): The arguments/options for the FT.AGGREGATE/FT.SEARCH command being profiled.
+            query (TEncodable): The query that is being profiled. This is the query argument from the
+                FT.AGGREGATE/FT.SEARCH command.
+            query_options (Optional[Union[FtSearchOptions, FtAggregateOptions]]): The arguments/options for the
+                FT.AGGREGATE/FT.SEARCH command being profiled.
             limited (Optional[bool]): To provide some brief version of the output, otherwise a full verbose output is provided.
         """
         query_type: QueryType = QueryType.SEARCH
-        if type(query_options) == FtAggregateOptions:
+        if isinstance(query_options, FtAggregateOptions):
             query_type = QueryType.AGGREGATE
         return cls(query, query_type, query_options, limited)
 
@@ -83,7 +87,8 @@ class FtProfileOptions:
         A class method to create FtProfileOptions with QueryType.
 
         Args:
-            query (TEncodable): The query that is being profiled. This is the query argument from the FT.AGGREGATE/FT.SEARCH command.
+            query (TEncodable): The query that is being profiled. This is the query argument from the
+                FT.AGGREGATE/FT.SEARCH command.
             query_type (QueryType): The type of query to be profiled.
             limited (Optional[bool]): To provide some brief version of the output, otherwise a full verbose output is provided.
         """
@@ -101,7 +106,7 @@ class FtProfileOptions:
             args.append(FtProfileKeywords.LIMITED)
         args.extend([FtProfileKeywords.QUERY, self.query])
         if self.query_options:
-            if type(self.query_options) == FtAggregateOptions:
+            if isinstance(self.query_options, FtAggregateOptions):
                 args.extend(cast(FtAggregateOptions, self.query_options).to_args())
             else:
                 args.extend(cast(FtSearchOptions, self.query_options).to_args())

glide/async_commands/server_modules/ft_options/ft_search_options.py

@@ -49,7 +49,8 @@ class ReturnField:
         Initialize a new ReturnField instance.
 
         Args:
-            field_identifier (TEncodable): The identifier for the field of the key that has to returned as a result of FT.SEARCH command.
+            field_identifier (TEncodable): The identifier for the field of the key that has to returned as a result of
+                FT.SEARCH command.
             alias (Optional[TEncodable]): The alias to override the name of the field in the FT.SEARCH result.
         """
         self.field_identifier = field_identifier
@@ -87,11 +88,16 @@ class FtSearchOptions:
         Initialize the FT.SEARCH optional fields.
 
         Args:
-            return_fields (Optional[List[ReturnField]]): The fields of a key that are returned by FT.SEARCH command. See `ReturnField`.
-            timeout (Optional[int]): This value overrides the timeout parameter of the module. The unit for the timout is in milliseconds.
-            params (Optional[Mapping[TEncodable, TEncodable]]): Param key/value pairs that can be referenced from within the query expression.
-            limit (Optional[FtSearchLimit]): This option provides pagination capability. Only the keys that satisfy the offset and count values are returned. See `FtSearchLimit`.
-            count (Optional[bool]): This flag option suppresses returning the contents of keys. Only the number of keys is returned.
+            return_fields (Optional[List[ReturnField]]): The fields of a key that are returned by FT.SEARCH command.
+                See `ReturnField`.
+            timeout (Optional[int]): This value overrides the timeout parameter of the module.
+                The unit for the timout is in milliseconds.
+            params (Optional[Mapping[TEncodable, TEncodable]]): Param key/value pairs that can be referenced from within the
+                query expression.
+            limit (Optional[FtSearchLimit]): This option provides pagination capability. Only the keys that satisfy the offset
+                and count values are returned. See `FtSearchLimit`.
+            count (Optional[bool]): This flag option suppresses returning the contents of keys.
+                Only the number of keys is returned.
         """
         self.return_fields = return_fields
         self.timeout = timeout