Add stricter Ruff linting

dissect/volume/ddf/c_ddf.py

@@ -1,4 +1,5 @@
 # Reference: https://www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf
+from __future__ import annotations
 
 from dissect.cstruct import cstruct
 

dissect/volume/ddf/ddf.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import io
-from typing import BinaryIO
+from typing import TYPE_CHECKING, BinaryIO
 
 from dissect.util import ts
 
@@ -10,12 +10,16 @@
 from dissect.volume.raid.raid import (
     RAID,
     Configuration,
-    DiskMap,
     PhysicalDisk,
     VirtualDisk,
 )
 from dissect.volume.raid.stream import Layout, Level
 
+if TYPE_CHECKING:
+    from dissect.volume.raid.raid import (
+        DiskMap,
+    )
+
 DEFAULT_SECTOR_SIZE = 512
 
 DECADE = 3600 * 24 * (365 * 10 + 2)

dissect/volume/disk/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.volume.disk.disk import Disk
 from dissect.volume.disk.partition import Partition
 from dissect.volume.exceptions import DiskError

dissect/volume/disk/partition.py

@@ -235,7 +235,6 @@ def open(self) -> BinaryIO:
 
 def translate_partition_type(type: int | str | UUID, prepend_type: bool = True) -> str:
     """Translate a partition type to a human-readable format."""
-
     if not isinstance(type, str):
         name = PARTITION_TYPES.get(type, "Unknown")
         type = hex(type) if isinstance(type, int) else type

dissect/volume/disk/schemes/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.volume.disk.schemes.apm import APM
 from dissect.volume.disk.schemes.bsd import BSD
 from dissect.volume.disk.schemes.gpt import GPT

dissect/volume/exceptions.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 class Error(Exception):
     pass
 

dissect/volume/lvm/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.volume.lvm.lvm2 import LVM2
 from dissect.volume.lvm.physical import LVM2Device
 

dissect/volume/lvm/lvm2.py

@@ -18,7 +18,7 @@
 
 
 class LVM2:
-    """Logical Volume Manager"""
+    """Logical Volume Manager."""
 
     def __init__(self, fh: list[BinaryIO | LVM2Device] | BinaryIO | LVM2Device):
         self.fh = [fh] if not isinstance(fh, list) else fh

dissect/volume/md/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.volume.md.md import MD, MDPhysicalDisk
 
 __all__ = [

dissect/volume/md/md.py

@@ -151,7 +151,6 @@ def find_super_block(fh: BinaryIO) -> tuple[int | None, int | None, int | None]:
         A tuple containing the sector, major version, and minor version of the super block, or a
         tuple of ``None`` if no super block was found.
     """
-
     size = fh.size if (hasattr(fh, "size") and fh.size is not None) else fh.seek(0, io.SEEK_END)
     size //= SECTOR_SIZE
 

dissect/volume/raid/stream.py

@@ -198,7 +198,6 @@ def __init__(self, virtual_disk: VirtualDisk):
 
     def _get_stripe_read_info(self, offset: int) -> tuple[int, int, int, int, int | None]:
         """Calculate the stripe, offset in the stripe, data disk, parity disk and "Q" parity disk for a given sector."""
-
         # Reference: raid5_compute_sector
         stripe_size = self.virtual_disk.stripe_size
         raid_disks = self.virtual_disk.num_disks

dissect/volume/vinum/vinum.py

@@ -15,23 +15,28 @@
 from dissect.volume.raid.raid import (
     RAID,
     Configuration,
-    DiskMap,
     PhysicalDisk,
     VirtualDisk,
 )
 from dissect.volume.raid.stream import Layout, Level
 from dissect.volume.vinum.c_vinum import MAGIC_ACTIVE, MAGIC_INACTIVE, c_vinum
 from dissect.volume.vinum.config import (
-    SD,
-    Plex,
     PlexOrg,
     PlexState,
     SDState,
-    Volume,
     parse_vinum_config,
 )
 
 if TYPE_CHECKING:
+    from dissect.volume.raid.raid import (
+        DiskMap,
+    )
+    from dissect.volume.vinum.config import (
+        SD,
+        Plex,
+        Volume,
+    )
+
     VinumPhysicalDiskDescriptor = BinaryIO | "VinumPhysicalDisk"
 
 log = logging.getLogger(__name__)

dissect/volume/vss.py

@@ -6,13 +6,16 @@
 import uuid
 from collections import defaultdict
 from functools import cached_property
-from typing import BinaryIO
+from typing import TYPE_CHECKING, BinaryIO
 
-from dissect.cstruct import Structure, cstruct
+from dissect.cstruct import cstruct
 from dissect.util.stream import AlignedStream
 
 from dissect.volume.exceptions import Error
 
+if TYPE_CHECKING:
+    from dissect.cstruct import Structure
+
 log = logging.getLogger(__name__)
 log.setLevel(os.getenv("DISSECT_LOG_VSS", "CRITICAL"))
 

pyproject.toml

@@ -94,16 +94,33 @@ select = [
   "SLOT",
   "SIM",
   "TID",
-  "TCH",
+  "TC",
   "PTH",
   "PLC",
   "TRY",
   "FLY",
   "PERF",
   "FURB",
   "RUF",
+  "D"
 ]
-ignore = ["E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003"]
+ignore = [
+    "E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003", "PLC0415",
+    # Ignore some pydocstyle rules for now as they require a larger cleanup
+    "D1",
+    "D205",
+    "D301",
+    "D417",
+    # Seems bugged: https://github.com/astral-sh/ruff/issues/16824
+    "D402",
+]
+future-annotations = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
 
 [tool.ruff.lint.per-file-ignores]
 "tests/docs/**" = ["INP001"]
@@ -112,6 +129,7 @@ ignore = ["E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM1
 [tool.ruff.lint.isort]
 known-first-party = ["dissect.volume"]
 known-third-party = ["dissect"]
+required-imports = ["from __future__ import annotations"]
 
 [tool.setuptools.packages.find]
 include = ["dissect.*"]

tests/_docs/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = [
     "autoapi.extension",
     "sphinx.ext.autodoc",

tests/vinum/test_config.py

@@ -14,7 +14,6 @@
     PlexState,
     SDState,
     TokenizeError,
-    VinumConfigs,
     Volume,
     VolumeState,
     _parse_plex_config,
@@ -30,6 +29,10 @@
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
+    from dissect.volume.vinum.config import (
+        VinumConfigs,
+    )
+
 CONF_TS = datetime.min.replace(tzinfo=timezone.utc)
 
 

tests/vinum/test_vinum.py

@@ -2,11 +2,11 @@
 
 from datetime import datetime, timezone
 from io import BytesIO
-from typing import BinaryIO
+from typing import TYPE_CHECKING, BinaryIO
 
 import pytest
 
-from dissect.volume.raid.stream import Layout, Level
+from dissect.volume.raid.stream import Level
 from dissect.volume.vinum.c_vinum import c_vinum
 from dissect.volume.vinum.vinum import (
     Vinum,
@@ -15,6 +15,9 @@
     VinumPlexDisk,
 )
 
+if TYPE_CHECKING:
+    from dissect.volume.raid.stream import Layout
+
 
 @pytest.mark.parametrize(
     (