Lint

Author: droserasprout

Makefile

@@ -10,8 +10,8 @@ SRC = src tests example.py example_with_token.py
 help:           ## Show this help (default)
 	@grep -F -h "##" $(MAKEFILE_LIST) | grep -F -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
 
-all:            ## Run a whole CI pipeline: formatters, linters, tests and docs
-	make lint test docs
+all:            ## Run a whole CI pipeline: formatters, linters, tests
+	make lint test
 
 lint:           ## Lint with all tools
 	make black ruff mypy

example_with_token.py

@@ -26,14 +26,14 @@ async def on_error(message: CompletionMessage) -> None:
 
 def token_factory() -> str:
     # Replace with logic to fetch or generate the token
-    return "your_access_token_here"
+    return 'your_access_token_here'
 
 
 async def main() -> None:
     client = SignalRClient(
         url='https://api.tzkt.io/v1/ws',
         access_token_factory=token_factory,
-        headers={"mycustomheader": "mycustomheadervalue"},
+        headers={'mycustomheader': 'mycustomheadervalue'},
     )
 
     client.on_open(on_open)

src/pysignalr/__init__.py

@@ -16,6 +16,7 @@ class NegotiationTimeout(Exception):
     """
     Exception raised when the connection URL generated during negotiation is no longer valid.
     """
+
     pass
 
 

src/pysignalr/client.py

@@ -3,31 +3,30 @@
 import uuid
 from collections import defaultdict
 from contextlib import asynccontextmanager
-from typing import Any, AsyncIterator, Awaitable, Callable
+from typing import Any
+from typing import AsyncIterator
+from typing import Awaitable
+from typing import Callable
 
 from pysignalr.exceptions import ServerError
-from pysignalr.messages import (
-    CancelInvocationMessage,
-    CloseMessage,
-    CompletionClientStreamMessage,
-    CompletionMessage,
-    InvocationClientStreamMessage,
-    InvocationMessage,
-    Message,
-    MessageType,
-    PingMessage,
-    StreamInvocationMessage,
-    StreamItemMessage,
-)
+from pysignalr.messages import CancelInvocationMessage
+from pysignalr.messages import CloseMessage
+from pysignalr.messages import CompletionClientStreamMessage
+from pysignalr.messages import CompletionMessage
+from pysignalr.messages import InvocationClientStreamMessage
+from pysignalr.messages import InvocationMessage
+from pysignalr.messages import Message
+from pysignalr.messages import MessageType
+from pysignalr.messages import PingMessage
+from pysignalr.messages import StreamInvocationMessage
+from pysignalr.messages import StreamItemMessage
 from pysignalr.protocol.abstract import Protocol
 from pysignalr.protocol.json import JSONProtocol
 from pysignalr.transport.abstract import Transport
-from pysignalr.transport.websocket import (
-    DEFAULT_CONNECTION_TIMEOUT,
-    DEFAULT_MAX_SIZE,
-    DEFAULT_PING_INTERVAL,
-    WebsocketTransport,
-)
+from pysignalr.transport.websocket import DEFAULT_CONNECTION_TIMEOUT
+from pysignalr.transport.websocket import DEFAULT_MAX_SIZE
+from pysignalr.transport.websocket import DEFAULT_PING_INTERVAL
+from pysignalr.transport.websocket import WebsocketTransport
 
 EmptyCallback = Callable[[], Awaitable[None]]
 AnyCallback = Callable[[Any], Awaitable[None]]
@@ -232,7 +231,7 @@ async def _on_message(self, message: Message) -> None:
         Args:
             message (Message): The incoming message.
         """
-        if message.type == MessageType.invocation_binding_failure:
+        if message.type == MessageType.invocation_binding_failure:  # type: ignore[attr-defined]
             raise ServerError(str(message))
 
         elif isinstance(message, PingMessage):
@@ -306,7 +305,7 @@ async def _on_cancel_invocation_message(self, message: CancelInvocationMessage)
         """
         _, _, callback = self._stream_handlers[message.invocation_id]
         if callback:
