Skip to content

fix issue 72 #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

fix issue 72 #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc5eda9
workaround issue 72
jw3126 Feb 22, 2023
8e31be2
make tests pass on julia v1.10-
jw3126 Feb 23, 2023
2405543
fix
jw3126 Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions src/ConstructionBase.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,26 +48,34 @@ getfields(x::NamedTuple) = x
getproperties(o::NamedTuple) = o
getproperties(o::Tuple) = o

const CAN_CHECK_PROPERTIES_ARE_FIELDS = VERSION < v"1.10-"

function is_propertynames_overloaded(T::Type)::Bool
which(propertynames, Tuple{T}).sig !== Tuple{typeof(propertynames), Any}
end

@generated function check_properties_are_fields(obj)
if is_propertynames_overloaded(obj)
return quote
T = typeof(obj)
msg = """
The function `Base.propertynames` was overloaded for type `$T`.
Please make sure the following methods are also overloaded for this type:
```julia
ConstructionBase.setproperties
ConstructionBase.getproperties # optional in VERSION >= julia v1.7
```
"""
error(msg)
if CAN_CHECK_PROPERTIES_ARE_FIELDS
@generated function check_properties_are_fields(obj)
if is_propertynames_overloaded(obj)
return quote
T = typeof(obj)
msg = """
The function `Base.propertynames` was overloaded for type `$T`.
Please make sure the following methods are also overloaded for this type:
```julia
ConstructionBase.setproperties
ConstructionBase.getproperties # optional in VERSION >= julia v1.7
```
"""
error(msg)
end
else
:(nothing)
end
else
:(nothing)
end
else
function check_properties_are_fields(obj)
nothing
end
end

Expand Down
34 changes: 18 additions & 16 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,25 +271,27 @@ Base.getproperty(obj::FieldProps, name::Symbol) = getproperty(getfield(obj, :com
x = FieldProps((a=1, b=:b))
@test constructorof(typeof(x)) === FieldProps
@test getfields(x) === (components=(a=1, b=:b),)
res = @test_throws ErrorException setproperties(x, c=0)
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
@test_throws ErrorException setproperties(x, components=(a=1,b=:b))
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
@test_throws ErrorException setproperties(x, a="aaa")
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
if ConstructionBase.CAN_CHECK_PROPERTIES_ARE_FIELDS
res = @test_throws ErrorException setproperties(x, c=0)
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
@test_throws ErrorException setproperties(x, components=(a=1,b=:b))
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
@test_throws ErrorException setproperties(x, a="aaa")
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
@test occursin("setproperties", msg)
@test occursin("FieldProps", msg)
end
# == FieldProps((a="aaa", b=:b)
if VERSION >= v"1.7"
@test getproperties(x) == (a=1, b=:b)
else
elseif ConstructionBase.CAN_CHECK_PROPERTIES_ARE_FIELDS
res = @test_throws ErrorException getproperties(x)
msg = sprint(showerror, res.value)
@test occursin("overload", msg)
Expand Down