Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-09-23 14:14:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix Pylance reportInvalidTypeForm error for NewType usage

Browse source 
Add type: ignore comment to suppress Pylance reportInvalidTypeForm error
when using NewType with Callable. The code is semantically correct but
Pylance/Pyright has known issues recognizing NewType variables as valid
type expressions in certain contexts.

This preserves the intended type safety of MessageCallbackType while
resolving the static analysis warning.
This commit is contained in:
Aareon Sullivan 2025-06-10 14:03:27 -05:00
parent 7918cd0161
commit 864266ef80
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
RNS/Channel.py
View file

@ -34,7 +34,7 @@ import enum
import threading import threading
import time import time
from types import TracebackType from types import TracebackType
from typing import Type, Callable, TypeVar, Generic, NewType from typing import Type, Callable, TypeVar, Generic, NewType, List
import abc import abc
import contextlib import contextlib
import struct import struct
@ -167,7 +167,8 @@ class MessageBase(abc.ABC):
""" """
raise NotImplemented() raise NotImplemented()
# Pylance does not like this, but it is correct.
# We use `# type: ignore` to suppress future `reportInvalidTypeForm` errors.
MessageCallbackType = NewType("MessageCallbackType", Callable[[MessageBase], bool]) MessageCallbackType = NewType("MessageCallbackType", Callable[[MessageBase], bool])
@ -287,7 +288,7 @@ class Channel(contextlib.AbstractContextManager):
self._lock = threading.RLock() self._lock = threading.RLock()
self._tx_ring: collections.deque[Envelope] = collections.deque() self._tx_ring: collections.deque[Envelope] = collections.deque()
self._rx_ring: collections.deque[Envelope] = collections.deque() self._rx_ring: collections.deque[Envelope] = collections.deque()
self._message_callbacks: [MessageCallbackType] = [] self._message_callbacks: List[MessageCallbackType] = [] # type: ignore
self._next_sequence = 0 self._next_sequence = 0
self._next_rx_sequence = 0 self._next_rx_sequence = 0
self._message_factories: dict[int, Type[MessageBase]] = {} self._message_factories: dict[int, Type[MessageBase]] = {}
@ -343,7 +344,7 @@ class Channel(contextlib.AbstractContextManager):
self._message_factories[message_class.MSGTYPE] = message_class self._message_factories[message_class.MSGTYPE] = message_class
def add_message_handler(self, callback: MessageCallbackType): def add_message_handler(self, callback: MessageCallbackType): # type: ignore
""" """
Add a handler for incoming messages. A handler Add a handler for incoming messages. A handler
has the following signature: has the following signature:
@ -361,7 +362,7 @@ class Channel(contextlib.AbstractContextManager):
if callback not in self._message_callbacks: if callback not in self._message_callbacks:
self._message_callbacks.append(callback) self._message_callbacks.append(callback)
def remove_message_handler(self, callback: MessageCallbackType): def remove_message_handler(self, callback: MessageCallbackType): # type: ignore
""" """
Remove a handler added with ``add_message_handler``. Remove a handler added with ``add_message_handler``.