Skip to content
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

Use property interface #95

Merged
merged 2 commits into from
Feb 20, 2019
Merged

Use property interface #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b59e0e9
Use getproperty/setproperty! in unpack/pack!
tkf Feb 19, 2019
7aca429
Use getproperty/propertynames in type2dict
tkf Feb 19, 2019
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
4 changes: 2 additions & 2 deletions docs/src/manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ Two definitions are included in the package to unpack a composite type/module
or a dictionary with Symbol or string keys:

```
@inline unpack{f}(x, ::Val{f}) = getfield(x, f)
@inline unpack{f}(x, ::Val{f}) = getproperty(x, f)
@inline unpack{k}(x::Associative{Symbol}, ::Val{k}) = x[k]
@inline unpack{S<:AbstractString,k}(x::Associative{S}, ::Val{k}) = x[string(k)]
```
Expand All @@ -243,7 +243,7 @@ Two definitions are included in the package to pack into a composite
type or into a dictionary with Symbol or string keys:

```
@inline pack!{f}(x, ::Val{f}, val) = setfield!(x, f, val)
@inline pack!{f}(x, ::Val{f}, val) = setproperty!(x, f, val)
@inline pack!{k}(x::Associative{Symbol}, ::Val{k}, val) = x[k]=val
@inline pack!{S<:AbstractString,k}(x::Associative{S}, ::Val{k}, val) = x[string(k)]=val
```
Expand Down
12 changes: 6 additions & 6 deletions src/Parameters.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ Dict{Symbol,Any} with 2 entries:
"""
function type2dict(dt)
di = Dict{Symbol,Any}()
for n in fieldnames(typeof(dt))
di[n] = getfield(dt, n)
for n in propertynames(dt)
di[n] = getproperty(dt, n)
end
di
end
Expand Down Expand Up @@ -662,7 +662,7 @@ The `field` is the symbol of the assigned variable.
Three definitions are included in the package to unpack a composite type
or a dictionary with Symbol or string keys:
```
@inline unpack(x, ::Val{f}) where {f} = getfield(x, f)
@inline unpack(x, ::Val{f}) where {f} = getproperty(x, f)
@inline unpack(x::AbstractDict{Symbol}, ::Val{k}) where {k} = x[k]
@inline unpack(x::AbstractDict{S}, ::Val{k}) where {S<:AbstractString,k} = x[string(k)]
```
Expand All @@ -672,7 +672,7 @@ More methods can be added to allow for specialized unpacking of other datatypes.
See also `pack!`.
"""
function unpack end
@inline unpack(x, ::Val{f}) where {f} = getfield(x, f)
@inline unpack(x, ::Val{f}) where {f} = getproperty(x, f)
@inline unpack(x::AbstractDict{Symbol}, ::Val{k}) where {k} = x[k]
@inline unpack(x::AbstractDict{<:AbstractString}, ::Val{k}) where {k} = x[string(k)]

Expand All @@ -689,7 +689,7 @@ Two definitions are included in the package to pack into a composite
type or into a dictionary with Symbol or string keys:

```
@inline pack!(x, ::Val{f}, val) where {f} = setfield!(x, f, val)
@inline pack!(x, ::Val{f}, val) where {f} = setproperty!(x, f, val)
@inline pack!(x::AbstractDict{Symbol}, ::Val{k}, val) where {k} = x[k]=val
@inline pack!(x::AbstractDict{S}, ::Val{k}, val) where {S<:AbstractString,k} = x[string(k)]=val
```
Expand All @@ -700,7 +700,7 @@ datatypes.
See also `unpack`.
"""
function pack! end
@inline pack!(x, ::Val{f}, val) where {f} = setfield!(x, f, val)
@inline pack!(x, ::Val{f}, val) where {f} = setproperty!(x, f, val)
@inline pack!(x::AbstractDict{Symbol}, ::Val{k}, val) where {k} = x[k]=val
@inline pack!(x::AbstractDict{<:AbstractString}, ::Val{k}, val) where {k} = x[string(k)]=val

Expand Down
21 changes: 21 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,27 @@ d = Dict("a"=>5.0,"b"=>2,"c"=>"Hi!")
@test a == 5.0 #true
@test c == "Hi!" #true

mutable struct PropertyExample
a
last_set_property
end
Base.getproperty(::PropertyExample, name::Symbol) = String(name)
Base.setproperty!(d::PropertyExample, name::Symbol, value) =
setfield!(d, :last_set_property, (name, value))
Base.propertynames(::PropertyExample) = (:A, :B, :C)

let d = PropertyExample(:should_be_ignored, nothing)
@unpack a, b = d
@test a == "a"
@test b == "b"

a = "a value"
@pack! d = a
@test getfield(d, :last_set_property) == (:a, "a value")

@test type2dict(d) == Dict(:A => "A", :B => "B", :C => "C")
end

# TODO add test with non String string

# Example with type:
Expand Down