More ruff rules

.pre-commit-config.yaml

@@ -11,12 +11,6 @@ repos:
       - id: mixed-line-ending
         args: [--fix=lf]
 
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.9.0
-    hooks:
-      - id: python-check-blanket-noqa # Enforce noqa annotations (noqa: F401,W203)
-      - id: python-use-type-annotations # Enforce type annotations instead of type comments
-
   - repo: local
     hooks:
       - id: black

changes/154.internal.md

@@ -0,0 +1,11 @@
+Enforce various new ruff linter rules:
+
+- **PGH:** pygrep-hooks (replaces pre-commit version)
+- **PL:** pylint (bunch of typing related linter rules)
+- **UP:** pyupgrade (forces use of the newest possible standards, depending on target version)
+- **RET:** flake8-return (various linter rules related to function returns)
+- **Q:** flake8-quotes (always use double quotes)
+- **ASYNC:** flake8-async (report blocking operations in async functions)
+- **INT:** flake-gettext (gettext related linting rules)
+- **PTH:** flake8-use-pathlib (always prefer pathlib alternatives to the os ones)
+- **RUF:** ruff custom rules (various additional rules created by the ruff linter team)

docs/conf.py

@@ -23,7 +23,7 @@
 
 # -- Basic project information -----------------------------------------------
 
-with open("../pyproject.toml", "rb") as f:
+with Path("../pyproject.toml").open("rb") as f:
     pkg_meta: dict[str, str] = toml_parse(f)["tool"]["poetry"]
 
 project = str(pkg_meta["name"])

docs/extensions/attributetable.py

@@ -93,7 +93,7 @@ class PyAttributeTable(SphinxDirective):
     required_arguments = 1
     optional_arguments = 0
     final_argument_whitespace = False
-    option_spec: OptionSpec = {}
+    option_spec: OptionSpec = {}  # noqa: RUF012 # (from original impl)
 
     def parse_name(self, content: str) -> tuple[str, str]:
         match = _name_parser_regex.match(content)

mcproto/connection.py

@@ -4,7 +4,7 @@
 import errno
 import socket
 from abc import ABC, abstractmethod
-from typing import Generic, Optional, TypeVar
+from typing import Generic, TypeVar
 
 import asyncio_dgram
 from typing_extensions import ParamSpec, Self
@@ -262,7 +262,7 @@ def make_client(cls, address: tuple[str, int], timeout: float) -> Self:
         sock.settimeout(timeout)
         return cls(sock, address)
 
-    def read(self, length: Optional[int] = None) -> bytearray:
+    def read(self, length: int | None = None) -> bytearray:
         """Receive data sent through the connection.
 
         :param length:
@@ -311,7 +311,7 @@ async def make_client(cls, address: tuple[str, int], timeout: float) -> Self:
         stream = await asyncio.wait_for(conn, timeout=timeout)
         return cls(stream, timeout)
 
-    async def read(self, length: Optional[int] = None) -> bytearray:
+    async def read(self, length: int | None = None) -> bytearray:
         """Receive data sent through the connection.
 
         :param length:

mcproto/packets/handshaking/handshake.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from enum import IntEnum
-from typing import ClassVar, Union, final
+from typing import ClassVar, final
 
 from typing_extensions import Self
 
@@ -35,7 +35,7 @@ def __init__(
         protocol_version: int,
         server_address: str,
         server_port: int,
-        next_state: Union[NextState, int],
+        next_state: NextState | int,
     ):
         """
         :param protocol_version: Protocol version number to be used.

mcproto/packets/interactions.py

@@ -43,8 +43,7 @@ def _serialize_packet(packet: Packet, *, compressed: bool = False) -> Buffer:
         data_buf.write_varint(data_length)
         data_buf.write(packet_buf)
         return data_buf
-    else:
-        return packet_buf
+    return packet_buf
 
 
 def _deserialize_packet(

mcproto/packets/login/login.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import ClassVar, Optional, final
+from typing import ClassVar, final
 
 from typing_extensions import Self
 
@@ -215,7 +215,7 @@ class LoginPluginResponse(ServerBoundPacket):
     PACKET_ID: ClassVar[int] = 0x02
     GAME_STATE: ClassVar[GameState] = GameState.LOGIN
 
-    def __init__(self, message_id: int, data: Optional[bytes]):
+    def __init__(self, message_id: int, data: bytes | None):
         """
         :param message_id: Message id, generated by the server, should be unique to the connection.
         :param data: Optional response data, present if client understood request.

