Add Optional trait type as shorthand for Union(None, ...)

Author: k2bd

traits/api.py

@@ -103,6 +103,7 @@
     ToolbarButton,
     Either,
     Union,
+    Optional,
     Type,
     Subclass,
     Symbol,

traits/tests/test_constant.py

@@ -72,3 +72,19 @@ class TestClass(HasTraits):
 
         # Check directly that both refer to the same object.
         self.assertIs(obj1.c_atr, obj2.c_atr)
+
+    @unittest.expectedFailure
+    def test_constant_validator(self):
+        """
+        XFAIL: `validate` on constant does not reject new values.
+
+        See enthought/traits#1784
+        """
+        class TestClass(HasTraits):
+            attribute = Constant(123)
+
+        a = TestClass()
+        const_trait = a.traits()["attribute"]
+
+        with self.assertRaises(TraitError):
+            const_trait.validate(a, "attribute", 456)

traits/tests/test_optional.py

@@ -0,0 +1,265 @@
+# (C) Copyright 2005-2024 Enthought, Inc., Austin, TX
+# All rights reserved.
+#
+# This software is provided without warranty under the terms of the BSD
+# license included in LICENSE.txt and may be redistributed only under
+# the conditions described in the aforementioned license. The license
+# is also available online at http://www.enthought.com/licenses/BSD.txt
+#
+# Thanks for using Enthought open source!
+
+import unittest
+
+from traits.api import (
+    Bytes,
+    DefaultValue,
+    Float,
+    HasTraits,
+    Instance,
+    Int,
+    List,
+    Str,
+    TraitError,
+    TraitType,
+    Type,
+    Optional,
+    Constant,
+)
+from traits.trait_types import _NoneTrait
+
+
+class CustomClass(HasTraits):
+    value = Int
+
+
+class CustomStrType(TraitType):
+
+    #: The default value type to use.
+    default_value_type = DefaultValue.constant
+
+    #: The default value.
+    default_value = "a string value"
+
+    def validate(self, obj, name, value):
+        if not isinstance(value, Str):
+            return value
+        self.error(obj, name, value)
+
+
+class TestOptional(unittest.TestCase):
+
+    def test_optional_basic(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Int)
+
+        TestClass(attribute=None)
+        TestClass(attribute=3)
+
+        self.assertIsNone(TestClass(attribute=None).attribute)
+        self.assertEqual(TestClass(attribute=3).attribute, 3)
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute="3")
+
+    def test_optional_list(self):
+        class TestClass(HasTraits):
+            attribute = Optional(List(Int))
+
+        TestClass(attribute=None)
+        TestClass(attribute=[1, 2, 3])
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute=3)
+
+    def test_optional_instance(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Instance(Int))
+
+        TestClass(attribute=None)
+        TestClass(attribute=Int(3))
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute=3)
+        with self.assertRaises(TraitError):
+            TestClass(attribute=Int)
+
+    def test_optional_instance_custom_class(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Instance(CustomClass))
+
+        TestClass(attribute=None)
+        TestClass(attribute=CustomClass(value=5))
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute=5)
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute=CustomClass)
+
+        self.assertEqual(
+            TestClass(attribute=CustomClass(value=5)).attribute.value, 5
+        )
+
+        self.assertIsNone(TestClass().attribute)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+    def test_optional_user_defined_type(self):
+        class TestClass(HasTraits):
+            attribute = Optional(CustomStrType)
+
+        a = TestClass(attribute="my value")
+        self.assertEqual(a.attribute, "my value")
+
+        b = TestClass()
+        self.assertIsNone(b.attribute)
+
+        c = TestClass(attribute=3)
+        self.assertEqual(c.attribute, 3)
+
+    def test_optional_instance_with_implicit_default_value(self):
+        """
+        Implicit default is always ``None``
+        """
+
+        class TestClass(HasTraits):
+            attribute = Optional(Int)
+
+        self.assertIsNone(TestClass().attribute)
+        self.assertEqual(TestClass(attribute=3).attribute, 3)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+    def test_optional_instance_with_metadata_default_value(self):
+        """
+        Setting the ``default_value`` at trait-level sets the default value
+        """
+
+        class TestClass(HasTraits):
+            attribute = Optional(Int, default_value=5)
+
+        self.assertEqual(TestClass().attribute, 5)
+        self.assertEqual(TestClass(attribute=3).attribute, 3)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+    def test_optional_instance_with_type_default_value(self):
+        """
+        Setting the ``default_value`` of the inner trait does not set the
+        default value of the ``Optional``
+        """
+        # Note: may want to warn in this case
+        # Discussion ref: enthought/traits#1298
+
+        class TestClass(HasTraits):
+            attribute = Optional(Int(5))
+
+        self.assertIsNone(TestClass().attribute)
+        self.assertEqual(TestClass(attribute=3).attribute, 3)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+    def test_optional_invalid_trait(self):
+        with self.assertRaises(ValueError) as e:
+
+            class _TestClass(HasTraits):
+                attribute = Optional(123)
+
+        self.assertEqual(
+            str(e.exception),
+            "Optional trait declaration expects a trait type or an instance "
+            "of trait type or None, but got 123 instead",
+        )
+
+    def test_optional_of_none(self):
+        with self.assertRaises(TraitError) as e:
+
+            class _TestClass(HasTraits):
+                attribute = Optional(None)
+
+        self.assertEqual(str(e.exception), "Optional type must not be None.")
+
+    def test_optional_unspecified_arguments(self):
+        with self.assertRaises(TypeError) as e:
+
+            class TestClass(HasTraits):
+                none = Optional()
+
+        self.assertIn(
+            "missing 1 required positional argument", str(e.exception)
+        )
+
+    def test_optional_multiple_type_arguments(self):
+        with self.assertRaises(TypeError):
+
+            class TestClass(HasTraits):
+                attribute = Optional(Int, Float)
+
+    def test_optional_default_raise_error(self):
+        """
+        Behaviour inherited from ``Union``
+        """
+        with self.assertRaises(ValueError) as e:
+
+            class TestClass(HasTraits):
+                attribute = Optional(Int(), default=5)
+
+        self.assertEqual(
+            str(e.exception),
+            "Optional default value should be set via 'default_value', not "
+            "'default'.",
+        )
+
+    def test_optional_inner_traits(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Int(3))
+
+        obj = TestClass()
+        t1, t2 = obj.trait("attribute").inner_traits
+
+        self.assertEqual(type(t1.trait_type), _NoneTrait)
+        self.assertEqual(t1.default_value(), (DefaultValue.constant, None))
+        self.assertEqual(type(t2.trait_type), Int)
+        self.assertEqual(t2.default_value(), (DefaultValue.constant, 3))
+
+    def test_optional_notification(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Int)
+            shadow_attribute = None
+
+            def _attribute_changed(self, new):
+                self.shadow_attribute = new
+
+        obj = TestClass(attribute=3)
+
+        obj.attribute = 5
+        self.assertEqual(obj.shadow_attribute, 5)
+
+        obj.attribute = None
+        self.assertIsNone(obj.shadow_attribute)
+
+    def test_optional_extend_trait(self):
+        class OptionalOrStr(Optional):
+            def validate(self, obj, name, value):
+                if isinstance(value, str):
+                    return value
+                return super().validate(obj, name, value)
+
+        class TestClass(HasTraits):
+            attribute = OptionalOrStr(Int)
+
+        self.assertEqual(TestClass(attribute=123).attribute, 123)
+        self.assertEqual(TestClass(attribute="abc").attribute, "abc")
+        self.assertIsNone(TestClass(attribute=None).attribute)
+        self.assertIsNone(TestClass().attribute)
+
+        with self.assertRaises(TraitError):
+            TestClass(attribute=1.23)
+
+    @unittest.expectedFailure  # See enthought/traits#1784
+    def test_optional_constant(self):
+        class TestClass(HasTraits):
+            attribute = Optional(Constant(123))
+
+        self.assertEqual(TestClass(attribute=123).attribute, 123)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+        # Fails here - internal trait validation fails
+        with self.assertRaises(TraitError):
+            TestClass(attribute=124)

