Set frozen, kw_only, slots to dataclasses when possible (#39)

Author: vrslev

stompman/client.py

@@ -54,7 +54,7 @@ class MultiHostHostLike(TypedDict):
     port: int | None
 
 
-@dataclass
+@dataclass(frozen=True, slots=True)
 class ConnectionParameters:
     host: str
     port: int
@@ -106,9 +106,9 @@ def from_pydantic_multihost_hosts(cls, hosts: list[MultiHostHostLike]) -> list[S
         return servers
 
 
-@dataclass
+@dataclass(kw_only=True, slots=True)
 class Client:
-    servers: list[ConnectionParameters]
+    servers: list[ConnectionParameters] = field(kw_only=False)
     heartbeat: Heartbeat = field(default=Heartbeat(1000, 1000))
     connect_retry_attempts: int = 3
     connect_retry_interval: int = 1
@@ -300,7 +300,7 @@ async def listen(self) -> AsyncIterator["AnyListeningEvent"]:
                     raise AssertionError(msg, frame)
 
 
-@dataclass
+@dataclass(kw_only=True, slots=True)
 class MessageEvent:
     body: bytes = field(init=False)
     _frame: MessageFrame
@@ -352,7 +352,7 @@ async def with_auto_ack(
                 await self.ack()
 
 
-@dataclass
+@dataclass(kw_only=True, slots=True)
 class ErrorEvent:
     message_header: str = field(init=False)
     """Short description of the error."""
@@ -366,7 +366,7 @@ def __post_init__(self) -> None:
         self.body = self._frame.body
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class HeartbeatEvent:
     _frame: HeartbeatFrame
     _client: Client = field(repr=False)

stompman/connection.py

@@ -12,7 +12,7 @@
 FrameType = TypeVar("FrameType", bound=AnyClientFrame | AnyServerFrame)
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AbstractConnection(Protocol):
     active: bool = True
 
@@ -24,7 +24,7 @@ async def write_frame(self, frame: AnyClientFrame) -> None: ...
     def read_frames(self, max_chunk_size: int, timeout: int) -> AsyncGenerator[AnyServerFrame, None]: ...
 
 
-@dataclass(kw_only=True)
+@dataclass(kw_only=True, slots=True)
 class Connection(AbstractConnection):
     reader: asyncio.StreamReader
     writer: asyncio.StreamWriter

stompman/errors.py

@@ -7,31 +7,31 @@
     from stompman.client import ConnectionParameters
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class Error(Exception):
     def __str__(self) -> str:
         return self.__repr__()
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ConnectionConfirmationTimeoutError(Error):
     timeout: int
     frames: list[MessageFrame | ReceiptFrame | ErrorFrame]
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class UnsupportedProtocolVersionError(Error):
     given_version: str
     supported_version: str
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class FailedAllConnectAttemptsError(Error):
     servers: list["ConnectionParameters"]
     retry_attempts: int
     retry_interval: int
     timeout: int
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ConnectionLostError(Error): ...

stompman/frames.py

@@ -120,85 +120,85 @@
 )
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ConnectFrame:
     headers: ConnectHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class StompFrame:
     headers: ConnectHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ConnectedFrame:
     headers: ConnectedHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class SendFrame:
     headers: SendHeaders
     body: bytes = b""
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class SubscribeFrame:
     headers: SubscribeHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class UnsubscribeFrame:
     headers: UnsubscribeHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class AckFrame:
     headers: AckHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class NackFrame:
     headers: NackHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class BeginFrame:
     headers: BeginHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class CommitFrame:
     headers: CommitHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class AbortFrame:
     headers: AbortHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class DisconnectFrame:
     headers: DisconnectHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ReceiptFrame:
     headers: ReceiptHeaders
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class MessageFrame:
     headers: MessageHeaders
     body: bytes
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class ErrorFrame:
     headers: ErrorHeaders
     body: bytes = b""
 
 
-@dataclass
+@dataclass(frozen=True, kw_only=True, slots=True)
 class HeartbeatFrame: ...
 
 

stompman/serde.py

@@ -156,7 +156,7 @@ def parse_lines_into_frame(lines: deque[bytearray]) -> AnyClientFrame | AnyServe
     return make_frame_from_parts(command=command, headers=headers, body=body)
 
 
-@dataclass
+@dataclass(kw_only=True, slots=True)
 class FrameParser:
     _lines: deque[bytearray] = field(default_factory=deque, init=False)
     _current_line: bytearray = field(default_factory=bytearray, init=False)

tests/test_client.py

@@ -41,7 +41,6 @@
 pytestmark = pytest.mark.anyio
 
 
-@dataclass
 class BaseMockConnection(AbstractConnection):
     @classmethod
     async def connect(cls, host: str, port: int, timeout: int) -> Self | None:
@@ -61,7 +60,6 @@ async def read_frames(
 def create_spying_connection(
     read_frames_yields: list[list[AnyServerFrame]],
 ) -> tuple[type[AbstractConnection], list[AnyClientFrame | AnyServerFrame | HeartbeatFrame]]:
-    @dataclass
     class BaseCollectingConnection(BaseMockConnection):
         @staticmethod
         async def write_frame(frame: AnyClientFrame) -> None:
@@ -93,10 +91,10 @@ def assert_frames_between_lifespan_match(
     assert collected_frames[2:-2] == expected_frames
 
 
-@dataclass
+@dataclass(kw_only=True, slots=True)
 class EnrichedClient(Client):
     servers: list[ConnectionParameters] = field(
-        default_factory=lambda: [ConnectionParameters("localhost", 12345, "login", "passcode")]
+        default_factory=lambda: [ConnectionParameters("localhost", 12345, "login", "passcode")], kw_only=False
     )