dissect.btrfs 1.6.dev1__tar.gz → 1.7.dev2__tar.gz

dissect_btrfs-1.7.dev2/.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# Formatting commits. You can ignore them during git-blame with `--ignore-rev` or `--ignore-revs-file`.
+#
+#   $ git config --add 'blame.ignoreRevsFile' '.git-blame-ignore-revs'
+#
+# Change linter to Ruff (#20)
+09742055fb02a6b14dc8f405e3fdf66c1345ba15

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dissect.btrfs
-Version: 1.6.dev1
+Version: 1.7.dev2
 Summary: A Dissect module implementing a parser for the Btrfs file system, a commonly used Linux filesystem.
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/dissect/btrfs/btrfs.py

@@ -7,9 +7,8 @@ from __future__ import annotations
 
 import io
 import stat
-from datetime import datetime
 from functools import cache, cached_property, lru_cache
-from typing import BinaryIO, Iterator, Optional, Union
+from typing import TYPE_CHECKING, BinaryIO
 from uuid import UUID
 
 from dissect.util import ts
@@ -35,6 +34,10 @@ from dissect.btrfs.exceptions import (
 from dissect.btrfs.stream import ChunkStream, Extent, ExtentStream, decode_extent
 from dissect.btrfs.tree import BTree
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from datetime import datetime
+
 
 class Btrfs:
     """Btrfs filesystem implementation.
@@ -46,7 +49,7 @@ class Btrfs:
         fh: A file-like object for the volume to use for parsing Btrfs.
     """
 
-    def __init__(self, fh: Union[BinaryIO, list[BinaryIO]]):
+    def __init__(self, fh: BinaryIO | list[BinaryIO]):
         self.fhs = fh if isinstance(fh, list) else [fh]
 
         if not self.fhs:
@@ -89,7 +92,7 @@ class Btrfs:
         self.default_subvolume = self._open_default_subvolume()
         self.root = self.default_subvolume.root
 
-    def get(self, path: Union[str, int], node: Optional[INode] = None) -> INode:
+    def get(self, path: str | int, node: INode | None = None) -> INode:
         """Retrieve a Btrfs inode by path or inode number.
 
         Args:
@@ -113,7 +116,7 @@ class Btrfs:
                 yield self.open_subvolume(item.key.offset)
             cursor.reset()
 
-    def find_subvolume(self, path: Optional[str] = None) -> Optional[Subvolume]:
+    def find_subvolume(self, path: str | None = None) -> Subvolume | None:
         """Find a subvolume by path.
 
         Args:
@@ -123,7 +126,9 @@ class Btrfs:
             if subvolume.path == path:
                 return subvolume
 
-    def open_subvolume(self, objectid: int, parent: Optional[INode] = None) -> Subvolume:
+        return None
+
+    def open_subvolume(self, objectid: int, parent: INode | None = None) -> Subvolume:
         """Open a subvolume.
 
         Args:
@@ -194,7 +199,7 @@ class Subvolume:
         parent: Optional parent node to attach to the root of the subvolume.
     """
 
-    def __init__(self, btrfs: Btrfs, objectid: int, parent: Optional[INode] = None):
+    def __init__(self, btrfs: Btrfs, objectid: int, parent: INode | None = None):
         self.btrfs = btrfs
         self.objectid = objectid
         self.parent = parent
@@ -234,7 +239,7 @@ class Subvolume:
 
         return "/".join(parts[::-1])
 
-    def get(self, path: Union[str, int], node: Optional[INode] = None) -> INode:
+    def get(self, path: str | int, node: INode | None = None) -> INode:
         """Retrieve a Btrfs inode by path or inode number.
 
         Args:
@@ -286,7 +291,7 @@ class Subvolume:
 
         return node
 
-    def inode(self, inum: int, type: Optional[int] = None, parent: Optional[INode] = None) -> INode:
+    def inode(self, inum: int, type: int | None = None, parent: INode | None = None) -> INode:
         """Return an :class:`INode` by number, optionally attaching a type and parent."""
         return INode(self, inum, type, parent)
 
@@ -312,13 +317,7 @@ class INode:
         parent: Optional parent of this inode, if this inode is parsed from a directory listing.
     """
 
-    def __init__(
-        self,
-        subvolume: Subvolume,
-        inum: int,
-        type: Optional[int] = None,
-        parent: Optional[INode] = None,
-    ):
+    def __init__(self, subvolume: Subvolume, inum: int, type: int | None = None, parent: INode | None = None):
         self.subvolume = subvolume
         self.btrfs = subvolume.btrfs
         self.inum = inum
@@ -450,14 +449,11 @@ class INode:
     def link_inode(self) -> INode:
         """Resolve the symlink target to an inode."""
         link = self.link
-        if link.startswith("/"):
-            relnode = None
-        else:
-            relnode = self.parent
+        relnode = None if link.startswith("/") else self.parent
         return self.subvolume.get(self.link, relnode)
 
     @property
-    def parents(self) -> list[INode]:
+    def parents(self) -> Iterator[INode]:
         for item, data in self.subvolume.tree.cursor().iter(
             self.inum, c_btrfs.BTRFS_INODE_REF_KEY, 0, ignore_offset=True
         ):
@@ -517,7 +513,7 @@ class INode:
 
     def listdir(self) -> dict[str, INode]:
         """Return a directory listing."""
-        return {name: inode for name, inode in self.iterdir()}
+        return dict(self.iterdir())
 
     def iterdir(self) -> Iterator[tuple[str, INode]]:
         """Iterate directory contents."""
@@ -543,11 +539,13 @@ class INode:
             else:
                 raise NotImplementedError(f"Unknown dir_item type: {dir_item}")
 
-    def extents(self) -> Optional[list[Extent]]:
+    def extents(self) -> list[Extent] | None:
         with self.open() as fh:
             if isinstance(fh, ExtentStream):
                 return fh.extents
 
+        return None
+
     def open(self) -> BinaryIO:
         """Return the data stream for the inode.
 

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/dissect/btrfs/tree.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 
 from functools import lru_cache
-from typing import TYPE_CHECKING, Iterator, Literal, Optional, Union
+from typing import TYPE_CHECKING, Literal
 
 from dissect.btrfs.c_btrfs import c_btrfs
 
 if TYPE_CHECKING:
+    from collections.abc import Iterator
+
     from dissect.btrfs.btrfs import Btrfs
 
 
@@ -20,9 +22,7 @@ class BTree:
         root_offset: Optional offset to open the B-tree from.
     """
 
-    def __init__(
-        self, btrfs: Btrfs, root_item: Optional[c_btrfs.btrfs_root_item] = None, root_offset: Optional[int] = None
-    ):
+    def __init__(self, btrfs: Btrfs, root_item: c_btrfs.btrfs_root_item | None = None, root_offset: int | None = None):
         self.btrfs = btrfs
 
         if not root_item and not root_offset:
@@ -38,7 +38,7 @@ class BTree:
         return Cursor(self)
 
     def find(
-        self, objectid: Optional[int] = None, type: Optional[int] = None, offset: Optional[int] = None
+        self, objectid: int | None = None, type: int | None = None, offset: int | None = None
     ) -> tuple[c_btrfs.btrfs_item, memoryview]:
         """Search for a single item in the B-tree.
 
@@ -127,7 +127,7 @@ class Cursor:
 
         return key
 
-    def _read_item(self, index: int) -> Union[c_btrfs.btrfs_key_ptr, c_btrfs.btrfs_item]:
+    def _read_item(self, index: int) -> c_btrfs.btrfs_key_ptr | c_btrfs.btrfs_item:
         """Read an item at the specified index.
 
         Args:
@@ -214,7 +214,7 @@ class Cursor:
         """
         return self.item(), self.data()
 
-    def item(self) -> Union[c_btrfs.btrfs_key_ptr, c_btrfs.btrfs_item]:
+    def item(self) -> c_btrfs.btrfs_key_ptr | c_btrfs.btrfs_item:
         """Retrieve a leaf or branch item.
 
         Cursor can be positioned at a branch or leaf item.
@@ -224,9 +224,9 @@ class Cursor:
 
         return self._read_item(self._index)
 
-    def items(self) -> Iterator[Union[c_btrfs.btrfs_key_ptr, c_btrfs.btrfs_item]]:
+    def items(self) -> Iterator[c_btrfs.btrfs_key_ptr | c_btrfs.btrfs_item]:
         """Iterate over all items in the current node."""
-        for i in range(0, self._header.nritems):
+        for i in range(self._header.nritems):
             yield self._read_item(i)
 
     def data(self) -> memoryview:
@@ -245,9 +245,9 @@ class Cursor:
 
     def iter(
         self,
-        objectid: Optional[int] = None,
-        type: Optional[int] = None,
-        offset: Optional[int] = None,
+        objectid: int | None = None,
+        type: int | None = None,
+        offset: int | None = None,
         ignore_offset: bool = False,
     ) -> Iterator[tuple[c_btrfs.btrfs_item, memoryview]]:
         """Search and iterate the B-tree for the specified key.
@@ -274,9 +274,9 @@ class Cursor:
 
     def walk(
         self,
-        objectid: Optional[int] = None,
-        type: Optional[int] = None,
-        offset: Optional[int] = None,
+        objectid: int | None = None,
+        type: int | None = None,
+        offset: int | None = None,
     ) -> Iterator[tuple[c_btrfs.btrfs_item, memoryview]]:
         """Walk all leaf items of the B-tree and yield all matching leafs.
 
@@ -296,7 +296,7 @@ class Cursor:
             except ValueError:
                 return
 
-    def search(self, objectid: Optional[int] = None, type: Optional[int] = None, offset: Optional[int] = None) -> bool:
+    def search(self, objectid: int | None = None, type: int | None = None, offset: int | None = None) -> bool:
         """Perform a binary search on the current node for the key with the given parameters.
 
         Puts the cursor at the index of the matching item, or just before a "greater" item if no exact match is found.
@@ -330,22 +330,23 @@ class Cursor:
                 self._index = min_idx
                 self.push(self._read_item(min_idx).blockptr)
                 continue
-            else:
-                if result >= 0:
-                    # Count a matching or larger key as a win
-                    self._index = min_idx
-                    return True
-                elif min_idx == self._header.nritems - 1:
-                    # Special case where we have exhausted all leaf nodes but all keys are still smaller
-                    # In this case, try to travel to the next node (up one level, next item, down one level)
-                    # Worst case we end up at a key that's larger than our search parameters.
-                    self._index = min_idx
-                    try:
-                        self.next_node()
-                        continue
-                    except ValueError:
-                        self._index = None
-                        return False
+
+            if result >= 0:
+                # Count a matching or larger key as a win
+                self._index = min_idx
+                return True
+
+            if min_idx == self._header.nritems - 1:
+                # Special case where we have exhausted all leaf nodes but all keys are still smaller
+                # In this case, try to travel to the next node (up one level, next item, down one level)
+                # Worst case we end up at a key that's larger than our search parameters.
+                self._index = min_idx
+                try:
+                    self.next_node()
+                    continue
+                except ValueError:
+                    self._index = None
+                    return False
 
             break
 
@@ -355,9 +356,9 @@ class Cursor:
 
 def _cmp_key(
     key: c_btrfs.btrfs_disk_key,
-    objectid: Optional[int] = None,
-    type: Optional[int] = None,
-    offset: Optional[int] = None,
+    objectid: int | None = None,
+    type: int | None = None,
+    offset: int | None = None,
 ) -> Literal[1, -1, 0]:
     """Compare a B-tree key on disk to a given object ID, type and offset.
 

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/dissect.btrfs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dissect.btrfs
-Version: 1.6.dev1
+Version: 1.7.dev2
 Summary: A Dissect module implementing a parser for the Btrfs file system, a commonly used Linux filesystem.
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/dissect.btrfs.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+.git-blame-ignore-revs
 .gitattributes
 COPYRIGHT
 LICENSE

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/pyproject.toml

@@ -53,13 +53,56 @@ dev = [
     "dissect.util>=3.0.dev,<4.0.dev",
 ]
 
-[tool.black]
+[tool.ruff]
 line-length = 120
+required-version = ">=0.9.0"
 
-[tool.isort]
-profile = "black"
-known_first_party = ["dissect.btrfs"]
-known_third_party = ["dissect"]
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+  "F",
+  "E",
+  "W",
+  "I",
+  "UP",
+  "YTT",
+  "ANN",
+  "B",
+  "C4",
+  "DTZ",
+  "T10",
+  "FA",
+  "ISC",
+  "G",
+  "INP",
+  "PIE",
+  "PYI",
+  "PT",
+  "Q",
+  "RSE",
+  "RET",
+  "SLOT",
+  "SIM",
+  "TID",
+  "TCH",
+  "PTH",
+  "PLC",
+  "TRY",
+  "FLY",
+  "PERF",
+  "FURB",
+  "RUF",
+]
+ignore = ["E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/docs/**" = ["INP001"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["dissect.btrfs"]
+known-third-party = ["dissect"]
 
 [tool.setuptools]
 license-files = ["LICENSE", "COPYRIGHT"]

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/tests/conftest.py

@@ -1,17 +1,22 @@
+from __future__ import annotations
+
 import contextlib
 import gzip
-import os
-from typing import IO, BinaryIO, Iterator
+from pathlib import Path
+from typing import IO, TYPE_CHECKING, BinaryIO
 
 import pytest
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 
-def absolute_path(filename: str) -> str:
-    return os.path.join(os.path.dirname(__file__), filename)
+def absolute_path(filename: str) -> Path:
+    return Path(__file__).parent / filename
 
 
 def open_file(name: str, mode: str = "rb") -> Iterator[IO]:
-    with open(absolute_path(name), mode) as f:
+    with absolute_path(name).open(mode) as f:
         yield f
 
 

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/tests/test_btrfs.py

@@ -200,11 +200,8 @@ def test_btrfs_profiles(fixture: str, request: pytest.FixtureRequest) -> None:
 )
 def test_btrfs_profiles_partial(fixture: str, request: pytest.FixtureRequest) -> None:
     fhs = request.getfixturevalue(fixture)
-    if fixture == "btrfs_profile_dup":
-        # This test data just so happens to have all chunks on the second device
-        fhs = fhs[:-1]
-    else:
-        fhs = fhs[1:]
+    # The btrfs_profile_dup test data just so happens to have all chunks on the second device
+    fhs = fhs[:-1] if fixture == "btrfs_profile_dup" else fhs[1:]
 
     if fixture in ("btrfs_profile_dup", "btrfs_profile_raid0"):
         with pytest.raises(Error, match="Missing stripe disk for chunk offset .+"):

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/tests/test_exceptions.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import pytest
 
 from dissect.btrfs import exceptions
 
 
 @pytest.mark.parametrize(
-    "exc, std",
+    ("exc", "std"),
     [
         (exceptions.FileNotFoundError, FileNotFoundError),
         (exceptions.IsADirectoryError, IsADirectoryError),

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/tox.ini

@@ -32,23 +32,17 @@ commands =
 [testenv:fix]
 package = skip
 deps =
-    black==23.1.0
-    isort==5.11.4
+    ruff==0.9.2
 commands =
-    black dissect tests
-    isort dissect tests
+    ruff format dissect tests
 
 [testenv:lint]
 package = skip
 deps =
-    black==23.1.0
-    flake8
-    flake8-black
-    flake8-isort
-    isort==5.11.4
+    ruff==0.9.2
     vermin
 commands =
-    flake8 dissect tests
+    ruff check dissect tests
     vermin -t=3.9- --no-tips --lint dissect tests
 
 [flake8]

{dissect_btrfs-1.6.dev1 → dissect_btrfs-1.7.dev2}/dissect/btrfs/__init__.py

@@ -8,10 +8,10 @@ from dissect.btrfs.exceptions import (
 
 __all__ = [
     "Btrfs",
-    "INode",
-    "Subvolume",
     "Error",
     "FileNotFoundError",
+    "INode",
     "NotADirectoryError",
     "NotASymlinkError",
+    "Subvolume",
 ]