Python: Moved PubSubMsg class to a shared module

Signed-off-by: barshaul <[email protected]>

Author: barshaul

python/python/glide/__init__.py

@@ -1,6 +1,5 @@
 # Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
 
-from glide.commands.async_commands.core import CoreCommands
 from glide.commands.batch import (
     Batch,
     ClusterBatch,
@@ -38,6 +37,7 @@
     InfoSection,
     InsertPosition,
     OnlyIfEqual,
+    PubSubMsg,
     UpdateOptions,
 )
 from glide.commands.server_modules import ft, glide_json, json_batch
@@ -170,8 +170,6 @@
 
 from .glide import ClusterScanCursor, Script
 
-PubSubMsg = CoreCommands.PubSubMsg
-
 __all__ = [
     # Client
     "GlideClient",

python/python/glide/commands/async_commands/core.py

@@ -1,5 +1,4 @@
 # Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
-from dataclasses import dataclass
 from typing import Dict, List, Mapping, Optional, Protocol, Set, Tuple, Union, cast
 
 from glide.commands.bitmap import (
@@ -18,6 +17,7 @@
     ExpirySet,
     InsertPosition,
     OnlyIfEqual,
+    PubSubMsg,
     UpdateOptions,
     _build_sort_args,
 )
@@ -6647,21 +6647,6 @@ async def watch(self, keys: List[TEncodable]) -> TOK:
             await self._execute_command(RequestType.Watch, keys),
         )
 
-    @dataclass
-    class PubSubMsg:
-        """
-        Describes the incoming pubsub message
-
-        Attributes:
-            message (TEncodable): Incoming message.
-            channel (TEncodable): Name of an channel that triggered the message.
-            pattern (Optional[TEncodable]): Pattern that triggered the message.
-        """
-
-        message: TEncodable
-        channel: TEncodable
-        pattern: Optional[TEncodable]
-
     async def get_pubsub_message(self) -> PubSubMsg:
         """
         Returns the next pubsub message.

python/python/glide/commands/core_options.py

@@ -8,6 +8,22 @@
 from glide.constants import TEncodable
 
 
+@dataclass
+class PubSubMsg:
+    """
+    Describes the incoming pubsub message
+
+    Attributes:
+        message (TEncodable): Incoming message.
+        channel (TEncodable): Name of an channel that triggered the message.
+        pattern (Optional[TEncodable]): Pattern that triggered the message.
+    """
+
+    message: TEncodable
+    channel: TEncodable
+    pattern: Optional[TEncodable]
+
+
 class ConditionalChange(Enum):
     """
     A condition to the `SET`, `ZADD` and `GEOADD` commands.

python/python/glide/config.py

@@ -6,7 +6,7 @@
 from enum import Enum, IntEnum
 from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Union
 
-from glide.commands.async_commands.core import CoreCommands
+from glide.commands.core_options import PubSubMsg
 from glide.exceptions import ConfigurationError
 from glide.protobuf.connection_request_pb2 import ConnectionRequest
 from glide.protobuf.connection_request_pb2 import ProtocolVersion as SentProtocolVersion
@@ -308,7 +308,7 @@ def _is_pubsub_configured(self) -> bool:
 
     def _get_pubsub_callback_and_context(
         self,
-    ) -> Tuple[Optional[Callable[[CoreCommands.PubSubMsg, Any], None]], Any]:
+    ) -> Tuple[Optional[Callable[[PubSubMsg, Any], None]], Any]:
         return None, None
 
 
@@ -387,7 +387,7 @@ class PubSubSubscriptions:
         Attributes:
             channels_and_patterns (Dict[GlideClientConfiguration.PubSubChannelModes, Set[str]]):
                 Channels and patterns by modes.
-            callback (Optional[Callable[[CoreCommands.PubSubMsg, Any], None]]):
+            callback (Optional[Callable[[PubSubMsg, Any], None]]):
                 Optional callback to accept the incomming messages.
             context (Any):
                 Arbitrary context to pass to the callback.
@@ -396,7 +396,7 @@ class PubSubSubscriptions:
         channels_and_patterns: Dict[
             GlideClientConfiguration.PubSubChannelModes, Set[str]
         ]
