dissect.clfs 1.11.dev1__tar.gz → 1.12.dev2__tar.gz

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.clfs
-Version: 1.11.dev1
+Version: 1.12.dev2
 Summary: A Dissect module implementing a parser for the CLFS (Common Log File System) file system of Windows
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: AGPL-3.0-or-later

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/dissect/clfs/c_clfs.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import io
 from typing import BinaryIO
 
@@ -333,5 +335,4 @@ class BlockHeader:
 
     def open(self) -> io.BytesIO:
         """Return a file-like object of the block header."""
-
         return io.BytesIO(self.data)

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/dissect/clfs/container.py

@@ -27,7 +27,6 @@ class Container:
         Returns:
             buf, cur_record_offset: Tuple containing a file-like object of the log block and the current offset.
         """
-
         try:
             log_block = BlockHeader(fh=self.fh, offset=offset)
         except EOFError:
@@ -42,7 +41,6 @@ class Container:
 
     def records(self) -> Iterator[tuple[int, bytes, bytes]]:
         """Parse the records that are present within the log block."""
-
         log_block_offset = self.offset
 
         buf, cur_record_offset = self._open_block(log_block_offset)

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/dissect/clfs/exceptions.py

@@ -1,18 +1,21 @@
+from __future__ import annotations
+
+
 class Error(Exception):
     pass
 
 
 class InvalidRecordBlockError(Error):
-    """Exception raised when the record block contains invalid data"""
+    """Exception raised when the record block contains invalid data."""
 
 
 class InvalidBLFError(Error):
-    """Exception raised if the validation of the BLF file fails"""
+    """Exception raised if the validation of the BLF file fails."""
 
 
 class InvalidSymbolTableError(Error):
-    """Exception raised when the symbol table(s) fail to parse"""
+    """Exception raised when the symbol table(s) fail to parse."""
 
 
 class InvalidContextError(Error):
-    """Exception raised when the context type doesn't match the context to be parsed"""
+    """Exception raised when the context type doesn't match the context to be parsed."""

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/dissect.clfs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.clfs
-Version: 1.11.dev1
+Version: 1.12.dev2
 Summary: A Dissect module implementing a parser for the CLFS (Common Log File System) file system of Windows
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: AGPL-3.0-or-later

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/dissect.clfs.egg-info/SOURCES.txt

@@ -21,11 +21,11 @@ tests/test_container.py
 tests/test_control_record.py
 tests/test_record_header.py
 tests/test_validate_blf.py
+tests/_docs/Makefile
+tests/_docs/conf.py
+tests/_docs/index.rst
 tests/data/DRIVERS{53b39e70-18c4-11ea-a811-000d3aa4692b}.TM.blf
 tests/data/DRIVERS{53b39e70-18c4-11ea-a811-000d3aa4692b}.TMContainer00000000000000000001.regtrans-ms
 tests/data/bad_control_record.blf
 tests/data/control_record.blf
-tests/data/invalid_control_record.blf
-tests/docs/Makefile
-tests/docs/conf.py
-tests/docs/index.rst
+tests/data/invalid_control_record.blf

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/pyproject.toml

@@ -92,7 +92,7 @@ select = [
   "SLOT",
   "SIM",
   "TID",
-  "TCH",
+  "TC",
   "PTH",
   "PLC",
   "TRY",
@@ -100,15 +100,34 @@ select = [
   "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"]
+"tests/_docs/**" = ["INP001"]
 
 [tool.ruff.lint.isort]
 known-first-party = ["dissect.clfs"]
 known-third-party = ["dissect"]
+required-imports = ["from __future__ import annotations"]
 
 [tool.setuptools.packages.find]
 include = ["dissect.*"]

{dissect_clfs-1.11.dev1/tests/docs → dissect_clfs-1.12.dev2/tests/_docs}/conf.py

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

{dissect_clfs-1.11.dev1 → dissect_clfs-1.12.dev2}/tox.ini

@@ -60,12 +60,12 @@ deps =
     sphinx-design
     furo
 commands =
-    make -C tests/docs clean
-    make -C tests/docs html
+    make -C tests/_docs clean
+    make -C tests/_docs html
 
 [testenv:docs-linkcheck]
 allowlist_externals = make
 deps = {[testenv:docs-build]deps}
 commands =
-    make -C tests/docs clean
-    make -C tests/docs linkcheck
+    make -C tests/_docs clean
+    make -C tests/_docs linkcheck