ADD: Missing arrange act assert comments

Author: nmacholl

tests/test_bento_compression.py

@@ -20,7 +20,10 @@ def test_is_dbn(data: bytes, expected: bool) -> None:
     """
     Test that buffers that start with DBN are identified as DBN files.
     """
+    # Arrange, Act
     reader = BytesIO(data)
+
+    # Assert
     assert is_dbn(reader) == expected
 
 
@@ -52,5 +55,8 @@ def test_is_zstandard(data: bytes, expected: bool) -> None:
     """
     Test that buffers that contain ZSTD data are correctly identified.
     """
+    # Arrange, Act
     reader = BytesIO(data)
+
+    # Assert
     assert is_zstandard(reader) == expected

tests/test_bento_data_source.py

@@ -15,9 +15,11 @@ def test_memory_data_source(
     """
     Test create of MemoryDataSource.
     """
+    # Arrange, Act
     data = test_data(schema)
     data_source = MemoryDataSource(data)
 
+    # Assert
     assert len(data) == data_source.nbytes
     assert repr(data) == data_source.name
 
@@ -30,8 +32,10 @@ def test_file_data_source(
     """
     Test create of FileDataSource.
     """
+    # Arrange, Act
     path = test_data_path(schema)
     data_source = FileDataSource(path)
 
+    # Assert
     assert path.stat().st_size == data_source.nbytes
     assert path.name == data_source.name

tests/test_common_cram.py

@@ -31,8 +31,11 @@ def test_get_challenge_response(
         - challenge is the CRAM challenge, this is salt for the hash.
 
     """
+    # Arrange, Act
     response = cram.get_challenge_response(
         challenge=challenge,
         key=key,
     )
+
+    # Assert
     assert response == expected

tests/test_common_enums.py

@@ -52,8 +52,9 @@ def test_int_enum_string_coercion(enum_type: type[Enum]) -> None:
     See: databento.common.enums.coercible
 
     """
-    for enum in enum_type:
-        assert enum == enum_type(str(enum.value))
+    # Arrange, Act, Assert
+    for variant in enum_type:
+        assert variant == enum_type(str(variant.value))
         with pytest.raises(ValueError):
             enum_type("NaN")  # sanity
 
@@ -69,6 +70,7 @@ def test_str_enum_case_coercion(enum_type: type[Enum]) -> None:
     See: databento.common.enums.coercible
 
     """
+    # Arrange, Act, Assert
     for enum in enum_type:
         assert enum == enum_type(enum.value.lower())
         assert enum == enum_type(enum.value.upper())
@@ -88,11 +90,13 @@ def test_enum_name_coercion(enum_type: type[Enum]) -> None:
     See: databento.common.enums.coercible
 
     """
+    # Arrange, Act
     if enum_type in (Compression, Encoding, Schema, SType):
         enum_it = iter(enum_type.variants())  # type: ignore [attr-defined]
     else:
         enum_it = iter(enum_type)
 
+    # Assert
     for enum in enum_it:
         assert enum == enum_type(enum.name)
         assert enum == enum_type(enum.name.replace("_", "-"))
@@ -113,9 +117,11 @@ def test_enum_none_not_coercible(enum_type: type[Enum]) -> None:
     See: databento.common.enum.coercible
 
     """
+    # Arrange, Act
     if enum_type == Compression:
         enum_type(None)
     else:
+        # Assert
         with pytest.raises(ValueError):
             enum_type(None)
 
@@ -131,8 +137,11 @@ def test_int_enum_stringy_mixin(enum_type: type[Enum]) -> None:
     See: databento.common.enum.StringyMixin
 
     """
+    # Arrange, Act
     if not issubclass(enum_type, StringyMixin):
         pytest.skip(f"{type(enum_type)} is not a subclass of StringyMixin")
+
+    # Assert
     for enum in enum_type:
         assert str(enum) == enum.name.lower()
 
@@ -148,8 +157,11 @@ def test_str_enum_stringy_mixin(enum_type: type[Enum]) -> None:
     See: databento.common.enum.StringyMixin
 
     """
+    # Arrange, Act
     if not issubclass(enum_type, StringyMixin):
         pytest.skip(f"{type(enum_type)} is not a subclass of StringyMixin")
+
+    # Assert
     for enum in enum_type:
         assert str(enum) == enum.value
 
@@ -162,8 +174,11 @@ def test_int_flags_stringy_mixin(enum_type: type[Flag]) -> None:
     """
     Test that combinations of int flags are displayed properly.
     """
+    # Arrange, Act
     for value in map(sum, combinations(enum_type, 2)):  # type: ignore [arg-type]
         record_flags = enum_type(value)
+
+        # Assert
         assert str(record_flags) == ", ".join(
             f.name.lower() for f in enum_type if f in record_flags
         )

tests/test_common_iterator.py

@@ -29,5 +29,6 @@ def test_chunk(
     """
     Test that an iterable is chunked property.
     """
+    # Arrange, Act, Assert
     chunks = [chunk for chunk in iterator.chunk(things, size)]
     assert chunks == expected

tests/test_common_parsing.py

@@ -115,6 +115,7 @@ def test_optional_symbols_list_to_list_int(
     If integers are given for a different SType we expect a ValueError.
 
     """
+    # Arrange, Act, Assert
     if isinstance(expected, list):
         assert optional_symbols_list_to_list(symbols, stype) == expected
     else:
@@ -160,6 +161,7 @@ def test_optional_symbols_list_to_list_numpy(
     If integers are given for a different SType we expect a ValueError.
 
     """
+    # Arrange, Act, Assert
     if isinstance(expected, list):
         assert optional_symbols_list_to_list(symbols, stype) == expected
     else:
@@ -195,6 +197,7 @@ def test_optional_symbols_list_to_list_raw_symbol(
     """
     Test that str are allowed for SType.RAW_SYMBOL.
     """
+    # Arrange, Act, Assert
     if isinstance(expected, list):
         assert optional_symbols_list_to_list(symbols, stype) == expected
     else:
@@ -267,4 +270,5 @@ def test_datetime_to_unix_nanoseconds(
     """
     Test that various inputs for times convert to unix nanoseconds.
     """
+    # Arrange, Act, Assert
     assert optional_datetime_to_unix_nanoseconds(value) == expected