mcproto/packets/packet_map.py

@@ -94,7 +94,7 @@ def generate_packet_map(
     ...
 
 
-@lru_cache()
+@lru_cache
 def generate_packet_map(direction: PacketDirection, state: GameState) -> Mapping[int, type[Packet]]:
     """Dynamically generated a packet map for given ``direction`` and ``state``.
 

mcproto/protocol/base_io.py

@@ -5,7 +5,7 @@
 from collections.abc import Awaitable, Callable
 from enum import Enum
 from itertools import count
-from typing import Literal, Optional, TypeVar, Union, overload
+from typing import Literal, TypeVar, Union, overload
 
 from typing_extensions import TypeAlias
 
@@ -105,7 +105,7 @@ async def write_value(self, fmt: StructFormat, value: object, /) -> None:
         """Write a given ``value`` as given struct format (``fmt``) in big-endian mode."""
         await self.write(struct.pack(">" + fmt.value, value))
 
-    async def _write_varuint(self, value: int, /, *, max_bits: Optional[int] = None) -> None:
+    async def _write_varuint(self, value: int, /, *, max_bits: int | None = None) -> None:
         """Write an arbitrarily big unsigned integer in a variable length format.
 
         This is a standard way of transmitting ints, and it allows smaller numbers to take less bytes.
@@ -179,7 +179,7 @@ async def write_utf(self, value: str, /) -> None:
         await self.write_varint(len(data))
         await self.write(data)
 
-    async def write_optional(self, value: Optional[T], /, writer: Callable[[T], Awaitable[R]]) -> Optional[R]:
+    async def write_optional(self, value: T | None, /, writer: Callable[[T], Awaitable[R]]) -> R | None:
         """Writes a bool showing if a ``value`` is present, if so, also writes this value with ``writer`` function.
 
         * When ``value`` is ``None``, a bool of ``False`` will be written, and ``None`` is returned.
@@ -223,7 +223,7 @@ def write_value(self, fmt: StructFormat, value: object, /) -> None:
         """Write a given ``value`` as given struct format (``fmt``) in big-endian mode."""
         self.write(struct.pack(">" + fmt.value, value))
 
-    def _write_varuint(self, value: int, /, *, max_bits: Optional[int] = None) -> None:
+    def _write_varuint(self, value: int, /, *, max_bits: int | None = None) -> None:
         """Write an arbitrarily big unsigned integer in a variable length format.
 
         This is a standard way of transmitting ints, and it allows smaller numbers to take less bytes.
@@ -297,7 +297,7 @@ def write_utf(self, value: str, /) -> None:
         self.write_varint(len(data))
         self.write(data)
 
-    def write_optional(self, value: Optional[T], /, writer: Callable[[T], R]) -> Optional[R]:
+    def write_optional(self, value: T | None, /, writer: Callable[[T], R]) -> R | None:
         """Writes a bool showing if a ``value`` is present, if so, also writes this value with ``writer`` function.
 
         * When ``value`` is ``None``, a bool of ``False`` will be written, and ``None`` is returned.
@@ -351,7 +351,7 @@ async def read_value(self, fmt: StructFormat, /) -> object:
         unpacked = struct.unpack(">" + fmt.value, data)
         return unpacked[0]
 
-    async def _read_varuint(self, *, max_bits: Optional[int] = None) -> int:
+    async def _read_varuint(self, *, max_bits: int | None = None) -> int:
         """Read an arbitrarily big unsigned integer in a variable length format.
 
         This is a standard way of transmitting ints, and it allows smaller numbers to take less bytes.
@@ -391,17 +391,15 @@ async def read_varint(self) -> int:
         For more information about variable length format check :meth:`._read_varuint`.
         """
         unsigned_num = await self._read_varuint(max_bits=32)
-        val = from_twos_complement(unsigned_num, bits=32)
-        return val
+        return from_twos_complement(unsigned_num, bits=32)
 
     async def read_varlong(self) -> int:
         """Read a 64-bit signed integer in a variable length format.
 
         For more information about variable length format check :meth:`._read_varuint`.
         """
         unsigned_num = await self._read_varuint(max_bits=64)
-        val = from_twos_complement(unsigned_num, bits=64)
-        return val
+        return from_twos_complement(unsigned_num, bits=64)
 
     async def read_bytearray(self, /) -> bytearray:
         """Read an arbitrary sequence of bytes, prefixed with a varint of it's size."""
@@ -446,7 +444,7 @@ async def read_utf(self) -> str:
 
         return chars
 
-    async def read_optional(self, reader: Callable[[], Awaitable[R]]) -> Optional[R]:
+    async def read_optional(self, reader: Callable[[], Awaitable[R]]) -> R | None:
         """Reads a bool showing if a value is present, if so, also reads this value with ``reader`` function.
 
         * When ``False`` is read, the function will not read anything and ``None`` is returned.
@@ -493,7 +491,7 @@ def read_value(self, fmt: StructFormat, /) -> object:
         unpacked = struct.unpack(">" + fmt.value, data)
         return unpacked[0]
 
-    def _read_varuint(self, *, max_bits: Optional[int] = None) -> int:
+    def _read_varuint(self, *, max_bits: int | None = None) -> int:
         """Read an arbitrarily big unsigned integer in a variable length format.
 
         This is a standard way of transmitting ints, and it allows smaller numbers to take less bytes.
@@ -533,17 +531,15 @@ def read_varint(self) -> int:
         For more information about variable length format check :meth:`._read_varuint`.
         """
         unsigned_num = self._read_varuint(max_bits=32)
-        val = from_twos_complement(unsigned_num, bits=32)
-        return val
+        return from_twos_complement(unsigned_num, bits=32)
 
     def read_varlong(self) -> int:
         """Read a 64-bit signed integer in a variable length format.
 
         For more information about variable length format check :meth:`._read_varuint`.
         """
         unsigned_num = self._read_varuint(max_bits=64)
-        val = from_twos_complement(unsigned_num, bits=64)
-        return val
+        return from_twos_complement(unsigned_num, bits=64)
 
     def read_bytearray(self) -> bytearray:
         """Read an arbitrary sequence of bytes, prefixed with a varint of it's size."""
@@ -588,7 +584,7 @@ def read_utf(self) -> str:
 
         return chars
 
-    def read_optional(self, reader: Callable[[], R]) -> Optional[R]:
+    def read_optional(self, reader: Callable[[], R]) -> R | None:
         """Reads a bool showing if a value is present, if so, also reads this value with ``reader`` function.
 
         * When ``False`` is read, the function will not read anything and ``None`` is returned.

mcproto/types/chat.py

@@ -42,12 +42,12 @@ def as_dict(self) -> RawChatMessageDict:
         """Convert received ``raw`` into a stadard :class:`dict` form."""
         if isinstance(self.raw, list):
             return RawChatMessageDict(extra=self.raw)
-        elif isinstance(self.raw, str):
+        if isinstance(self.raw, str):
             return RawChatMessageDict(text=self.raw)
-        elif isinstance(self.raw, dict):  # pyright: ignore[reportUnnecessaryIsInstance]
+        if isinstance(self.raw, dict):  # pyright: ignore[reportUnnecessaryIsInstance]
             return self.raw
-        else:  # pragma: no cover
-            raise TypeError(f"Found unexpected type ({self.raw.__class__!r}) ({self.raw!r}) in `raw` attribute")
+        # pragma: no cover
+        raise TypeError(f"Found unexpected type ({self.raw.__class__!r}) ({self.raw!r}) in `raw` attribute")
 
     def __eq__(self, other: Self) -> bool:
         """Check equality between two chat messages.

mcproto/utils/deprecation.py

@@ -4,7 +4,7 @@
 import warnings
 from collections.abc import Callable
 from functools import wraps
-from typing import Optional, TypeVar, Union
+from typing import TypeVar
 
 from semantic_version import Version
 from typing_extensions import ParamSpec, Protocol
@@ -18,9 +18,9 @@
 def deprecation_warn(
     *,
     obj_name: str,
-    removal_version: Union[str, Version],
-    replacement: Optional[str] = None,
-    extra_msg: Optional[str] = None,
+    removal_version: str | Version,
+    replacement: str | None = None,
+    extra_msg: str | None = None,
     stack_level: int = 3,
 ) -> None:
     """Produce an appropriate deprecation warning given the parameters.
@@ -76,10 +76,10 @@ def __call__(self, __x: Callable[P, R]) -> Callable[P, R]:
 
 
 def deprecated(
-    removal_version: Union[str, Version],
-    display_name: Optional[str] = None,
-    replacement: Optional[str] = None,
-    extra_msg: Optional[str] = None,
+    removal_version: str | Version,
+    display_name: str | None = None,
+    replacement: str | None = None,
+    extra_msg: str | None = None,
 ) -> DecoratorFunction:
     """Mark an object as deprecated.
 

pyproject.toml

@@ -99,33 +99,43 @@ target-version = "py38"
 line-length = 119
 
 select = [
-  "F",      # Pyflakes
-  "W",      # Pycodestyle (warnigns)
-  "E",      # Pycodestyle (errors)
-  "N",      # pep8-naming
-  "YTT",    # flake8-2020
-  "ANN",    # flake8-annotations
-  "S",      # flake8-bandit
-  "B",      # flake8-bugbear
-  "A",      # flake8-builtins
-  "C4",     # flake8-comprehensions
-  "FA",     # flake8-future-annotations
-  "T20",    # flake8-print
-  "PT",     # flake8-pytest-style
-  "RSE",    # flake8-raise
-  "SIM",    # flake8-simplify
-  "TID",    # flake8-tidy-imports
-  "RUF100", # flake8-noqa
-  "UP006",  # flake8-pep585
+  "F",     # Pyflakes
+  "W",     # Pycodestyle (warnigns)
+  "E",     # Pycodestyle (errors)
+  "N",     # pep8-naming
+  "YTT",   # flake8-2020
+  "ANN",   # flake8-annotations
+  "ASYNC", # flake8-async
+  "S",     # flake8-bandit
+  "B",     # flake8-bugbear
+  "A",     # flake8-builtins
+  "C4",    # flake8-comprehensions
+  "FA",    # flake8-future-annotations
+  "T20",   # flake8-print
+  "PT",    # flake8-pytest-style
+  "Q",     # flake8-quotes
+  "RSE",   # flake8-raise
+  "RET",   # flake8-return
+  "SIM",   # flake8-simplify
+  "TID",   # flake8-tidy-imports
+  "INT",   # flake8-gettext
+  "PTH",   # flake8-use-pathlib
+  "PGH",   # pygrep-hooks
+  "PL",    # pylint
+  "RUF",   # ruff-specific rules
+  "UP",    # pyupgrade
 ]
 
 ignore = [
-  "ANN002", # Missing type annotation for *args
-  "ANN003", # Missing type annotation for **kwargs
-  "ANN101", # Missing type annotation for self in method
-  "ANN102", # Missing type annotation for cls in classmethod
-  "ANN204", # Missing return type annotation for special method
-  "PT011",  # pytest.raises without match parameter is too broad
+  "ANN002",  # Missing type annotation for *args
+  "ANN003",  # Missing type annotation for **kwargs
+  "ANN101",  # Missing type annotation for self in method
+  "ANN102",  # Missing type annotation for cls in classmethod
+  "ANN204",  # Missing return type annotation for special method
+  "PT011",   # pytest.raises without match parameter is too broad # TODO: Unignore this
+  "UP024",   # Using errors that alias OSError
+  "PLR2004", # Using unnamed numerical constants
+  "PGH003",  # Using specific rule codes in type ignores
 ]
 
 [tool.ruff.extend-per-file-ignores]

tests/mcproto/protocol/helpers.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from typing import Optional
 from unittest.mock import AsyncMock, Mock
 
 
@@ -33,7 +32,7 @@ class WriteFunctionAsyncMock(WriteFunctionMock, AsyncMock):
 
 
 class ReadFunctionMock(Mock):
-    def __init__(self, *a, combined_data: Optional[bytearray] = None, **kw):
+    def __init__(self, *a, combined_data: bytearray | None = None, **kw):
         super().__init__(*a, **kw)
         if combined_data is None:
             combined_data = bytearray()