traits/tests/test_union.py

@@ -12,7 +12,7 @@
 
 from traits.api import (
     Bytes, DefaultValue, Float, HasTraits, Instance, Int, List, Str,
-    TraitError, TraitType, Type, Union)
+    TraitError, TraitType, Type, Union, Constant)
 
 
 class CustomClass(HasTraits):
@@ -133,6 +133,20 @@ def test_default_raise_error(self):
             "'default'."
         )
 
+    def test_default_raise_error_subclass(self):
+        # Name used in error message inherited by subclass
+        class TestUnion(Union):
+            pass
+
+        with self.assertRaises(ValueError) as exception_context:
+            TestUnion(Int(), Float(), default=1.0)
+
+        self.assertEqual(
+            str(exception_context.exception),
+            "TestUnion default value should be set via 'default_value', not "
+            "'default'."
+        )
+
     def test_inner_traits(self):
         class TestClass(HasTraits):
             atr = Union(Float, Int, Str)
@@ -214,3 +228,15 @@ class HasUnionWithList(HasTraits):
             has_union.trait("nested").default_value(),
             (DefaultValue.constant, ""),
         )
+
+    @unittest.expectedFailure  # See enthought/traits#1784
+    def test_union_constant(self):
+        class TestClass(HasTraits):
+            attribute = Union(None, Constant(123))
+
+        self.assertEqual(TestClass(attribute=123).attribute, 123)
+        self.assertIsNone(TestClass(attribute=None).attribute)
+
+        # Fails here - internal trait validation fails
+        with self.assertRaises(TraitError):
+            TestClass(attribute=124)