Refactor test.parameter test cases using BG standard

Author: bobleesj

tests/test_diffraction_objects.py

@@ -38,7 +38,8 @@
             True,
             False,
         ),
-        (  # Different names, expect inequality
+        # Different names, expect inequality
+        (
             {
                 "name": "something",
                 "xtype": "tth",
@@ -56,7 +57,8 @@
             False,
             True,
         ),
-        (  # C2: One without wavelength, expect inequality
+        # C2: One without wavelength, expect inequality
+        (
             {
                 "wavelength": 0.71,
                 "xtype": "tth",
@@ -73,7 +75,8 @@
             False,
             True,
         ),
-        (  # C3: Different wavelength values, expect inequality
+        # C3: Different wavelength values, expect inequality
+        (
             {
                 "wavelength": 0.71,
                 "xtype": "tth",
@@ -91,7 +94,8 @@
             False,
             False,
         ),
-        (  # C4: Different scat_quantity, expect inequality
+        # C4: Different scat_quantity, expect inequality
+        (
             {
                 "scat_quantity": "x-ray",
                 "xtype": "tth",
@@ -109,7 +113,8 @@
             False,
             True,
         ),
-        (  # C5: Different q xarray values, expect inequality
+        # C5: Different q xarray values, expect inequality
+        (
             {
                 "xtype": "q",
                 "xarray": np.array([1.0, 2.0]),
@@ -124,7 +129,8 @@
             False,
             True,
         ),
-        (  # C6: Different metadata, expect inequality
+        # C6: Different metadata, expect inequality
+        (
             {
                 "xtype": "q",
                 "xarray": np.empty(0),
@@ -358,22 +364,84 @@ def test_scale_to_bad(org_do_args, target_do_args, scale_inputs):
 
 
 @pytest.mark.parametrize(
-    "wavelength, xarray, yarray, xtype_1, xtype_2, value, expected_index",
+    "do_args, get_array_index_inputs, expected_index",
     [
-        # Test whether get_array_index() returns the expected index
-        # C1: Exact match
-        (4 * np.pi, np.array([30.005, 60]), np.array([1, 2]), "tth", "tth", 30.005, [0]),
-        # C2: Target value lies in the array, returns the (first) closest index
-        (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "tth", 45, [0]),
-        (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "q", 0.25, [0]),
-        # C3: Target value out of the range, returns the closest index
-        (4 * np.pi, np.array([0.25, 0.5, 0.71]), np.array([1, 2, 3]), "q", "q", 0.1, [0]),
-        (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "tth", 63, [1]),
+        # Test get_array_index() returns the expected index given xtype and value
+        # C1: Target value is in the xarray and xtype is identical, expect exact index match
+        (
+            {
+                "wavelength": 4 * np.pi,
+                "xarray": np.array([30.005, 60]),
+                "yarray": np.array([1, 2]),
+                "xtype": "tth",
+            },
+            {
+                "xtype": "tth",
+                "value": 30.005,
+            },
+            [0],
+        ),
+        # C2: Target value lies in the array, expect the (first) closest index
+        (
+            {
+                "wavelength": 4 * np.pi,
+                "xarray": np.array([30, 60]),
+                "yarray": np.array([1, 2]),
+                "xtype": "tth",
+            },
+            {
+                "xtype": "tth",
+                "value": 45,
+            },
+            [0],
+        ),
+        (
+            {
+                "wavelength": 4 * np.pi,
+                "xarray": np.array([30, 60]),
+                "yarray": np.array([1, 2]),
+                "xtype": "tth",
+            },
+            {
+                "xtype": "q",
+                "value": 0.25,
+            },
+            [0],
+        ),
+        # C3: Target value out of the range, expect the closest index
+        # 1. Test with xtype of "q"
+        (
+            {
+                "wavelength": 4 * np.pi,
+                "xarray": np.array([0.25, 0.5, 0.71]),
+                "yarray": np.array([1, 2, 3]),
+                "xtype": "q",
+            },
+            {
+                "xtype": "q",
+                "value": 0.1,
+            },
+            [0],
+        ),
+        # 2. Test with xtype of "tth"
+        (
+            {
+                "wavelength": 4 * np.pi,
+                "xarray": np.array([30, 60]),
+                "yarray": np.array([1, 2]),
+                "xtype": "tth",
+            },
+            {
+                "xtype": "tth",
+                "value": 63,
+            },
+            [1],
+        ),
     ],
 )
-def test_get_array_index(wavelength, xarray, yarray, xtype_1, xtype_2, value, expected_index):
-    do = DiffractionObject(wavelength=wavelength, xarray=xarray, yarray=yarray, xtype=xtype_1)
-    actual_index = do.get_array_index(value=value, xtype=xtype_2)
+def test_get_array_index(do_args, get_array_index_inputs, expected_index):
+    do = DiffractionObject(**do_args)
+    actual_index = do.get_array_index(get_array_index_inputs["value"], get_array_index_inputs["xtype"])
     assert actual_index == expected_index
 
 
@@ -420,7 +488,9 @@ def test_dump(tmp_path, mocker):
 @pytest.mark.parametrize(
     "do_init_args, expected_do_dict, divide_by_zero_warning_expected",
     [
-        (  # Instantiate just array attributes
+        # Test __dict__ of DiffractionObject instance initialized with valid arguments
+        (
+            # C1: Minimum arguments provided for init, expect all attributes set without None
             {
                 "xarray": np.array([0.0, 90.0, 180.0]),
                 "yarray": np.array([1.0, 2.0, 3.0]),
@@ -449,7 +519,8 @@ def test_dump(tmp_path, mocker):
             },
             True,
         ),
-        (  # Instantiate just array attributes
+        # C2: Initialize with an optional scat_quantity argument, expect non-empty string for scat_quantity
+        (
             {
                 "xarray": np.array([np.inf, 2 * np.sqrt(2) * np.pi, 2 * np.pi]),
                 "yarray": np.array([1.0, 2.0, 3.0]),
@@ -496,11 +567,12 @@ def test_init_valid(do_init_args, expected_do_dict, divide_by_zero_warning_expec
 @pytest.mark.parametrize(
     "do_init_args, expected_error_msg",
     [
-        (  # C1: No arguments provided
+        # Test expected error messages due to required arguments in DiffractionObject constructor
+        (  # C1: No arguments provided, expect 3 required positional arguments error
             {},
             "missing 3 required positional arguments: 'xarray', 'yarray', and 'xtype'",
         ),
-        (  # C2: Only xarray and yarray provided
+        (  # C2: Only xarray and yarray provided, expect 1 required positional argument error
             {"xarray": np.array([0.0, 90.0]), "yarray": np.array([0.0, 90.0])},
             "missing 1 required positional argument: 'xtype'",
         ),
@@ -523,7 +595,6 @@ def test_all_array_getter(do_minimal_tth):
 
 def test_all_array_setter(do_minimal):
     do = do_minimal
-    # Attempt to directly modify the property
     with pytest.raises(
         AttributeError,
         match="Direct modification of attribute 'all_arrays' is not allowed. "