ruff

Author: rerpha

src/ibex_non_ca_helpers/hex.py

@@ -1,9 +1,11 @@
 import binascii
-import zlib
 import json
-from ibex_non_ca_helpers.pv import waveform_to_string
+import zlib
 from typing import Any, List
 
+from ibex_non_ca_helpers.pv import waveform_to_string
+
+
 def compress_and_hex(value: str) -> bytes:
     """Compresses the inputted string and encodes it as hex.
 
@@ -12,7 +14,7 @@ def compress_and_hex(value: str) -> bytes:
     Returns:
         bytes : A compressed and hexed version of the inputted string
     """
-    assert type(value) == str, (
+    assert type(value) is str, (
         "Non-str argument passed to compress_and_hex, maybe Python 2/3 compatibility issue\n"
         "Argument was type {} with value {}".format(value.__class__.__name__, value)
     )
@@ -29,23 +31,24 @@ def dehex_and_decompress(value: bytes) -> bytes:
     Returns:
         bytes : A decompressed version of the inputted string
     """
-    assert type(value) == bytes, (
+    assert type(value) is bytes, (
         "Non-bytes argument passed to dehex_and_decompress, maybe Python 2/3 compatibility issue\n"
         "Argument was type {} with value {}".format(value.__class__.__name__, value)
     )
     return zlib.decompress(binascii.unhexlify(value))
 
 
 def dehex_and_decompress_waveform(value: List[int]) -> bytes:
-    """Decompresses the inputted waveform, assuming it is a array of integers representing characters (null terminated).
+    """Decompresses the inputted waveform,
+     assuming it is an array of integers representing characters (null terminated).
 
     Args:
         value (list[int]): The string to be decompressed
 
     Returns:
         bytes : A decompressed version of the inputted string
     """
-    assert type(value) == list, (
+    assert type(value) is list, (
         "Non-list argument passed to dehex_and_decompress_waveform\n"
         "Argument was type {} with value {}".format(value.__class__.__name__, value)
     )
@@ -54,6 +57,7 @@ def dehex_and_decompress_waveform(value: List[int]) -> bytes:
     bytes_rep = unicode_rep.encode("ascii")
     return dehex_and_decompress(bytes_rep)
 
+
 def dehex_decompress_and_dejson(value: str | bytes) -> Any:  # noqa: ANN401
     """
     Convert string from zipped hexed json to a python representation

src/ibex_non_ca_helpers/pv.py

@@ -1,5 +1,6 @@
 from typing import Iterable
 
+
 def waveform_to_string(data: Iterable[int | str]) -> str:
     output = ""
     for i in data:

tests/test_hex.py

@@ -1,5 +1,11 @@
 import pytest
-from ibex_non_ca_helpers.hex import compress_and_hex, dehex_and_decompress, dehex_and_decompress_waveform, dehex_decompress_and_dejson
+
+from ibex_non_ca_helpers.hex import (
+    compress_and_hex,
+    dehex_and_decompress,
+    dehex_and_decompress_waveform,
+    dehex_decompress_and_dejson,
+)
 
 
 def test_can_dehex_and_decompress():
@@ -15,25 +21,144 @@ def test_can_hex_and_compress():
     result = compress_and_hex(to_compress_and_hex)
     assert result == expected
 
+
 def test_non_bytes_given_to_dehex_and_decompress_raises_assertionerror():
     with pytest.raises(AssertionError):
         dehex_and_decompress("test")
 
+
 def test_non_string_given_to_compress_and_hex_raises_assertionerror():
     with pytest.raises(AssertionError):
         compress_and_hex(b"test")
 
+
 def test_non_list_given_to_dehex_and_decompress_waveform_raises_assertionerror():
     with pytest.raises(AssertionError):
         dehex_and_decompress_waveform("test")
 
+
 def test_dehex_and_decompress_waveform_with_ok_waveform_returns_expected():
-    test = [55, 56, 57, 99, 56, 98, 53, 54, 52, 97, 99, 99, 99, 57, 52, 99, 52, 101, 53, 53, 100, 50, 53, 49, 53, 48, 52, 97, 99, 98, 99, 57, 50, 99, 50, 56, 52, 56, 50, 100, 48, 50, 51, 49, 57, 51, 102, 50, 57, 51, 52, 48, 53, 52, 55, 49, 52, 57, 53, 49, 98, 99, 49, 49, 56, 99, 54, 49, 48, 56, 54, 53, 56, 48, 97, 56, 100, 99, 102, 99, 49, 50, 49, 48, 53, 53, 54, 48, 48, 97, 50, 54, 56, 100, 57, 53, 54, 50, 48, 49, 101, 49, 99, 53, 49, 51, 54, 52]
+    test = [
+        55,
+        56,
+        57,
+        99,
+        56,
+        98,
+        53,
+        54,
+        52,
+        97,
+        99,
+        99,
+        99,
+        57,
+        52,
+        99,
+        52,
+        101,
+        53,
+        53,
+        100,
+        50,
+        53,
+        49,
+        53,
+        48,
+        52,
+        97,
+        99,
+        98,
+        99,
+        57,
+        50,
+        99,
+        50,
+        56,
+        52,
+        56,
+        50,
+        100,
+        48,
+        50,
+        51,
+        49,
+        57,
+        51,
+        102,
+        50,
+        57,
+        51,
+        52,
+        48,
+        53,
+        52,
+        55,
+        49,
+        52,
+        57,
+        53,
+        49,
+        98,
+        99,
+        49,
+        49,
+        56,
+        99,
+        54,
+        49,
+        48,
+        56,
+        54,
+        53,
+        56,
+        48,
+        97,
+        56,
+        100,
+        99,
+        102,
+        99,
+        49,
+        50,
+        49,
+        48,
+        53,
+        53,
+        54,
+        48,
+        48,
+        97,
+        50,
+        54,
+        56,
+        100,
+        57,
+        53,
+        54,
+        50,
+        48,
+        49,
+        101,
+        49,
+        99,
+        53,
+        49,
+        51,
+        54,
+        52,
+    ]
 
     res = dehex_and_decompress_waveform(test)
 
     assert res == b'["alice", "flipper", "bob", "str_2", "str_1", "str", "mot", "p5", "p3"]'
 
+
 def test_dehex_decompress_dejson():
-    expected = {'key1': 'value1', 'key2': 'value2'}
-    assert dehex_decompress_and_dejson(b'789cab56ca4ead3454b252502a4bcc294d3554d251008918c1458c946a01c39b0a9b') == expected
+    expected = {"key1": "value1", "key2": "value2"}
+    assert (
+        dehex_decompress_and_dejson(
+            b"789cab56ca4ead3454b252502a4bcc294d3554d251008918c1458c946a01c39b0a9b"
+        )
+        == expected
+    )

tests/test_macros.py

@@ -1,16 +1,21 @@
 from unittest.mock import patch
+
 from ibex_non_ca_helpers.macros import get_macro_values
 
+
 @patch("ibex_non_ca_helpers.macros.os.environ.get", return_value={})
 def test_get_macro_values_returns_dict_with_macros_in(environ):
     pass
 
+
 @patch("ibex_non_ca_helpers.macros.os.environ")
 def test_get_macro_values_returns_empty_dict_if_no_macros(environ):
     expected_key_1 = "key1"
     expected_key_2 = "key2"
     expected_value_1 = "value1"
     expected_value_2 = "value2"
     environ.get.return_value = '{"key1": "value1", "key2": "value2"}'
-    assert get_macro_values() == {expected_key_1: expected_value_1, expected_key_2: expected_value_2}
-
+    assert get_macro_values() == {
+        expected_key_1: expected_value_1,
+        expected_key_2: expected_value_2,
+    }

tests/test_pv.py

@@ -1,4 +1,5 @@
 import pytest
+
 from ibex_non_ca_helpers.pv import waveform_to_string
 
 
@@ -12,8 +13,7 @@ def create_waveform_from_list(input_list):
     return "".join([chr(i) for i in input_list])
 
 
-def test_GIVEN_short_list_of_strings_WHEN_waveform_converted_to_string_THEN_result_contains_a_string_of_strings(
-):
+def test_GIVEN_short_list_of_strings_WHEN_waveform_converted_to_string_THEN_result_contains_a_string_of_strings():
     # Arrange
     test_waveform = ["hello", "world"]
 
@@ -25,8 +25,7 @@ def test_GIVEN_short_list_of_strings_WHEN_waveform_converted_to_string_THEN_resu
     check_waveform(test_waveform, expected_value)
 
 
-def test_GIVEN_long_list_of_strings_WHEN_waveform_converted_to_string_THEN_result_contains_a_string_of_strings(
-):
+def test_GIVEN_long_list_of_strings_WHEN_waveform_converted_to_string_THEN_result_contains_a_string_of_strings():
     # Arrange
     test_waveform = ["this", "is", "a", "long", "list", "of", "strings!"]
 
@@ -38,8 +37,7 @@ def test_GIVEN_long_list_of_strings_WHEN_waveform_converted_to_string_THEN_resul
     check_waveform(test_waveform, expected_value)
 
 
-def test_GIVEN_short_list_of_numbers_WHEN_waveform_converted_to_string_THEN_result_contains_string_of_unicode_chars_for_numbers(
-):
+def test_GIVEN_short_list_of_numbers_WHEN_waveform_converted_to_string_THEN_result_contains_string_of_unicode_chars_for_numbers():
     # Arrange
     test_waveform = [1, 2, 3, 4]
 
@@ -51,8 +49,7 @@ def test_GIVEN_short_list_of_numbers_WHEN_waveform_converted_to_string_THEN_resu
     check_waveform(test_waveform, expected_value)
 
 
-def test_GIVEN_list_of_numbers_containing_0_WHEN_waveform_converted_to_string_THEN_result_terminates_at_character_before_0(
-):
+def test_GIVEN_list_of_numbers_containing_0_WHEN_waveform_converted_to_string_THEN_result_terminates_at_character_before_0():
     # Arrange
     test_waveform = [1, 2, 3, 4, 0, 5, 6, 7, 8, 9]
 
@@ -64,8 +61,7 @@ def test_GIVEN_list_of_numbers_containing_0_WHEN_waveform_converted_to_string_TH
     check_waveform(test_waveform, expected_value)
 
 
-def test_GIVEN_long_list_of_numbers_WHEN_waveform_converted_to_string_THEN_result_contains_string_of_unicode_chars_for_numbers(
-):
+def test_GIVEN_long_list_of_numbers_WHEN_waveform_converted_to_string_THEN_result_contains_string_of_unicode_chars_for_numbers():
     # Arrange
     max_unichr = 128
     length = 1000
@@ -79,13 +75,12 @@ def test_GIVEN_long_list_of_numbers_WHEN_waveform_converted_to_string_THEN_resul
     check_waveform(test_waveform, expected_value)
 
 
-def test_GIVEN_negative_integer_in_waveform_WHEN_waveform_converted_to_string_THEN_result_raises_value_error(
-):
+def test_GIVEN_negative_integer_in_waveform_WHEN_waveform_converted_to_string_THEN_result_raises_value_error():
     # Arrange
     test_waveform = [-1]
 
     # Act
 
     # Assert
     with pytest.raises(ValueError):
-        waveform_to_string(test_waveform)
+        waveform_to_string(test_waveform)