Finalized LPL refactorer for variadic args and kwargs #387

Author: tbrar06

tests/refactorers/test_long_parameter_list_refactor.py

@@ -144,11 +144,6 @@ def __init__(self, data_params, config_params):
     refactorer.refactor(test_file, test_dir, smell, test_file)
 
     modified_code = test_file.read_text()
-    print("***************************************")
-    print(modified_code.strip())
-    print("***************************************")
-    print(expected_modified_code.strip())
-    print("***************************************")
     assert modified_code.strip() == expected_modified_code.strip()
 
     # cleanup after test
@@ -306,11 +301,6 @@ def generate_report_partial(data_params, config_params):
     refactorer.refactor(test_file, test_dir, smell, test_file)
 
     modified_code = test_file.read_text()
-    print("***************************************")
-    print(modified_code.strip())
-    print("***************************************")
-    print(expected_modified_code.strip())
-    print("***************************************")
     assert modified_code.strip() == expected_modified_code.strip()
 
     # cleanup after test
@@ -410,7 +400,6 @@ def create_partial_report(user_id, username):
     refactorer.refactor(test_file, test_dir, smell, test_file)
 
     modified_code = test_file.read_text()
-    print(modified_code.strip())
     assert modified_code.strip() == expected_modified_code.strip()
 
 
@@ -624,3 +613,195 @@ def process_data(self, data_params, config_params):
     # cleanup after test
     test_file.unlink()
     test_dir.rmdir()
+
+
+def test_lpl_with_args_kwargs(refactorer, source_files):
+    """Test for function with *args and **kwargs"""
+
+    test_dir = source_files / "temp_test_lpl"
+    test_dir.mkdir(parents=True, exist_ok=True)
+
+    test_file = test_dir / "fake.py"
+
+    code = textwrap.dedent("""\
+    def process_data(user_id, username, email, preferences, timezone_config, language, notification_settings, *args, **kwargs):
+        report = {}
+        # Use all regular parameters
+        report.user_id = user_id
+        report.username = username
+        report.email = email
+        report.preferences = preferences
+        report.timezone = timezone_config
+        report.language = language
+        report.notifications = notification_settings
+
+        # Use *args
+        for arg in args:
+            report.setdefault("extra_data", []).append(arg)
+
+        # Use **kwargs
+        for key, value in kwargs.items():
+            report[key] = value
+
+        return report
+
+    # Test call with various argument types
+    result = process_data(
+        2,
+        "janedoe",
+        "[email protected]",
+        {"theme": "light"},
+        "PST",
+        "en",
+        False,
+        "extra1",
+        "extra2",
+        custom_field="custom_value",
+        another_field=123
+    )
+    """)
+
+    expected_modified_code = textwrap.dedent("""\
+    class DataParams_process_data_1:
+        def __init__(self, user_id, username, email, preferences, language):
+            self.user_id = user_id
+            self.username = username
+            self.email = email
+            self.preferences = preferences
+            self.language = language
+    class ConfigParams_process_data_1:
+        def __init__(self, timezone_config, notification_settings):
+            self.timezone_config = timezone_config
+            self.notification_settings = notification_settings
+    def process_data(data_params, config_params, *args, **kwargs):
+        report = {}
+        # Use all regular parameters
+        report.user_id = data_params.user_id
+        report.username = data_params.username
+        report.email = data_params.email
+        report.preferences = data_params.preferences
+        report.timezone = config_params.timezone_config
+        report.language = data_params.language
+        report.notifications = config_params.notification_settings
+
+        # Use *args
+        for arg in args:
+            report.setdefault("extra_data", []).append(arg)
+
+        # Use **kwargs
+        for key, value in kwargs.items():
+            report[key] = value
+
+        return report
+
+    # Test call with various argument types
+    result = process_data(
+        DataParams_process_data_1(2, "janedoe", "[email protected]", {"theme": "light"}, "en"), ConfigParams_process_data_1("PST", False), "extra1", "extra2", custom_field = "custom_value", another_field = 123)""")
+    test_file.write_text(code)
+    smell = create_smell([1])()
+    refactorer.refactor(test_file, test_dir, smell, test_file)
+
+    modified_code = test_file.read_text()
+    assert modified_code.strip() == expected_modified_code.strip()
+
+    # cleanup after test
+    test_file.unlink()
+    test_dir.rmdir()
+
+
+def test_lpl_with_kwargs_only(refactorer, source_files):
+    """Test for function with **kwargs"""
+
+    test_dir = source_files / "temp_test_lpl"
+    test_dir.mkdir(parents=True, exist_ok=True)
+
+    test_file = test_dir / "fake.py"
+
+    code = textwrap.dedent("""\
+    def process_data_2(user_id, username, email, preferences, timezone_config, language, notification_settings, **kwargs):
+        report = {}
+        # Use all regular parameters
+        report.user_id = user_id
+        report.username = username
+        report.email = email
+        report.preferences.update(preferences)
+        report.timezone = timezone_config
+        report.language = language
+        report.notifications = notification_settings
+
+        # Use **kwargs
+        for key, value in kwargs.items():
+            report[key] = value  # kwargs used
+
+        # Additional processing using the parameters
+        if notification_settings:
+            report.timezone = f"{timezone_config}_notified"
+
+        if "theme" in preferences:
+            report.language = f"{language}_{preferences['theme']}"
+
+        return report
+
+    # Test call with various argument types
+    result = process_data_2(
+        2,
+        "janedoe",
+        "[email protected]",
+        {"theme": "light"},
+        "PST",
+        "en",
+        False,
+        custom_field="custom_value",
+        another_field=123
+    )
+    """)
+
+    expected_modified_code = textwrap.dedent("""\
+    class DataParams_process_data_2_1:
+        def __init__(self, user_id, username, email, preferences, language):
+            self.user_id = user_id
+            self.username = username
+            self.email = email
+            self.preferences = preferences
+            self.language = language
+    class ConfigParams_process_data_2_1:
+        def __init__(self, timezone_config, notification_settings):
+            self.timezone_config = timezone_config
+            self.notification_settings = notification_settings
+    def process_data_2(data_params, config_params, **kwargs):
+        report = {}
+        # Use all regular parameters
+        report.user_id = data_params.user_id
+        report.username = data_params.username
+        report.email = data_params.email
+        report.preferences.update(data_params.preferences)
+        report.timezone = config_params.timezone_config
+        report.language = data_params.language
+        report.notifications = config_params.notification_settings
+
+        # Use **kwargs
+        for key, value in kwargs.items():
+            report[key] = value  # kwargs used
+
+        # Additional processing using the parameters
+        if config_params.notification_settings:
+            report.timezone = f"{config_params.timezone_config}_notified"
+
+        if "theme" in data_params.preferences:
+            report.language = f"{data_params.language}_{data_params.preferences['theme']}"
+
+        return report
+
+    # Test call with various argument types
+    result = process_data_2(
+        DataParams_process_data_2_1(2, "janedoe", "[email protected]", {"theme": "light"}, "en"), ConfigParams_process_data_2_1("PST", False), custom_field = "custom_value", another_field = 123)""")
+    test_file.write_text(code)
+    smell = create_smell([1])()
+    refactorer.refactor(test_file, test_dir, smell, test_file)
+
+    modified_code = test_file.read_text()
+    assert modified_code.strip() == expected_modified_code.strip()
+
+    # cleanup after test
+    test_file.unlink()
+    test_dir.rmdir()