Add pyright and cleanup the codebase

pymine_net/net/asyncio/client.py

@@ -15,7 +15,11 @@ class AsyncProtocolClient(AbstractProtocolClient):
     def __init__(self, host: str, port: int, protocol: Union[int, str], packet_map: PacketMap):
         super().__init__(host, port, protocol, packet_map)
 
-        self.stream: AsyncTCPStream = None
+        # We type-ignore this assignment since we don't expect it to stay as None
+        # it should be set in connect function which is expected to be ran after init
+        # this avoids further type-ignores or casts whenever it'd be used, to tell
+        # type checker that it won't actually be None.
+        self.stream: AsyncTCPStream = None  # type: ignore
 
     async def connect(self) -> None:
         _, writer = await asyncio.open_connection(self.host, self.port)

pymine_net/net/asyncio/server.py

@@ -30,7 +30,11 @@ def __init__(self, host: str, port: int, protocol: Union[int, str], packet_map:
 
         self.connected_clients: Dict[Tuple[str, int], AsyncProtocolServerClient] = {}
 
-        self.server: asyncio.AbstractServer = None
+        # We type-ignore this assignment since we don't expect it to stay as None
+        # it should be set in run function which is expected to be ran after init
+        # this avoids further type-ignores or casts whenever it'd be used, to tell
+        # type checker that it won't actually be None.
+        self.server: asyncio.AbstractServer = None  # type: ignore
 
     async def run(self) -> None:
         self.server = await asyncio.start_server(self._client_connected_cb, self.host, self.port)

pymine_net/net/server.py

@@ -46,7 +46,7 @@ def _decode_packet(self, buf: Buffer) -> ServerBoundPacket:
 
         # attempt to get packet class from given state and packet id
         try:
-            packet_class: Type[ClientBoundPacket] = self.packet_map[
+            packet_class: Type[ServerBoundPacket] = self.packet_map[
                 PacketDirection.SERVERBOUND, self.state, packet_id
             ]
         except KeyError:

pymine_net/packets/v_1_18_1/login/login.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from uuid import UUID
 
 from pymine_net.types.buffer import Buffer
@@ -190,7 +191,7 @@ class LoginPluginResponse(ServerBoundPacket):
 
     id = 0x02
 
-    def __init__(self, message_id: int, data: bytes = None):
+    def __init__(self, message_id: int, data: Optional[bytes] = None):
         self.message_id = message_id
         self.data = data
 

pymine_net/packets/v_1_18_1/play/advancement.py

@@ -41,7 +41,7 @@ class PlaySelectAdvancementTab(ClientBoundPacket):
 
     id = 0x40
 
-    def __init__(self, identifier: str = None):
+    def __init__(self, identifier: Optional[str] = None):
         super().__init__()
 
         self.identifier = identifier

pymine_net/packets/v_1_18_1/play/boss.py

@@ -32,7 +32,7 @@ def __init__(self, uuid: UUID, action: int, **data: dict):
         self.data = data
 
     def pack(self) -> Buffer:
-        buf = Buffer.write_uuid(self.uuid).write_varint(self.action)
+        buf = Buffer().write_uuid(self.uuid).write_varint(self.action)
 
         if self.action == 0:
             buf.write_chat(self.data["title"]).write("f", self.data["health"]).write_varint(

pymine_net/packets/v_1_18_1/play/crafting.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from pymine_net.types.buffer import Buffer
 from pymine_net.types.packet import ClientBoundPacket, ServerBoundPacket
@@ -177,7 +177,7 @@ def __init__(
         smoker_book_open: bool,
         smoker_book_filter_active: bool,
         recipe_ids_1: List[str],
-        recipe_ids_2: List[list] = None,
+        recipe_ids_2: Optional[List[list]] = None,
     ):
         super().__init__()
 

pymine_net/packets/v_1_18_1/play/map.py

@@ -47,10 +47,10 @@ def __init__(
         tracking_pos: bool,
         icons: List[Tuple[int, int, int, int, bool, Optional[Chat]]],
         columns: int,
-        rows: int = None,
-        x: int = None,
-        z: int = None,
-        data: bytes = None,
+        rows: Optional[int] = None,
+        x: Optional[int] = None,
+        z: Optional[int] = None,
+        data: Optional[bytes] = None,
     ):
         super().__init__()
 
@@ -86,7 +86,7 @@ def pack(self) -> Buffer:
 
         buf.write("B", self.columns)
 
-        if len(self.columns) < 1:
+        if self.columns < 1:
             return buf
 
         return (

pymine_net/packets/v_1_18_1/play/particle.py

@@ -73,5 +73,5 @@ def pack(self) -> Buffer:
             .write("f", self.offset_z)
             .write("f", self.particle_data)
             .write("i", self.particle_count)
-            .write_particle(self.data)
+            .write_particle(**self.data)
         )

pymine_net/packets/v_1_18_1/play/player.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import List, Optional, cast
 from uuid import UUID
 
 import pymine_net.types.nbt as nbt
@@ -314,7 +314,12 @@ def __init__(self, x: float, feet_y: float, z: float, on_ground: bool):
 
     @classmethod
     def unpack(cls, buf: Buffer) -> PlayPlayerPositionServerBound:
-        return cls(buf.read("d"), buf.read("d"), buf.read("d"), buf.read("?"))
+        return cls(
+            cast(int, buf.read("d")),
+            cast(int, buf.read("d")),
+            cast(int, buf.read("d")),
+            cast(bool, buf.read("?"))
+        )
 
 
 class PlayPlayerPositionAndRotationServerBound(ServerBoundPacket):
@@ -352,12 +357,12 @@ def __init__(
     @classmethod
     def unpack(cls, buf: Buffer) -> PlayPlayerPositionAndRotationServerBound:
         return cls(
-            buf.read("d"),
-            buf.read("d"),
-            buf.read("d"),
-            buf.read("f"),
-            buf.read("f"),
-            buf.read("?"),
+            cast(int, buf.read("d")),
+            cast(int, buf.read("d")),
+            cast(int, buf.read("d")),
+            cast(float, buf.read("f")),
+            cast(float, buf.read("f")),
+            cast(bool, buf.read("?")),
         )
 
 
@@ -416,7 +421,11 @@ def __init__(self, yaw: float, pitch: float, on_ground: bool):
 
     @classmethod
     def unpack(cls, buf: Buffer) -> PlayPlayerRotation:
-        return cls(buf.read("f"), buf.read("f"), buf.read("?"))
+        return cls(
+            cast(float, buf.read("f")),
+            cast(float, buf.read("f")),
+            cast(bool, buf.read("?"))
+        )
 
 
 class PlayPlayerMovement(ServerBoundPacket):
@@ -436,7 +445,7 @@ def __init__(self, on_ground: bool):
 
     @classmethod
     def unpack(cls, buf: Buffer) -> PlayPlayerMovement:
-        return cls(buf.read("?"))
+        return cls(cast(bool, buf.read("?")))
 
 
 class PlayTeleportConfirm(ServerBoundPacket):
@@ -530,11 +539,11 @@ def unpack(cls, buf: Buffer) -> PlayClientSettings:
             buf.read_string(),
             buf.read_byte(),
             buf.read_varint(),
-            buf.read("?"),
-            buf.read("B"),
+            cast(bool, buf.read("?")),
+            cast(int, buf.read("B")),
             buf.read_varint(),
-            buf.read("?"),
-            buf.read("?"),
+            cast(bool, buf.read("?")),
+            cast(bool, buf.read("?")),
         )
 
 
@@ -558,7 +567,10 @@ def __init__(self, slot_id: int, slot: dict):
 
     @classmethod
     def unpack(cls, buf: Buffer) -> PlayCreativeInventoryAction:
-        return cls(buf.read("h"), buf.read_slot())
+        return cls(
+            cast(int, buf.read("h")),
+            buf.read_slot(),  # TODO: This is missing a Registry parameter?
+        )
 
 
 class PlaySpectate(ServerBoundPacket):
@@ -775,6 +787,8 @@ def pack(self) -> Buffer:
             for player in self.players:
                 buf.write_uuid(player.uuid)
 
+        return buf
+
 
 class PlayFacePlayer(ClientBoundPacket):
     """Used by the server to rotate the client player to face the given location or entity. (Server -> Client)
@@ -804,8 +818,8 @@ def __init__(
         target_y: float,
         target_z: float,
         is_entity: bool,
-        entity_id: int = None,
-        entity_feet_or_eyes: int = None,
+        entity_id: Optional[int] = None,
+        entity_feet_or_eyes: Optional[int] = None,
     ):
         super().__init__()
 

pymine_net/types/block_palette.py

@@ -1,4 +1,5 @@
 from abc import abstractmethod
+from typing import Optional
 
 from strict_abc import StrictABC
 
@@ -17,7 +18,7 @@ def get_bits_per_block(self) -> int:
         pass
 
     @abstractmethod
-    def encode(self, block: str, props: dict = None) -> int:
+    def encode(self, block: str, props: Optional[dict] = None) -> int:
         pass
 
     @abstractmethod