valkey-glide 2.0.0__cp39-cp39-macosx_11_0_arm64.whl → 2.2.5rc1__cp39-cp39-macosx_11_0_arm64.whl

glide/__init__.py

@@ -1,18 +1,28 @@
 # Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
 
-from glide.async_commands.batch import (
-    Batch,
-    ClusterBatch,
-    ClusterTransaction,
-    TBatch,
-    Transaction,
+import sys
+import types
+import warnings
+
+from glide.glide import (
+    ClusterScanCursor,
+    OpenTelemetryConfig,
+    OpenTelemetryMetricsConfig,
+    OpenTelemetryTracesConfig,
+    Script,
 )
-from glide.async_commands.batch_options import (
+from glide_shared import (
+    OK,
+    TOK,
+    AdvancedGlideClientConfiguration,
+    AdvancedGlideClusterClientConfiguration,
+    AggregationType,
+    AllNodes,
+    AllPrimaries,
+    BackoffStrategy,
+    Batch,
     BatchOptions,
     BatchRetryStrategy,
-    ClusterBatchOptions,
-)
-from glide.async_commands.bitmap import (
     BitEncoding,
     BitFieldGet,
     BitFieldIncrBy,
@@ -25,28 +35,26 @@ from glide.async_commands.bitmap import (
     BitOffsetMultiplier,
     BitOverflowControl,
     BitwiseOperation,
-    OffsetOptions,
-    SignedEncoding,
-    UnsignedEncoding,
-)
-from glide.async_commands.command_args import Limit, ListDirection, ObjectType, OrderBy
-from glide.async_commands.core import (
+    ByAddressRoute,
+    ClosingError,
+    ClusterBatch,
+    ClusterBatchOptions,
+    ClusterTransaction,
     ConditionalChange,
-    CoreCommands,
+    ConfigurationError,
+    ConnectionError,
+    DataType,
+    DistanceMetricType,
+    ExclusiveIdBound,
+    ExecAbortError,
     ExpireOptions,
     ExpiryGetEx,
     ExpirySet,
     ExpiryType,
     ExpiryTypeGetEx,
+    Field,
+    FieldType,
     FlushMode,
-    FunctionRestorePolicy,
-    InfoSection,
-    InsertPosition,
-    OnlyIfEqual,
-    UpdateOptions,
-)
-from glide.async_commands.server_modules import ft, glide_json, json_batch
-from glide.async_commands.server_modules.ft_options.ft_aggregate_options import (
     FtAggregateApply,
     FtAggregateClause,
     FtAggregateFilter,
@@ -54,59 +62,66 @@ from glide.async_commands.server_modules.ft_options.ft_aggregate_options import
     FtAggregateLimit,
     FtAggregateOptions,
     FtAggregateReducer,
+    FtAggregateResponse,
     FtAggregateSortBy,
     FtAggregateSortProperty,
-)
-from glide.async_commands.server_modules.ft_options.ft_create_options import (
-    DataType,
-    DistanceMetricType,
-    Field,
-    FieldType,
     FtCreateOptions,
-    NumericField,
-    TagField,
-    TextField,
-    VectorAlgorithm,
-    VectorField,
-    VectorFieldAttributes,
-    VectorFieldAttributesFlat,
-    VectorFieldAttributesHnsw,
-    VectorType,
-)
-from glide.async_commands.server_modules.ft_options.ft_profile_options import (
+    FtInfoResponse,
     FtProfileOptions,
-    QueryType,
-)
-from glide.async_commands.server_modules.ft_options.ft_search_options import (
+    FtProfileResponse,
     FtSearchLimit,
     FtSearchOptions,
-    ReturnField,
-)
-from glide.async_commands.server_modules.glide_json import (
-    JsonArrIndexOptions,
-    JsonArrPopOptions,
-    JsonGetOptions,
-)
-from glide.async_commands.sorted_set import (
-    AggregationType,
+    FtSearchResponse,
+    FunctionRestorePolicy,
     GeoSearchByBox,
     GeoSearchByRadius,
     GeoSearchCount,
     GeospatialData,
     GeoUnit,
+    GlideClientConfiguration,
+    GlideClusterClientConfiguration,
+    GlideError,
+    HashFieldConditionalChange,
+    IamAuthConfig,
+    IdBound,
     InfBound,
+    InfoSection,
+    InsertPosition,
+    JsonArrIndexOptions,
+    JsonArrPopOptions,
+    JsonGetOptions,
     LexBoundary,
+    Limit,
+    ListDirection,
+    MaxId,
+    MinId,
+    NodeAddress,
+    NumericField,
+    ObjectType,
+    OffsetOptions,
+    OnlyIfEqual,
+    OrderBy,
+    PeriodicChecksManualInterval,
+    PeriodicChecksStatus,
+    ProtocolVersion,
+    PubSubMsg,
+    QueryType,
+    RandomNode,
     RangeByIndex,
     RangeByLex,
     RangeByScore,
+    ReadFrom,
+    RequestError,
+    ReturnField,
+    Route,
     ScoreBoundary,
     ScoreFilter,
-)
-from glide.async_commands.stream import (
-    ExclusiveIdBound,
-    IdBound,
-    MaxId,
-    MinId,
+    ServerCredentials,
+    ServiceType,
+    SignedEncoding,
+    SlotIdRoute,
+    SlotKeyRoute,
+    SlotType,
     StreamAddOptions,
     StreamClaimOptions,
     StreamGroupOptions,
@@ -115,84 +130,100 @@ from glide.async_commands.stream import (
     StreamReadGroupOptions,
     StreamReadOptions,
     StreamTrimOptions,
-    TrimByMaxLen,
-    TrimByMinId,
-)
-from glide.config import (
-    AdvancedGlideClientConfiguration,
-    AdvancedGlideClusterClientConfiguration,
-    BackoffStrategy,
-    GlideClientConfiguration,
-    GlideClusterClientConfiguration,
-    NodeAddress,
-    PeriodicChecksManualInterval,
-    PeriodicChecksStatus,
-    ProtocolVersion,
-    ReadFrom,
-    ServerCredentials,
-    TlsAdvancedConfiguration,
-)
-from glide.constants import (
-    OK,
-    TOK,
-    FtAggregateResponse,
-    FtInfoResponse,
-    FtProfileResponse,
-    FtSearchResponse,
+    TagField,
+    TBatch,
     TClusterResponse,
     TEncodable,
+    TextField,
     TFunctionListResponse,
     TFunctionStatsFullResponse,
     TFunctionStatsSingleNodeResponse,
+    TimeoutError,
     TJsonResponse,
     TJsonUniversalResponse,
+    TlsAdvancedConfiguration,
+    Transaction,
     TResult,
+    TrimByMaxLen,
+    TrimByMinId,
     TSingleNodeRoute,
     TXInfoStreamFullResponse,
     TXInfoStreamResponse,
-)
-from glide.exceptions import (
-    ClosingError,
-    ConfigurationError,
-    ConnectionError,
-    ExecAbortError,
-    GlideError,
-    RequestError,
-    TimeoutError,
-)
-from glide.glide_client import GlideClient, GlideClusterClient, TGlideClient
-from glide.logger import Level as LogLevel
-from glide.logger import Logger
-from glide.routes import (
-    AllNodes,
-    AllPrimaries,
-    ByAddressRoute,
-    RandomNode,
-    Route,
-    SlotIdRoute,
-    SlotKeyRoute,
-    SlotType,
+    UnsignedEncoding,
+    UpdateOptions,
+    VectorAlgorithm,
+    VectorField,
+    VectorFieldAttributes,
+    VectorFieldAttributesFlat,
+    VectorFieldAttributesHnsw,
+    VectorType,
+    json_batch,
 )
 
-from .glide import (
-    ClusterScanCursor,
-    OpenTelemetryConfig,
-    OpenTelemetryMetricsConfig,
-    OpenTelemetryTracesConfig,
-    Script,
-)
+from .async_commands import ft, glide_json
+from .glide_client import GlideClient, GlideClusterClient, TGlideClient
+from .logger import Level as LogLevel
+from .logger import Logger
+
+_glide_module = sys.modules[__name__]
+
+_legacy_modules = [
+    "glide.exceptions",
+    "glide.config",
+    "glide.constants",
+    "glide.routes",
+    "glide.async_commands",
+    "glide.async_commands.batch",
+    "glide.async_commands.batch_options",
+    "glide.async_commands.bitmap",
+    "glide.async_commands.command_args",
+    "glide.async_commands.server_modules",
+    "glide.async_commands.server_modules.ft_options",
+    "glide.async_commands.server_modules.ft_options.ft_aggregate_options",
+    "glide.async_commands.server_modules.ft_options.ft_create_options",
+    "glide.async_commands.server_modules.ft_options.ft_profile_options",
+    "glide.async_commands.server_modules.ft_options.ft_search_options",
+    "glide.async_commands.server_modules.glide_json",
+    "glide.async_commands.sorted_set",
+    "glide.async_commands.stream",
+]
+
+
+class _LegacyModule(types.ModuleType):
+    """Proxy for a deprecated module that warns when first accessed."""
+
+    def __init__(self, name):
+        super().__init__(name)
+        self._warned = False
 
-PubSubMsg = CoreCommands.PubSubMsg
+    def __getattr__(self, name):
+        if not self._warned:
+            warnings.warn(
+                f"Importing from '{self.__name__}' is deprecated. "
+                f"Please import directly from 'glide' instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self._warned = True
+
+        # Access the attribute from the real top-level glide module
+        return getattr(_glide_module, name)
+
+
+# Replace old modules with lazy proxy modules
+for old_name in _legacy_modules:
+    if old_name not in sys.modules:
+        sys.modules[old_name] = _LegacyModule(old_name)
 
 __all__ = [
     # Client
+    "TGlideClient",
     "GlideClient",
     "GlideClusterClient",
     "Batch",
     "ClusterBatch",
     "ClusterTransaction",
     "Transaction",
-    "TGlideClient",
     "TBatch",
     # Batch Options
     "BatchOptions",
@@ -206,13 +237,16 @@ __all__ = [
     "BackoffStrategy",
     "ReadFrom",
     "ServerCredentials",
+    "ServiceType",
+    "IamAuthConfig",
     "NodeAddress",
     "OpenTelemetryConfig",
-    "OpenTelemetryTracesConfig",
     "OpenTelemetryMetricsConfig",
+    "OpenTelemetryTracesConfig",
     "ProtocolVersion",
     "PeriodicChecksManualInterval",
     "PeriodicChecksStatus",
+    "TlsAdvancedConfiguration",
     # Response
     "OK",
     "TClusterResponse",
@@ -224,7 +258,6 @@ __all__ = [
     "TJsonUniversalResponse",
     "TOK",
     "TResult",
-    "TlsAdvancedConfiguration",
     "TXInfoStreamFullResponse",
     "TXInfoStreamResponse",
     "FtAggregateResponse",
@@ -263,11 +296,11 @@ __all__ = [
     "GeoSearchCount",
     "GeoUnit",
     "GeospatialData",
+    "HashFieldConditionalChange",
     "AggregationType",
     "InfBound",
     "InfoSection",
     "InsertPosition",
-    "ft",
     "LexBoundary",
     "Limit",
     "ListDirection",
@@ -323,6 +356,7 @@ __all__ = [
     "RequestError",
     "TimeoutError",
     # Ft
+    "ft",
     "DataType",
     "DistanceMetricType",
     "Field",

glide/async_commands/cluster_commands.py

@@ -4,16 +4,16 @@ from __future__ import annotations
 
 from typing import Dict, List, Mapping, Optional, Union, cast
 
-from glide.async_commands.batch import ClusterBatch
-from glide.async_commands.batch_options import ClusterBatchOptions
-from glide.async_commands.command_args import ObjectType
-from glide.async_commands.core import (
-    CoreCommands,
+from glide.glide import ClusterScanCursor, Script
+from glide_shared.commands.batch import ClusterBatch
+from glide_shared.commands.batch_options import ClusterBatchOptions
+from glide_shared.commands.command_args import ObjectType
+from glide_shared.commands.core_options import (
     FlushMode,
     FunctionRestorePolicy,
     InfoSection,
 )
-from glide.constants import (
+from glide_shared.constants import (
     TOK,
     TClusterResponse,
     TEncodable,
@@ -21,11 +21,11 @@ from glide.constants import (
     TFunctionStatsSingleNodeResponse,
     TResult,
 )
-from glide.exceptions import RequestError
-from glide.protobuf.command_request_pb2 import RequestType
-from glide.routes import Route
+from glide_shared.exceptions import RequestError
+from glide_shared.protobuf.command_request_pb2 import RequestType
+from glide_shared.routes import Route
 
-from ..glide import ClusterScanCursor, Script
+from .core import CoreCommands
 
 
 class ClusterCommands(CoreCommands):
@@ -1066,11 +1066,17 @@ class ClusterCommands(CoreCommands):
         self,
         source: TEncodable,
         destination: TEncodable,
+        # TODO next major release the arguments replace and destinationDB must have their order
+        # swapped to align with the standalone order.
+        # At the moment of the patch release 2.1.1. we can't have a breaking change
         replace: Optional[bool] = None,
+        destinationDB: Optional[int] = None,
     ) -> bool:
         """
-        Copies the value stored at the `source` to the `destination` key. When `replace` is True,
-        removes the `destination` key first if it already exists, otherwise performs no action.
+        Copies the value stored at the `source` to the `destination` key. If `destinationDB`
+        is specified, the value will be copied to the database specified by `destinationDB`,
+        otherwise the current database will be used. When `replace` is True, removes the
+        `destination` key first if it already exists, otherwise performs no action.
 
         See [valkey.io](https://valkey.io/commands/copy) for more details.
 
@@ -1081,6 +1087,7 @@ class ClusterCommands(CoreCommands):
             source (TEncodable): The key to the source value.
             destination (TEncodable): The key where the value should be copied to.
             replace (Optional[bool]): If the destination key should be removed before copying the value to it.
+            destinationDB (Optional[int]): The alternative logical database index for the destination key.
 
         Returns:
             bool: True if the source was copied. Otherwise, returns False.
@@ -1089,12 +1096,20 @@ class ClusterCommands(CoreCommands):
             >>> await client.set("source", "sheep")
             >>> await client.copy(b"source", b"destination")
                 True # Source was copied
+            >>> await client.copy(b"source", b"destination", destinationDB=1)
+                True # Source was copied to DB 1
+            >>> await client.select(1)
             >>> await client.get("destination")
                 b"sheep"
 
         Since: Valkey version 6.2.0.
+               The destinationDB argument is available since Valkey 9.0.0
         """
+
+        # Build command arguments
         args: List[TEncodable] = [source, destination]
+        if destinationDB is not None:
+            args.extend(["DB", str(destinationDB)])
         if replace is True:
             args.append("REPLACE")
         return cast(
@@ -1141,7 +1156,7 @@ class ClusterCommands(CoreCommands):
             args.extend(["VERSION", str(version)])
         if parameters:
             for var in parameters:
-                args.extend(str(var))
+                args.append(str(var))
         return cast(
             TClusterResponse[bytes],
             await self._execute_command(RequestType.Lolwut, args, route),
@@ -1421,7 +1436,7 @@ class ClusterCommands(CoreCommands):
 
         Examples:
             >>> lua_script = Script("return { KEYS[1], ARGV[1] }")
-            >>> await client.invoke_script(lua_script, keys=["foo"], args=["bar"] );
+            >>> await client.invoke_script(lua_script, keys=["foo"], args=["bar"])
                 [b"foo", b"bar"]
         """
         return await self._execute_script(script.get_hash(), keys, args)