diff --git a/luigi/task.py b/luigi/task.py index e582442608..507431bcc2 100644 --- a/luigi/task.py +++ b/luigi/task.py @@ -394,8 +394,15 @@ def batch_param_names(cls): return [name for name, p in cls.get_params() if p._is_batchable()] @classmethod - def get_param_names(cls, include_significant=False): - return [name for name, p in cls.get_params() if include_significant or p.significant] + def get_param_names(cls, include_insignificant=False, include_significant=None): + if include_significant is not None: + warnings.warn( + "The `include_significant` parameter in `Task.get_param_names` is deprecated, use `include_insignificant` instead.", + DeprecationWarning, + stacklevel=2, + ) + include_insignificant = include_significant + return [name for name, p in cls.get_params() if include_insignificant or p.significant] @classmethod def get_param_values(cls, params, args, kwargs): diff --git a/test/task_test.py b/test/task_test.py index 350d9557d9..b43f23b5ed 100644 --- a/test/task_test.py +++ b/test/task_test.py @@ -75,6 +75,24 @@ def test_task_missing_necessary_param(self): with self.assertRaises(luigi.parameter.MissingParameterException): DefaultInsignificantParamTask.from_str_params({}) + def test_get_param_names(self): + significant_names = DummyTask.get_param_names() + self.assertNotIn("insignificant_param", significant_names) + self.assertIn("param", significant_names) + self.assertIn("int_param", significant_names) + + all_names = DummyTask.get_param_names(include_insignificant=True) + self.assertIn("insignificant_param", all_names) + self.assertIn("param", all_names) + self.assertEqual(len(all_names), len(significant_names) + 1) + + def test_get_param_names_deprecated_include_significant(self): + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter("always") + all_names = DummyTask.get_param_names(include_significant=True) + self.assertIn("insignificant_param", all_names) + self.assertTrue(any(issubclass(warn.category, DeprecationWarning) for warn in w)) + def test_external_tasks_loadable(self): task = load_task("luigi", "ExternalTask", {}) self.assertTrue(isinstance(task, luigi.ExternalTask))