-            await callback(message)
+            await callback(message)  # type: ignore[arg-type]
 
     async def _on_close_message(self, message: CloseMessage) -> None:
         """

src/pysignalr/exceptions.py

@@ -8,6 +8,7 @@ class HubError(Exception):
     """
     Base class for all Hub-related errors.
     """
+
     pass
 
 
@@ -16,6 +17,7 @@ class AuthorizationError(HubError):
     """
     Exception raised for authorization errors.
     """
+
     pass
 
 
@@ -27,6 +29,7 @@ class ConnectionError(HubError):
     Attributes:
         status (int): The HTTP status code related to the connection error.
     """
+
     status: int
 
 
@@ -38,4 +41,5 @@ class ServerError(HubError):
     Attributes:
         message (str | None): The error message from the server.
     """
+
     message: str | None

src/pysignalr/messages.py

@@ -10,6 +10,7 @@ class HandshakeMessage:
     """
     Base class for handshake messages.
     """
+
     def dump(self) -> dict[str, Any]:
         """
         Dumps the handshake message into a dictionary.
@@ -29,6 +30,7 @@ class HandshakeRequestMessage(HandshakeMessage):
         protocol (str): The protocol name.
         version (int): The protocol version.
     """
+
     protocol: str
     version: int
 
@@ -41,6 +43,7 @@ class HandshakeResponseMessage(HandshakeMessage):
     Attributes:
         error (str | None): The error message if the handshake failed.
     """
+
     error: str | None
 
 
@@ -58,6 +61,7 @@ class MessageType(IntEnum):
         close (int): Close message type.
         invocation_binding_failure (int): Invocation binding failure message type.
     """
+
     _ = 9999
     invocation = 1
     stream_item = 2
@@ -77,6 +81,7 @@ class Message:
     Methods:
         dump() -> dict[str, Any]: Dumps the message into a dictionary.
     """
+
     def __init_subclass__(cls, type_: MessageType) -> None:
         cls.type = type_  # type: ignore[attr-defined]
 
@@ -110,6 +115,7 @@ class ResponseMessage(Message, type_=MessageType._):
         error (str | None): The error message.
         result (Any | None): The result of the message.
     """
+
     error: str | None
     result: Any | None
 
@@ -123,6 +129,7 @@ class CancelInvocationMessage(Message, type_=MessageType.cancel_invocation):
         invocation_id (str): The ID of the invocation to cancel.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     headers: dict[str, Any] | None = None
 
@@ -137,6 +144,7 @@ class CloseMessage(Message, type_=MessageType.close):
         allow_reconnect (bool | None): Whether reconnection is allowed.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     error: str | None = None
     allow_reconnect: bool | None = None
     headers: dict[str, Any] | None = None
@@ -151,6 +159,7 @@ class CompletionClientStreamMessage(Message, type_=MessageType.stream_item):
         invocation_id (str): The ID of the invocation.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     headers: dict[str, Any] | None = None
 
@@ -166,6 +175,7 @@ class CompletionMessage(Message, type_=MessageType.completion):
         error (str | None): The error message if the invocation failed.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     result: Any | None = None
     error: str | None = None
@@ -183,6 +193,7 @@ class InvocationMessage(Message, type_=MessageType.invocation):
         arguments: The arguments for the method invocation.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     target: str
     arguments: Any
@@ -200,6 +211,7 @@ class InvocationClientStreamMessage(Message, type_=MessageType.invocation):
         arguments: The arguments for the method invocation.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     stream_ids: list[str]
     target: str
     arguments: Any
@@ -211,6 +223,7 @@ class PingMessage(Message, type_=MessageType.ping):
     """
     Ping message.
     """
+
     pass
 
 
@@ -225,6 +238,7 @@ class StreamInvocationMessage(Message, type_=MessageType.stream_invocation):
         arguments: The arguments for the method invocation.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     target: str
     arguments: Any
@@ -241,6 +255,7 @@ class StreamItemMessage(Message, type_=MessageType.stream_item):
         item: The stream item.
         headers (dict[str, Any] | None): Optional headers.
     """
+
     invocation_id: str
     item: Any
     headers: dict[str, Any] | None = None
