moved soup_app package to soup package

Author: Sam Daniel Thangarajan

src/nasdaq_protocols/itch/core.py

@@ -1,5 +1,5 @@
 import attrs
-from nasdaq_protocols.soup_app import SoupAppMessage
+from nasdaq_protocols.soup import soup_app
 from nasdaq_protocols.common import logable
 
 
@@ -11,7 +11,7 @@
 
 @attrs.define
 @logable
-class Message(SoupAppMessage, app_name=APP_NAME):
+class Message(soup_app.SoupAppMessage, app_name=APP_NAME):
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)

src/nasdaq_protocols/itch/session.py

@@ -2,7 +2,7 @@
 
 import attrs
 from nasdaq_protocols import soup
-from nasdaq_protocols.soup_app.session import BaseClientSession, SessionId
+from nasdaq_protocols.soup import soup_app
 from .core import Message
 
 __all__ = [
@@ -17,13 +17,13 @@
 
 
 @attrs.define(auto_attribs=True)
-class ItchSessionId(SessionId):
+class ItchSessionId(soup_app.SoupAppSessionId):
     soup_session_id: soup.SoupSessionId = None
     protocol_name: str = "itch"
 
 
 @attrs.define(auto_attribs=True)
-class ClientSession(BaseClientSession):
+class ClientSession(soup_app.SoupAppClientSession):
     """ITCH protocol client session implementation."""
 
     def _create_session_id(self):

src/nasdaq_protocols/ouch/core.py

@@ -1,5 +1,5 @@
 import attrs
-from nasdaq_protocols.soup_app import SoupAppMessage
+from nasdaq_protocols.soup import soup_app
 from nasdaq_protocols.common import logable
 
 
@@ -11,7 +11,7 @@
 
 @attrs.define
 @logable
-class Message(SoupAppMessage, app_name=APP_NAME):
+class Message(soup_app.SoupAppMessage, app_name=APP_NAME):
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)

src/nasdaq_protocols/ouch/session.py

@@ -2,7 +2,7 @@
 
 import attrs
 from nasdaq_protocols import soup
-from nasdaq_protocols.soup_app.session import BaseClientSession, SessionId
+from nasdaq_protocols.soup import soup_app
 from .core import Message
 
 __all__ = [
@@ -17,13 +17,13 @@
 
 
 @attrs.define(auto_attribs=True)
-class OuchSessionId(SessionId):
+class OuchSessionId(soup_app.SoupAppSessionId):
     soup_session_id: soup.SoupSessionId = None
     protocol_name: str = "ouch"
 
 
 @attrs.define(auto_attribs=True)
-class ClientSession(BaseClientSession):
+class ClientSession(soup_app.SoupAppClientSession):
 
     def _create_session_id(self):
         return OuchSessionId(self.soup_session.session_id)

src/nasdaq_protocols/soup/__init__.py

@@ -65,7 +65,7 @@
     'SoupClientSessionSync',
     'tail_soup_app',
     'connect_async',
-    'connect'
+    'connect',
 ]
 
 

src/nasdaq_protocols/soup_app/session.py src/nasdaq_protocols/soup/soup_app.pysrc/nasdaq_protocols/soup_app/session.py renamed to src/nasdaq_protocols/soup/soup_app.py

@@ -2,13 +2,64 @@
 from typing import Callable, Type, Awaitable, Generic, TypeVar
 
 import attrs
-from nasdaq_protocols.common import DispatchableMessageQueue, logable
+
+from nasdaq_protocols.common import (
+    Serializable,
+    Byte,
+    CommonMessage,
+    logable,
+    DispatchableMessageQueue,
+)
 from nasdaq_protocols import soup
 
+
 M = TypeVar('M')
 
 
-class SessionId:
+__all__ = [
+    'SoupAppMessageId',
+    'SoupAppMessage',
+    'SoupAppSessionId',
+    'SoupAppClientSession',
+]
+
+
+@attrs.define(auto_attribs=True, hash=True)
+class SoupAppMessageId(Serializable):
+    indicator: int
+    direction: str = 'outgoing'
+
+    @classmethod
+    def from_bytes(cls, bytes_: bytes) -> tuple[int, 'SoupAppMessageId']:
+        return 1, cls(Byte.from_bytes(bytes_)[1])
+
+    def to_bytes(self) -> tuple[int, bytes]:
+        return Byte.to_bytes(self.indicator)
+
+    def __str__(self):
+        return f'indicator={self.indicator}, direction={self.direction}'
+
+
+@attrs.define
+@logable
+class SoupAppMessage(CommonMessage):
+    IncomingMsgClasses = []
+    OutgoingMsgsClasses = []
+
+    def __init_subclass__(cls, *args, **kwargs):
+        cls.log.debug('%s subclassing %s, params = %s', cls.__mro__[1].__name__, cls.__name__, str(kwargs))
+
+        app_name = kwargs.get('app_name')
+        kwargs['app_name'] = app_name
+        kwargs['msg_id_cls'] = SoupAppMessageId
+
+        if 'indicator' in kwargs and 'direction' in kwargs:
+            kwargs['msg_id'] = SoupAppMessageId(kwargs['indicator'], kwargs['direction'])
+
+        super().__init_subclass__(**kwargs)
+
+
+class SoupAppSessionId:
     """Base class for protocol-specific session IDs."""
     soup_session_id: soup.SoupSessionId = None
     protocol_name: str = "generic"
@@ -21,13 +72,13 @@ def __str__(self):
 
 @attrs.define(auto_attribs=True)
 @logable
-class BaseClientSession(Generic[M]):
+class SoupAppClientSession(Generic[M]):
     """Base client session class with common functionality for all protocol implementations."""
     soup_session: soup.SoupClientSession
     on_msg_coro: Callable[[Type[M]], Awaitable[None]] = None
     on_close_coro: Callable[[], Awaitable[None]] = None
     closed: bool = False
-    _session_id: SessionId = None
+    _session_id: SoupAppSessionId = None
     _close_event: asyncio.Event = None
     _message_queue: DispatchableMessageQueue = None
 

src/nasdaq_protocols/soup_app/__init__.py

@@ -1,5 +1,5 @@
 import attrs
-from nasdaq_protocols.soup_app import SoupAppMessage
+from nasdaq_protocols.soup import soup_app
 from nasdaq_protocols.common import logable
 
 
@@ -11,7 +11,7 @@
 
 @attrs.define
 @logable
-class Message(SoupAppMessage, app_name=APP_NAME):
+class Message(soup_app.SoupAppMessage, app_name=APP_NAME):
 
     def __init_subclass__(cls, *args, **kwargs):
         super().__init_subclass__(**kwargs)

src/nasdaq_protocols/soup_app/core.py

@@ -2,7 +2,7 @@
 
 import attrs
 from nasdaq_protocols import soup
-from nasdaq_protocols.soup_app.session import BaseClientSession, SessionId
+from nasdaq_protocols.soup import soup_app
 from .core import Message
 
 __all__ = [
@@ -17,13 +17,13 @@
 
 
 @attrs.define(auto_attribs=True)
-class SqfSessionId(SessionId):
+class SqfSessionId(soup_app.SoupAppSessionId):
     soup_session_id: soup.SoupSessionId = None
     protocol_name: str = "sqf"
 
 
 @attrs.define(auto_attribs=True)
-class ClientSession(BaseClientSession):
+class ClientSession(soup_app.SoupAppClientSession):
 
     def _create_session_id(self):
         return SqfSessionId(self.soup_session.session_id)