more usage notes

test for param default value
spotify · Dec 22, 2019 · 22dc6be · 22dc6be
1 parent e25ecb3
commit 22dc6be
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/luigi/parameter.py b/luigi/parameter.py
@@ -895,7 +895,9 @@ def serialize(self, e):
 
 class EnumListParameter(Parameter):
     """
-    A parameter whose value is a comma-separated list of :class:`~enum.Enum`.
+    A parameter whose value is a comma-separated list of :class:`~enum.Enum`. Values should come from the same enum.
+
+    Values are taken to be a list, i.e. order is preserved, duplicates may occur, and empty list is possible.
 
     In the task definition, use
 

diff --git a/test/parameter_test.py b/test/parameter_test.py
@@ -458,6 +458,11 @@ class Foo(luigi.Task):
         p = luigi.parameter.EnumListParameter(enum=MyEnum)
         self.assertEqual(hash(Foo(args=(MyEnum.A, MyEnum.C)).args), hash(p.parse('A,C')))
 
+        class FooWithDefault(luigi.Task):
+            args = luigi.parameter.EnumListParameter(enum=MyEnum, default=[MyEnum.C])
+
+        self.assertEqual(FooWithDefault().args, p.parse('C'))
+
     def test_dict(self):
         class Foo(luigi.Task):
             args = luigi.parameter.DictParameter()