@@ -253,6 +268,7 @@ class JSONMessage(Message, type_=MessageType._):
     Attributes:
         data (dict[str, Any]): The JSON data.
     """
+
     def __init__(self, data: dict[str, Any]) -> None:
         self.data = data
 

src/pysignalr/protocol/abstract.py

@@ -4,11 +4,10 @@
 from abc import abstractmethod
 from typing import Iterable
 
-from pysignalr.messages import (
-    HandshakeRequestMessage,
-    HandshakeResponseMessage,
-    Message
-)
+from pysignalr.messages import HandshakeRequestMessage
+from pysignalr.messages import HandshakeResponseMessage
+from pysignalr.messages import Message
+
 
 class Protocol(ABC):
     """

src/pysignalr/protocol/json.py

@@ -6,29 +6,27 @@
 
 import orjson
 
-from pysignalr.messages import (
-    CancelInvocationMessage,  # 5
-    CloseMessage,  # 7
-    CompletionMessage,  # 3
-    HandshakeMessage,
-    HandshakeRequestMessage,
-    HandshakeResponseMessage,
-    InvocationMessage,  # 1
-    JSONMessage,  # virtual
-    Message,
-    MessageType,
-    PingMessage,  # 6
-    StreamInvocationMessage,  # 4
-    StreamItemMessage  # 2
-)
+from pysignalr.messages import CancelInvocationMessage  # 5
+from pysignalr.messages import CloseMessage  # 7
+from pysignalr.messages import CompletionMessage  # 3
+from pysignalr.messages import HandshakeMessage
+from pysignalr.messages import HandshakeRequestMessage
+from pysignalr.messages import HandshakeResponseMessage
+from pysignalr.messages import InvocationMessage  # 1
+from pysignalr.messages import JSONMessage  # virtual
+from pysignalr.messages import Message
+from pysignalr.messages import MessageType
+from pysignalr.messages import PingMessage  # 6
+from pysignalr.messages import StreamInvocationMessage  # 4
+from pysignalr.messages import StreamItemMessage  # 2
 from pysignalr.protocol.abstract import Protocol
 
 
 class MessageEncoder(JSONEncoder):
     """
     Custom JSONEncoder for encoding Message and MessageType objects.
 
-    This class is a subclass of JSONEncoder and overrides the default() method 
+    This class is a subclass of JSONEncoder and overrides the default() method
     to provide custom serialization for Message and MessageType objects.
     """
 
@@ -54,7 +52,7 @@ class BaseJSONProtocol(Protocol):
     """
     Base class for JSON protocols.
 
-    This class provides the basic structure for JSON protocols and defines 
+    This class provides the basic structure for JSON protocols and defines
     some abstract methods that must be implemented by subclasses.
     """
 

src/pysignalr/protocol/messagepack.py

@@ -2,30 +2,26 @@
 
 # TODO: Refactor this module
 from collections import deque
-from typing import (
-    Any,
-    Iterable,
-    Sequence,
-    cast
-)
+from typing import Any
+from typing import Iterable
+from typing import Sequence
+from typing import cast
 
 import msgpack  # type: ignore[import-untyped]
 import orjson
 
-from pysignalr.messages import ( 
-    CancelInvocationMessage,
-    CloseMessage,
-    CompletionMessage,
-    HandshakeRequestMessage,
-    HandshakeResponseMessage,
-    InvocationClientStreamMessage,
-    InvocationMessage,
-    Message,
-    MessageType,
-    PingMessage,
-    StreamInvocationMessage,
-    StreamItemMessage
-)
+from pysignalr.messages import CancelInvocationMessage
+from pysignalr.messages import CloseMessage
+from pysignalr.messages import CompletionMessage
+from pysignalr.messages import HandshakeRequestMessage
+from pysignalr.messages import HandshakeResponseMessage
+from pysignalr.messages import InvocationClientStreamMessage
+from pysignalr.messages import InvocationMessage
+from pysignalr.messages import Message
+from pysignalr.messages import MessageType
+from pysignalr.messages import PingMessage
+from pysignalr.messages import StreamInvocationMessage
+from pysignalr.messages import StreamItemMessage
 from pysignalr.protocol.abstract import Protocol
 
 _attribute_priority = (

src/pysignalr/transport/abstract.py

@@ -17,6 +17,7 @@ class ConnectionState(IntEnum):
         reconnecting: The connection is being reestablished after being lost.
         disconnected: The connection has been lost or intentionally closed.
     """
+
     connecting = auto()
     connected = auto()
     reconnecting = auto()