Merge branch 'development' of https://github.com/danielhrisca/asammdf …

…into development

.pre-commit-config.yaml

@@ -1,5 +1,10 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: stable
+  - repo: https://github.com/ambv/black
+    rev: 23.9.1
     hooks:
       - id: black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.0
+    hooks:
+      - id: ruff

pyproject.toml

@@ -13,16 +13,22 @@ extend-exclude = '''
 source = ["asammdf"]
 omit = ["*/asammdf/gui/ui/*"]
 
-
-[tool.isort]
-force_sort_within_sections = true
-order_by_type = false
-profile = "black"
-skip_glob = ["src/asammdf/gui/ui"]
-
 [tool.cibuildwheel]
 test-requires = "pytest"
 test-command = "pytest {project}/test"
 build-frontend = "build"
 archs = ["auto64"]  # only build for 64bit architectures
 skip = "pp* *_ppc64le *_s390x *-musllinux* cp312-*"  # skip pypy and irrelevant architectures
+
+[tool.ruff]
+select = [
+    "UP",  # pyupgrade
+    "I",  # isort
+]
+exclude = ["./src/asammdf/gui/ui"]
+target-version = "py38"
+
+[tool.ruff.isort]
+known-first-party = ["asammdf"]
+order-by-type = false
+force-sort-within-sections = true

run_black_and_ruff.bat

@@ -0,0 +1,6 @@
+pip install -U black ruff && ^
+ruff check --fix ./src && ^
+ruff check --fix ./setup.py && ^
+black --config pyproject.toml . && ^
+black --config pyproject.toml asammdf.spec && ^
+black --config pyproject.toml setup.py

src/asammdf/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """ asammdf is a parser and editor for ASAM MDF files """
 
 import logging

src/asammdf/blocks/conversion_utils.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 asammdf utility functions for channel conversions
 """
@@ -8,11 +7,11 @@
 from copy import deepcopy
 from typing import Any, Union
 
+from ..types import ChannelConversionType
 from . import v2_v3_blocks as v3b
 from . import v2_v3_constants as v3c
 from . import v4_blocks as v4b
 from . import v4_constants as v4c
-from ..types import ChannelConversionType
 
 __all__ = ["conversion_transfer", "from_dict"]
 
@@ -379,7 +378,7 @@ def from_dict(conversion: dict[str, Any]) -> v4b.ChannelConversion:
     return conversion
 
 
-def to_dict(conversion: ChannelConversionType) -> Union[dict, None]:
+def to_dict(conversion: ChannelConversionType) -> dict | None:
     if not conversion:
         return None
 

src/asammdf/blocks/mdf_v2.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """ ASAM MDF version 2 file format module """
 
 from __future__ import annotations

src/asammdf/blocks/mdf_v3.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """ ASAM MDF version 3 file format module """
 
 from __future__ import annotations
@@ -44,11 +43,11 @@
 from pandas import DataFrame
 from typing_extensions import Literal, TypedDict
 
-from . import v2_v3_constants as v23c
 from .. import tool
 from ..signal import Signal
 from ..types import ChannelsType, CompressionType, RasterType, StrPathType
 from ..version import __version__
+from . import v2_v3_constants as v23c
 from .conversion_utils import conversion_transfer
 from .cutils import get_channel_raw_bytes
 from .mdf_common import MDF_Common
@@ -1799,7 +1798,7 @@ def append(
                     sd_nr = len(component_samples)
                     kargs = {"sd_nr": sd_nr}
                     for i, dim in enumerate(shape[::-1]):
-                        kargs["dim_{}".format(i)] = dim
+                        kargs[f"dim_{i}"] = dim
                     parent_dep = ChannelDependency(**kargs)
                     new_gp_dep.append(parent_dep)
 

src/asammdf/blocks/mdf_v4.py

@@ -75,8 +75,6 @@
 from numpy.typing import NDArray
 from pandas import DataFrame
 
-from . import bus_logging_utils
-from . import v4_constants as v4c
 from .. import tool
 from ..signal import Signal
 from ..types import (
@@ -89,6 +87,8 @@
     WritableBufferType,
 )
 from ..version import __version__
+from . import bus_logging_utils
+from . import v4_constants as v4c
 from .conversion_utils import conversion_transfer
 from .mdf_common import MDF_Common
 from .options import get_global_option

src/asammdf/blocks/source_utils.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 asammdf utility functions for source information
 """
@@ -7,11 +6,11 @@
 
 from functools import lru_cache
 
+from ..types import SourceType
 from . import v2_v3_blocks as v3b
 from . import v2_v3_constants as v3c
 from . import v4_blocks as v4b
 from . import v4_constants as v4c
-from ..types import SourceType
 
 
 class Source:

src/asammdf/blocks/utils.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 asammdf utility functions and classes
 """
@@ -94,8 +93,6 @@ def detect(text: bytes) -> DetectDict:
 from numpy.typing import NDArray
 from pandas import Series
 
-from . import v2_v3_constants as v3c
-from . import v4_constants as v4c
 from ..types import (
     ChannelType,
     DataGroupType,
@@ -104,6 +101,8 @@ def detect(text: bytes) -> DetectDict:
     ReadableBufferType,
     StrPathType,
 )
+from . import v2_v3_constants as v3c
+from . import v4_constants as v4c
 
 UINT8_u = Struct("<B").unpack
 UINT16_u = Struct("<H").unpack
@@ -1119,7 +1118,7 @@ def is_file_like(obj: object) -> bool:
     return True
 
 
-class UniqueDB(object):
+class UniqueDB:
     def __init__(self) -> None:
         self._db = {}
 
@@ -1279,8 +1278,7 @@ def clear(self) -> None:
         self.data_blocks_info_generator = None
 
     def get_data_blocks(self) -> Iterator[DataBlockInfo]:
-        for blk in self.data_blocks:
-            yield blk
+        yield from self.data_blocks
 
         while True:
             try:
@@ -1294,8 +1292,7 @@ def get_signal_data_blocks(self, index: int) -> Iterator[SignalDataBlockInfo]:
         signal_data = self.signal_data[index]
         if signal_data is not None:
             signal_data, signal_generator = signal_data
-            for blk in signal_data:
-                yield blk
+            yield from signal_data
 
             while True:
                 try:
@@ -2322,7 +2319,7 @@ def load_channel_names_from_file(file_name, lab_section=""):
         channels = load_dsp(file_name, flat=True)
 
     elif extension == ".dspf":
-        with open(file_name, "r") as infile:
+        with open(file_name) as infile:
             info = json.load(infile)
 
         channels = []
@@ -2345,16 +2342,16 @@ def load_channel_names_from_file(file_name, lab_section=""):
             channels = [name.split(";")[0] for name in channels]
 
     elif extension == ".cfg":
-        with open(file_name, "r") as infile:
+        with open(file_name) as infile:
             info = json.load(infile)
         channels = info.get("selected_channels", [])
     elif extension == ".txt":
         try:
-            with open(file_name, "r") as infile:
+            with open(file_name) as infile:
                 info = json.load(infile)
             channels = info.get("selected_channels", [])
         except:
-            with open(file_name, "r") as infile:
+            with open(file_name) as infile:
                 channels = [line.strip() for line in infile.readlines()]
                 channels = [name for name in channels if name]
 
@@ -2363,7 +2360,7 @@ def load_channel_names_from_file(file_name, lab_section=""):
 
 def load_lab(file):
     sections = {}
-    with open(file, "r") as lab:
+    with open(file) as lab:
         for line in lab:
             line = line.strip()
             if not line:

src/asammdf/blocks/v2_v3_blocks.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """ classes that implement the blocks for MDF versions 2 and 3 """
 
 from __future__ import annotations
@@ -25,8 +24,8 @@
 
 import numpy as np
 
-from . import v2_v3_constants as v23c
 from ..version import __version__
+from . import v2_v3_constants as v23c
 from .utils import (
     escape_xml_string,
     get_fields,
@@ -1761,7 +1760,7 @@ def __init__(self, **kwargs) -> None:
             (self.id, self.block_len, self.dependency_type, self.sd_nr) = unpack("<2s3H", stream.read(8))
 
             links_size = 3 * 4 * self.sd_nr
-            links = unpack("<{}I".format(3 * self.sd_nr), stream.read(links_size))
+            links = unpack(f"<{3 * self.sd_nr}I", stream.read(links_size))
 
             for i in range(self.sd_nr):
                 self[f"dg_{i}"] = links[3 * i]
@@ -2727,7 +2726,7 @@ def __init__(self, **kwargs) -> None:
                 user = getuser()
             except ModuleNotFoundError:
                 user = ""
-            self.author_field = "{:\0<32}".format(user).encode("latin-1")
+            self.author_field = f"{user:\0<32}".encode("latin-1")
             self.department_field = "{:\0<32}".format("").encode("latin-1")
             self.project_field = "{:\0<32}".format("").encode("latin-1")
             self.subject_field = "{:\0<32}".format("").encode("latin-1")
@@ -3162,12 +3161,12 @@ def __init__(self, **kwargs) -> None:
 
             nr = self.trigger_events_nr
             if nr:
-                values = unpack("<{}d".format(3 * nr), block[10:])
+                values = unpack(f"<{3 * nr}d", block[10:])
             for i in range(nr):
                 (
-                    self["trigger_{}_time".format(i)],
-                    self["trigger_{}_pretime".format(i)],
-                    self["trigger_{}_posttime".format(i)],
+                    self[f"trigger_{i}_time"],
+                    self[f"trigger_{i}_pretime"],
+                    self[f"trigger_{i}_posttime"],
                 ) = (values[i * 3], values[3 * i + 1], values[3 * i + 2])
 
             if self.text_addr:
@@ -3182,7 +3181,7 @@ def __init__(self, **kwargs) -> None:
         except KeyError:
             self.address = 0
             nr = 0
-            while "trigger_{}_time".format(nr) in kwargs:
+            while f"trigger_{nr}_time" in kwargs:
                 nr += 1
 
             self.id = b"TR"
@@ -3191,11 +3190,11 @@ def __init__(self, **kwargs) -> None:
             self.trigger_events_nr = nr
 
             for i in range(nr):
-                key = "trigger_{}_time".format(i)
+                key = f"trigger_{i}_time"
                 self[key] = kwargs[key]
-                key = "trigger_{}_pretime".format(i)
+                key = f"trigger_{i}_pretime"
                 self[key] = kwargs[key]
-                key = "trigger_{}_posttime".format(i)
+                key = f"trigger_{i}_posttime"
                 self[key] = kwargs[key]
 
     def to_blocks(self, address: int, blocks: list[Any]) -> int:
@@ -3223,13 +3222,13 @@ def __setitem__(self, item: str, value: Any) -> None:
 
     def __bytes__(self) -> bytes:
         triggers_nr = self.trigger_events_nr
-        fmt = "<2sHIH{}d".format(triggers_nr * 3)
+        fmt = f"<2sHIH{triggers_nr * 3}d"
         keys = ("id", "block_len", "text_addr", "trigger_events_nr")
         for i in range(triggers_nr):
             keys += (
-                "trigger_{}_time".format(i),
-                "trigger_{}_pretime".format(i),
-                "trigger_{}_posttime".format(i),
+                f"trigger_{i}_time",
+                f"trigger_{i}_pretime",
+                f"trigger_{i}_posttime",
             )
         result = pack(fmt, *[self[key] for key in keys])
         return result

src/asammdf/blocks/v2_v3_constants.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """ MDF v2 and v3 constants """
 import struct