Merge pull request #117 from JuliaAI/dev

For a 1.3.1 release

Author: ablaom

Project.toml

@@ -1,7 +1,7 @@
 name = "MLJModelInterface"
 uuid = "e80e1ace-859a-464e-9ed9-23947d8ae3ea"
 authors = ["Thibaut Lienart and Anthony Blaom"]
-version = "1.3.0"
+version = "1.3.1"
 
 [deps]
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

src/equality.jl

@@ -1,3 +1,12 @@
+# to ensure that propertynames that aren't fieldnames are always viewed as
+# "defined", in MLJType objects. See #115.
+function _isdefined(object, name)
+    pnames = propertynames(object)
+    fnames = fieldnames(typeof(object))
+    name in pnames && !(name in fnames) && return true
+    isdefined(object, name)
+end
+
 function _equal_to_depth_one(x1, x2)
     names = propertynames(x1)
     names === propertynames(x2) || return false
@@ -68,7 +77,8 @@ following conditions all hold, and `false` otherwise:
 
 - with the exception of properties listed as `exceptions` or bound to
   an `AbstractRNG`, each pair of corresponding property values is
-  either "equal" or  both undefined.
+  either "equal" or both undefined. (If a property appears as a
+  `propertyname` but not a `fieldname`, it is deemed as always defined.)
 
 The meaining of "equal" depends on the type of the property value:
 
@@ -93,9 +103,9 @@ function is_same_except(m1::M1,
 
     for name in names
         if !(name in exceptions)
-            if !isdefined(m1, name)
-               !isdefined(m2, name) || return false
-            elseif isdefined(m2, name)
+            if !_isdefined(m1, name)
+               !_isdefined(m2, name) || return false
+            elseif _isdefined(m2, name)
                 if name in deep_properties(M1)
                     _equal_to_depth_one(getproperty(m1,name),
                                         getproperty(m2, name)) || return false

test/equality.jl

@@ -27,6 +27,16 @@ function Base.getproperty(b::Bar{names}, name::Symbol) where names
     name === names[1] && return v[1]
     return v[2]
 end
+function Base.setproperty!(b::Bar{names}, name::Symbol, value) where names
+    name === :rng && return setfield!(b, :rng, value)
+    v = getfield(b, :v)
+    if name === names[1]
+        setfield!(b, :v, (value, v[2]))
+        return value
+    end
+    setfield!(b, :v, (v[1], value))
+    value
+end
 
 mutable struct Super <: MLJType
     sub::Foo
@@ -53,8 +63,15 @@ mutable struct Super2 <: MLJType
     z::Int
 end
 
+
 MLJModelInterface.deep_properties(::Type{<:Super2}) = (:sub,)
 
+@testset "_isdefined" begin
+    b = Bar(MersenneTwister(), 2, 3)
+    @test MLJModelInterface._isdefined(b, :x)
+end
+
+
 @testset "_equal_to_depth_one" begin
     d1 = Deep(1, 2)
     d2 = Deep(1, 2)
@@ -108,6 +125,11 @@ end
     s2 = Super2(Sub(1), 2)
     @test s1 == s2
 
+    # replacing value of a "strap-on" property is detected:
+    b = Bar(MersenneTwister(), 1, 2)
+    b1 = deepcopy(b)
+    b.x = 42
+    @test b != b1
 end
 
 @testset "in(x, collection) for MLJType" begin