From 57030e826d7ac7147307a4fd3b8d87ed2c1f661a Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Thu, 25 Apr 2024 19:56:22 -0400 Subject: [PATCH 01/11] initial message improvements --- testing/local_testing/add_function.py | 1 - testing/local_testing/local_test_0.py | 10 +++++----- testing/local_testing/local_test_test.py | 17 ++++------------- 3 files changed, 9 insertions(+), 19 deletions(-) diff --git a/testing/local_testing/add_function.py b/testing/local_testing/add_function.py index 40bd7ec64..4693ad3cf 100644 --- a/testing/local_testing/add_function.py +++ b/testing/local_testing/add_function.py @@ -1,3 +1,2 @@ def add(a, b): return a + b - diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index 95dbd553c..76c079dea 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -1,16 +1,16 @@ import pytest -@pytest.mark.parametrize("arg1, arg2", [(1, 1)]) + +@pytest.mark.parametrize("arg1,arg2", [(1, 1)]) def test_parametrization(arg1, arg2): assert arg1 == arg2 assert arg1 + 1 == arg2 + 1 # Gets the error: In test_parametrization: indirect fixture '(1, 1)' doesn't exist -# Goal is to change this message into a more beginner friendly message. - +# Goal is to change this message into a more beginner friendly message. + # The error message lives in this path: pytest/src/_pytest/python.py - -#("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function \ No newline at end of file +# ("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index a677697bf..aeb361f67 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -1,22 +1,13 @@ # test_math_operations.py -import pytest import add_function +import pytest + + +result_index = [(1, 2, 3), (-1, 1, 0), (0, 0, 0), (5, -3, 2), (1, 1, 2)] -result_index = [ - (1, 2, 3), - (-1, 1, 0), - (0, 0, 0), - (5, -3, 2), - (1, 1, 2) -] @pytest.mark.parametrize("a, b, expected_result", result_index) - - def test_add(a, b, expected_result): assert add_function.add(a, b) == expected_result - - - From ababe237fd4b09f502e86bec525545be68856c75 Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Thu, 25 Apr 2024 20:28:49 -0400 Subject: [PATCH 02/11] some changing up --- testing/local_testing/local_test_0.py | 11 +++++++---- testing/local_testing/local_test_test.py | 17 +++++++++++++---- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index 76c079dea..2234947c1 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -1,16 +1,19 @@ import pytest -@pytest.mark.parametrize("arg1,arg2", [(1, 1)]) + +@pytest.mark.parametrize("arg1", "arg2", [(1, 1)]) + def test_parametrization(arg1, arg2): assert arg1 == arg2 assert arg1 + 1 == arg2 + 1 # Gets the error: In test_parametrization: indirect fixture '(1, 1)' doesn't exist -# Goal is to change this message into a more beginner friendly message. - +# Goal is to change this message into a more beginner friendly message. + # The error message lives in this path: pytest/src/_pytest/python.py + -# ("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function +#("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function \ No newline at end of file diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index aeb361f67..a677697bf 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -1,13 +1,22 @@ # test_math_operations.py +import pytest import add_function -import pytest - - -result_index = [(1, 2, 3), (-1, 1, 0), (0, 0, 0), (5, -3, 2), (1, 1, 2)] +result_index = [ + (1, 2, 3), + (-1, 1, 0), + (0, 0, 0), + (5, -3, 2), + (1, 1, 2) +] @pytest.mark.parametrize("a, b, expected_result", result_index) + + def test_add(a, b, expected_result): assert add_function.add(a, b) == expected_result + + + From ac15d1ec1de48aed09e354cff806ff7388cf661b Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Thu, 25 Apr 2024 20:36:28 -0400 Subject: [PATCH 03/11] Added first part of error msg fixing to python.py file --- testing/local_testing/local_test_0.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index 2234947c1..faab77484 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -2,7 +2,7 @@ import pytest -@pytest.mark.parametrize("arg1", "arg2", [(1, 1)]) +@pytest.mark.parametrize("arg1, arg2", [(1, 1)]) def test_parametrization(arg1, arg2): assert arg1 == arg2 From 64ae653745500c2a1def4b7cb1d174b0c1af12d8 Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Fri, 26 Apr 2024 17:22:28 -0400 Subject: [PATCH 04/11] testing for 2 in quotes and one not --- testing/local_testing/local_test_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index a677697bf..e1003925f 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -12,7 +12,7 @@ result_index = [ (1, 1, 2) ] -@pytest.mark.parametrize("a, b, expected_result", result_index) +@pytest.mark.parametrize("a, b", "expected_result", result_index) def test_add(a, b, expected_result): From 6e5c56ce4bc526d32b00a11696bede1256f16104 Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Fri, 26 Apr 2024 17:29:02 -0400 Subject: [PATCH 05/11] made improvements to error message for basic --- testing/local_testing/local_test_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index e1003925f..e3e434294 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -12,7 +12,7 @@ result_index = [ (1, 1, 2) ] -@pytest.mark.parametrize("a, b", "expected_result", result_index) +@pytest.mark.parametrize("a", "b, expected_result", result_index) def test_add(a, b, expected_result): From 04b028a46e673f0f8cea3313a302fcb69a3b7381 Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Fri, 26 Apr 2024 17:34:21 -0400 Subject: [PATCH 06/11] final addition for comments --- testing/local_testing/local_test_0.py | 2 +- testing/local_testing/local_test_test.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index faab77484..218606208 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -2,7 +2,7 @@ import pytest -@pytest.mark.parametrize("arg1, arg2", [(1, 1)]) +@pytest.mark.parametrize("arg1,arg2", [(1, 1)]) def test_parametrization(arg1, arg2): assert arg1 == arg2 diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index e3e434294..72ca93062 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -12,7 +12,7 @@ result_index = [ (1, 1, 2) ] -@pytest.mark.parametrize("a", "b, expected_result", result_index) +@pytest.mark.parametrize("a, b,expected_result", result_index) def test_add(a, b, expected_result): From 005684e77b1b8daf03a882a678d610e0c9ddeb14 Mon Sep 17 00:00:00 2001 From: Sirui Huang Date: Sat, 27 Apr 2024 10:21:51 -0400 Subject: [PATCH 07/11] make linter happy --- testing/local_testing/add_function.py | 2 +- testing/local_testing/local_test_0.py | 9 +++------ testing/local_testing/local_test_test.py | 17 ++++------------- 3 files changed, 8 insertions(+), 20 deletions(-) diff --git a/testing/local_testing/add_function.py b/testing/local_testing/add_function.py index 4693ad3cf..e1829c359 100644 --- a/testing/local_testing/add_function.py +++ b/testing/local_testing/add_function.py @@ -1,2 +1,2 @@ -def add(a, b): +def add(a: int, b: int) -> int: return a + b diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index 218606208..76c079dea 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -1,19 +1,16 @@ import pytest - @pytest.mark.parametrize("arg1,arg2", [(1, 1)]) - def test_parametrization(arg1, arg2): assert arg1 == arg2 assert arg1 + 1 == arg2 + 1 # Gets the error: In test_parametrization: indirect fixture '(1, 1)' doesn't exist -# Goal is to change this message into a more beginner friendly message. - +# Goal is to change this message into a more beginner friendly message. + # The error message lives in this path: pytest/src/_pytest/python.py - -#("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function \ No newline at end of file +# ("arg1", "arg2"), and "arg1, arg2" works, but cannot put in default parameters as normal function diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index 72ca93062..23ac56060 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -1,22 +1,13 @@ # test_math_operations.py -import pytest import add_function +import pytest + + +result_index = [(1, 2, 3), (-1, 1, 0), (0, 0, 0), (5, -3, 2), (1, 1, 2)] -result_index = [ - (1, 2, 3), - (-1, 1, 0), - (0, 0, 0), - (5, -3, 2), - (1, 1, 2) -] @pytest.mark.parametrize("a, b,expected_result", result_index) - - def test_add(a, b, expected_result): assert add_function.add(a, b) == expected_result - - - From a4d8c1a0ee91877736cffbe169068da215f0b304 Mon Sep 17 00:00:00 2001 From: Chaeil Yun Date: Sat, 27 Apr 2024 12:29:55 -0400 Subject: [PATCH 08/11] Actual changes reflected --- src/.DS_Store | Bin 0 -> 6148 bytes src/_pytest/mark/structures.py | 27 +++++++++++++-------------- src/_pytest/python.py | 33 ++++++++++++++++++++++++++++++--- 3 files changed, 43 insertions(+), 17 deletions(-) create mode 100644 src/.DS_Store diff --git a/src/.DS_Store b/src/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..112d642aa19639f0cd6be99d8f939dae44b6a2c7 GIT binary patch literal 6148 zcmeHK%}T>S5T3QwrW7FuMUMfm1*?`q@e*o%0V8@)i3u$ljM>tp1}TMH^@V&BpU0Wq z4Ok6$6R|U}`_0bJZsvpR4*-b4Y;*u%1Av8%P>@m~WUh3rnP5Vp<`_c?S(vAjFs_*B zFPiAv8{oqPo*{!z-!DV-yoHlEO0!PqU98pW>l+QLVYRFq?_TC!7G$$@5KOOVbS`Ba zmU<9gMC07Iw@ze|1yM4ds)T4X#*pjFC>hCoAZN)aRk@yaSWTU7yKcCnQ0g-V%h4LDyiR5j`kE zry}Z9VV)R5r=#65ajwBaqfQ5*R>pbE%H`ulsMXQ#sBjRjM(&vbW?-3tnjYG8{-5G6 zQ~AhWPT>(VzzqB|21I@64F_11Ia|M#M`x{r?G_se#TBHWpuThozya+eyUMBk4(S-@ X8Z0!@EM!;dh)'" + f"\n\n" + f"Or if multiple parameters are used, separate them by commas. \n " + f"e.g., '@pytest.mark.parametrize(\"arg1, arg2\", )'", pytrace=False, ) arg_directness[arg] = "indirect" @@ -1415,6 +1439,9 @@ class Metafunc: ) return arg_directness + + + def _validate_if_using_arg_names( self, argnames: Sequence[str], From 3d04010d7060ed029fcd2ab7022801ab3032428c Mon Sep 17 00:00:00 2001 From: Sirui Huang Date: Sun, 28 Apr 2024 20:06:28 -0400 Subject: [PATCH 09/11] alter wrong parameterize arguement test --- src/_pytest/mark/structures.py | 26 +++++++++++------------- src/_pytest/python.py | 18 +++++++++++++++- testing/local_testing/local_test_0.py | 4 ++-- testing/local_testing/local_test_test.py | 2 +- testing/test_mark.py | 11 ++++++---- 5 files changed, 39 insertions(+), 22 deletions(-) diff --git a/src/_pytest/mark/structures.py b/src/_pytest/mark/structures.py index a6503bf1d..c2057e75d 100644 --- a/src/_pytest/mark/structures.py +++ b/src/_pytest/mark/structures.py @@ -165,22 +165,20 @@ class ParameterSet(NamedTuple): # Check all parameter sets have the correct number of values. for param in parameters: if len(param.values) != len(argnames): + # Construct a string representation of the expected parameter names + expected_argnames = ", ".join(argnames) + # Construct a string representation of the provided parameter values + provided_values = ", ".join(map(repr, param.values)) msg = ( - '{nodeid}: in "parametrize" the number of names ({names_len}):\n' - " {names}\n" - "must be equal to the number of values ({values_len}):\n" - " {values}" - ) - fail( - msg.format( - nodeid=nodeid, - values=param.values, - names=argnames, - names_len=len(argnames), - values_len=len(param.values), - ), - pytrace=False, + f'{nodeid}: \n\n Error in parameterization for test "{func.__name__}".\n ' + f"The number of specified parameters ({len(argnames)}) " + f"does not match the number of provided values ({len(param.values)}): {provided_values}. \n" + f" Please ensure that the correct number of parameter names " + f"({len(param.values)}) are separated by commas within quotes.\n\n" + f'Require more than parameter names: "{expected_argnames}"' ) + + fail(msg, pytrace=False) else: # Empty parameter set (likely computed at runtime): create a single # parameter set with NOTSET values, with the "empty parameter set" mark applied to it. diff --git a/src/_pytest/python.py b/src/_pytest/python.py index 5e059f2c4..de23f8026 100644 --- a/src/_pytest/python.py +++ b/src/_pytest/python.py @@ -1402,8 +1402,24 @@ class Metafunc: arg_directness = dict.fromkeys(argnames, "direct") for arg in indirect: if arg not in argnames: + # Construct a list of valid parameter names + valid_params = ", ".join([f'"{name}"' for name in argnames]) + + # Construct a string representing the expected number of parameters + expected_param_count = len(indirect[0]) + + # Construct a string representing the actual number of parameters provided + actual_param_count = len(argnames) + fail( - f"In {self.function.__name__}: indirect fixture '{arg}' doesn't exist", + f"In function {self.function.__name__}: {argnames} is not a valid parameter. " + f"Expected {expected_param_count} sub parameters, " + f"but only {actual_param_count} were provided. \n\n" + f"Make sure to pass parameter names as strings without quotes, separated by commas, \n " + f"e.g., '@pytest.mark.parametrize({valid_params}, )'" + f"\n\n" + f"Or if multiple parameters are used, separate them by commas. \n " + f"e.g., '@pytest.mark.parametrize(\"arg1, arg2\", )'", pytrace=False, ) arg_directness[arg] = "indirect" diff --git a/testing/local_testing/local_test_0.py b/testing/local_testing/local_test_0.py index 76c079dea..fbc477f15 100644 --- a/testing/local_testing/local_test_0.py +++ b/testing/local_testing/local_test_0.py @@ -1,8 +1,8 @@ import pytest -@pytest.mark.parametrize("arg1,arg2", [(1, 1)]) -def test_parametrization(arg1, arg2): +@pytest.mark.parametrize("arg1, arg2", [(1, 1)]) +def test_parametrization(arg1: int, arg2: int) -> None: assert arg1 == arg2 assert arg1 + 1 == arg2 + 1 diff --git a/testing/local_testing/local_test_test.py b/testing/local_testing/local_test_test.py index 23ac56060..cb1c534bd 100644 --- a/testing/local_testing/local_test_test.py +++ b/testing/local_testing/local_test_test.py @@ -9,5 +9,5 @@ result_index = [(1, 2, 3), (-1, 1, 0), (0, 0, 0), (5, -3, 2), (1, 1, 2)] @pytest.mark.parametrize("a, b,expected_result", result_index) -def test_add(a, b, expected_result): +def test_add(a: int, b: int, expected_result: int) -> None: assert add_function.add(a, b) == expected_result diff --git a/testing/test_mark.py b/testing/test_mark.py index 2896afa45..eefedf15e 100644 --- a/testing/test_mark.py +++ b/testing/test_mark.py @@ -419,10 +419,13 @@ def test_parametrized_collect_with_wrong_args(pytester: Pytester) -> None: result = pytester.runpytest(py_file) result.stdout.fnmatch_lines( [ - 'test_parametrized_collect_with_wrong_args.py::test_func: in "parametrize" the number of names (2):', - " ['foo', 'bar']", - "must be equal to the number of values (3):", - " (1, 2, 3)", + "test_parametrized_collect_with_wrong_args.py::test_func: ", + "", + ' Error in parameterization for test "test_func".', + " The number of specified parameters (2) does not match the number of provided values (3): 1, 2, 3. ", + " Please ensure that the correct number of parameter names (3) are separated by commas within quotes.", + "", + 'Require more than parameter names: "foo, bar"', ] ) From 938de1b623fd32be548300ee84d7595844d07018 Mon Sep 17 00:00:00 2001 From: Sirui Huang Date: Sun, 28 Apr 2024 20:44:49 -0400 Subject: [PATCH 10/11] add test case for wrong parameterization format --- testing/test_mark.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/testing/test_mark.py b/testing/test_mark.py index eefedf15e..46bbf58a7 100644 --- a/testing/test_mark.py +++ b/testing/test_mark.py @@ -404,6 +404,35 @@ def test_parametrized_collected_from_command_line(pytester: Pytester) -> None: rec.assertoutcome(passed=3) +def test_parametrized_collect_with_wrong_format(pytester: Pytester) -> None: + """Parametrized test argument format not intuitive + line issue#8593""" + py_file = pytester.makepyfile( + """ + import pytest + + @pytest.mark.parametrize("arg1", "arg2", [(1, 1)]) + def test_parametrization(arg1: int, arg2: int) -> None: + assert arg1 == arg2 + assert arg1 + 1 == arg2 + 1 + """ + ) + + result = pytester.runpytest(py_file) + result.stdout.fnmatch_lines( + [ + """In function test_parametrization: ['arg1'] is not a valid parameter. + Expected 2 sub parameters, but only 1 were provided. """, + "", + "Make sure to pass parameter names as strings without quotes, separated by commas, ", + " e.g., '@pytest.mark.parametrize(\"arg1\", )'", + "", + "Or if multiple parameters are used, separate them by commas. ", + " e.g., '@pytest.mark.parametrize(\"arg1, arg2\", )'", + ] + ) + + def test_parametrized_collect_with_wrong_args(pytester: Pytester) -> None: """Test collect parametrized func with wrong number of args.""" py_file = pytester.makepyfile( From 701e78b95665024a15144c4dccdf8f36429183c1 Mon Sep 17 00:00:00 2001 From: Sirui Huang Date: Sun, 28 Apr 2024 20:56:44 -0400 Subject: [PATCH 11/11] fix line length issue and modify test --- src/_pytest/python.py | 2 +- testing/test_mark.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/_pytest/python.py b/src/_pytest/python.py index 4f7313e6b..9238694c3 100644 --- a/src/_pytest/python.py +++ b/src/_pytest/python.py @@ -1419,7 +1419,7 @@ class Metafunc: actual_param_count = len(argnames) fail( - f"In function {self.function.__name__}: {argnames} is not a valid parameter. " + f"In function {self.function.__name__}: {argnames} is not a valid parameter. \n" f"Expected {expected_param_count} sub parameters, " f"but only {actual_param_count} were provided. \n\n" f"Make sure to pass parameter names as strings without quotes, separated by commas, \n " diff --git a/testing/test_mark.py b/testing/test_mark.py index 46bbf58a7..f9eee67cc 100644 --- a/testing/test_mark.py +++ b/testing/test_mark.py @@ -421,8 +421,8 @@ def test_parametrized_collect_with_wrong_format(pytester: Pytester) -> None: result = pytester.runpytest(py_file) result.stdout.fnmatch_lines( [ - """In function test_parametrization: ['arg1'] is not a valid parameter. - Expected 2 sub parameters, but only 1 were provided. """, + "In function test_parametrization: ['arg1'] is not a valid parameter. ", + "Expected 2 sub parameters, but only 1 were provided. ", "", "Make sure to pass parameter names as strings without quotes, separated by commas, ", " e.g., '@pytest.mark.parametrize(\"arg1\", )'",