-        callback: Optional[Callable[[CoreCommands.PubSubMsg, Any], None]]
+        callback: Optional[Callable[[PubSubMsg, Any], None]]
         context: Any
 
     def __init__(
@@ -468,7 +468,7 @@ def _is_pubsub_configured(self) -> bool:
 
     def _get_pubsub_callback_and_context(
         self,
-    ) -> Tuple[Optional[Callable[[CoreCommands.PubSubMsg, Any], None]], Any]:
+    ) -> Tuple[Optional[Callable[[PubSubMsg, Any], None]], Any]:
         if self.pubsub_subscriptions:
             return self.pubsub_subscriptions.callback, self.pubsub_subscriptions.context
         return None, None
@@ -557,7 +557,7 @@ class PubSubSubscriptions:
         Attributes:
             channels_and_patterns (Dict[GlideClusterClientConfiguration.PubSubChannelModes, Set[str]]):
                 Channels and patterns by modes.
-            callback (Optional[Callable[[CoreCommands.PubSubMsg, Any], None]]):
+            callback (Optional[Callable[[PubSubMsg, Any], None]]):
                 Optional callback to accept the incoming messages.
             context (Any):
                 Arbitrary context to pass to the callback.
@@ -566,7 +566,7 @@ class PubSubSubscriptions:
         channels_and_patterns: Dict[
             GlideClusterClientConfiguration.PubSubChannelModes, Set[str]
         ]
-        callback: Optional[Callable[[CoreCommands.PubSubMsg, Any], None]]
+        callback: Optional[Callable[[PubSubMsg, Any], None]]
         context: Any
 
     def __init__(
@@ -644,7 +644,7 @@ def _is_pubsub_configured(self) -> bool:
 
     def _get_pubsub_callback_and_context(
         self,
-    ) -> Tuple[Optional[Callable[[CoreCommands.PubSubMsg, Any], None]], Any]:
+    ) -> Tuple[Optional[Callable[[PubSubMsg, Any], None]], Any]:
         if self.pubsub_subscriptions:
             return self.pubsub_subscriptions.callback, self.pubsub_subscriptions.context
         return None, None

python/python/glide/glide_client.py

@@ -9,6 +9,7 @@
 from glide.commands.async_commands.core import CoreCommands
 from glide.commands.async_commands.standalone_commands import StandaloneCommands
 from glide.commands.command_args import ObjectType
+from glide.commands.core_options import PubSubMsg
 from glide.config import BaseClientConfiguration, ServerCredentials
 from glide.constants import DEFAULT_READ_BYTES_SIZE, OK, TEncodable, TRequest, TResult
 from glide.exceptions import (
@@ -400,7 +401,7 @@ async def _execute_script(
         set_protobuf_route(request, route)
         return await self._write_request_await_response(request)
 
-    async def get_pubsub_message(self) -> CoreCommands.PubSubMsg:
+    async def get_pubsub_message(self) -> PubSubMsg:
         if self._is_closed:
             raise ClosingError(
                 "Unable to execute requests; the client is closed. Please create a new client."
@@ -426,7 +427,7 @@ async def get_pubsub_message(self) -> CoreCommands.PubSubMsg:
             self._pubsub_lock.release()
         return await response_future
 
-    def try_get_pubsub_message(self) -> Optional[CoreCommands.PubSubMsg]:
+    def try_get_pubsub_message(self) -> Optional[PubSubMsg]:
         if self._is_closed:
             raise ClosingError(
                 "Unable to execute requests; the client is closed. Please create a new client."
@@ -443,7 +444,7 @@ def try_get_pubsub_message(self) -> Optional[CoreCommands.PubSubMsg]:
             )
 
         # locking might not be required
-        msg: Optional[CoreCommands.PubSubMsg] = None
+        msg: Optional[PubSubMsg] = None
         try:
             self._pubsub_lock.acquire()
             self._complete_pubsub_futures_safe()
@@ -462,7 +463,7 @@ def _cancel_pubsub_futures_with_exception_safe(self, exception: ConnectionError)
 
     def _notification_to_pubsub_message_safe(
         self, response: Response
-    ) -> Optional[CoreCommands.PubSubMsg]:
+    ) -> Optional[PubSubMsg]:
         pubsub_message = None
         push_notification = cast(
             Dict[str, Any], value_from_pointer(response.resp_pointer)
@@ -481,11 +482,11 @@ def _notification_to_pubsub_message_safe(
         ):
             values: List = push_notification["values"]
             if message_kind == "PMessage":
-                pubsub_message = BaseClient.PubSubMsg(
+                pubsub_message = PubSubMsg(
                     message=values[2], channel=values[1], pattern=values[0]
                 )
             else:
-                pubsub_message = BaseClient.PubSubMsg(
+                pubsub_message = PubSubMsg(
                     message=values[1], channel=values[0], pattern=None
                 )
         elif (